Skip to main content
POST
/
v1
/
payment-sessions
/
agent
Create Agent Payment Session
curl --request POST \
  --url https://api.bkey.id/v1/payment-sessions/agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantDomain": "<string>",
  "amount": 2500000,
  "lineItems": [
    {
      "title": "<string>",
      "quantity": 2,
      "price": 1
    }
  ],
  "returnUrl": "<string>",
  "externalOrderId": "<string>",
  "currency": "USD",
  "notifyUrl": "<string>",
  "cancelUrl": "<string>",
  "customerEmail": "jsmith@example.com",
  "expiresInSecs": 1800
}
'
{
  "success": true,
  "paymentSession": {
    "id": "<string>",
    "status": "<string>",
    "approvalUrl": "<string>",
    "amount": 1,
    "currency": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "merchantName": "<string>",
    "lineItems": [
      {
        "title": "<string>",
        "quantity": 1,
        "price": 1
      }
    ],
    "merchantDomain": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "externalOrderId": "<string>",
    "sptId": "<string>",
    "paymentIntentId": "<string>",
    "returnUrl": "<string>",
    "cancelUrl": "<string>",
    "paymentResult": {}
  }
}

Authorizations

Authorization
string
header
required

EdDSA-signed JWT obtained via OAuth 2.1 client_credentials or CIBA

Body

application/json
merchantDomain
string
required
Minimum string length: 1
amount
integer
required
Required range: 1 <= x <= 5000000
lineItems
object[]
required
Minimum array length: 1
returnUrl
string<uri>
required
externalOrderId
string
currency
string
default:USD
Required string length: 3
notifyUrl
string<uri>
cancelUrl
string<uri>
customerEmail
string<email>
expiresInSecs
integer
default:1800
Required range: 60 <= x <= 7200

Response

Default Response

success
boolean
required
paymentSession
object
required