Sign in
Checkout

Initialize the Checkout iFrame

Generates the configuration needed for the checkout iframe

post/checkout/init

Request body

paymentstring required

The payment used for the checkout process. Must be an open payment.

Example request

{
  "payment": "pay_2QUtVTDMuiW05FVr0wOgEpYHUeX"
}

Response

OK

timestampstring required

Configuration timestamp in ISO 8601 format

tokenExIDstring required

Token exchange identifier for secure iframe initialization

tokenSchemestring required

Authentication scheme used for iframe token communication

authenticationKeystring required

HMAC authentication key for verifying iframe requests

pciboolean required

Whether PCI-compliant tokenization mode is enabled

Example response

{
  "supportedPaymentMethods": {
    "card": true
  },
  "timestamp": "2024-01-15T12:00:00.000Z",
  "tokenExID": "5fae838b-c767-4b84-b36c-ee8a6eb8a37b",
  "tokenScheme": "PCI",
  "authenticationKey": "a1b2c3d4e5f6a1b2c3d4e5f6",
  "pci": true
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.