Sign in
Payments

Start Checkout Session

Start a checkout session for the Payment by its ID. This provides necessary details for initializing a checkout process on the client side.

get/payments/{id}/checkout-details

Path parameters

idstring required

Response

OK

paymentstring required

ID of the payment associated with this checkout session

amountnumber required

Amount in smallest currency unit

currency'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'pln' | 'czk' | 'sek' | 'dkk' required

Currency code in ISO 4217 format

countryCodestring required

Country code in ISO 3166-1 alpha-2 format

supportedPaymentMethodsstring[] required

List of supported payment method types for this checkout session

vgsJwtstring

Short-lived VGS access token for initializing VGS Collect. Only present when VGS is configured.

Example response

{
  "currency": "usd"
}

Changes

Changed in 1 of the 2 revisions of this API.1