Skip to main content
POST
/
v1
/
checkout
/
initiate
Initiate Checkout
curl --request POST \
  --url https://api.bkey.id/v1/checkout/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantName": "<string>",
  "merchantDomain": "<string>",
  "checkoutUrl": "<string>",
  "amount": 2,
  "lineItems": [
    {
      "title": "<string>",
      "quantity": 2,
      "price": 1
    }
  ],
  "currency": "USD",
  "expiresInSecs": 600
}
'
{
  "success": true,
  "checkoutRequest": {
    "id": "<string>",
    "status": "<string>",
    "challengeHex": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "sptId": "<string>",
    "paymentIntentId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

EdDSA-signed JWT obtained via OAuth 2.1 client_credentials or CIBA

Body

application/json
merchantName
string
required
Required string length: 1 - 256
merchantDomain
string
required
Required string length: 1 - 512
checkoutUrl
string<uri>
required
Maximum string length: 2048
amount
integer
required
Required range: x >= 1
lineItems
object[]
required
Required array length: 1 - 50 elements
currency
string
default:USD
Required string length: 3
expiresInSecs
integer
default:600
Required range: 60 <= x <= 3600

Response

Default Response

success
boolean
required
checkoutRequest
object
required