Proceed with payment via checkout session

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

checkoutSessionId

string

required

paymentInitiatorId

uuid

required

The ID of the payment initiator

amount

integer

required

The payment amount in the smallest currency unit (e.g., pence for GBP)

currency

const

enum

required

The currency code

Allowed:

GBP

successUrl

uri

required

URL to redirect the user after successful payment

failureUrl

uri

required

URL to redirect the user after failed payment

cancelUrl

uri

required

URL to redirect the user after cancelled payment

externalReference

string | null

External reference for the payment

metadata

object

Custom metadata for the payment (max 10 key-value pairs, keys 1-30 chars, values 1-200 chars)

shippingAddress

object

Address with all fields optional

billingAddress

object

Address with all fields optional

lineItems

array of objects | null

Array of line items, each being either airline, car rental, lodging, or product data

accept

string

enum

Defaults to application/json

Generated from available response content types

Responses


Example

curl --request POST \
     --url https://api.superpayments.com/2026-04-01/checkout-sessions/checkoutSessionId/proceed \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "shippingAddress": {
    "addressLine1": null,
    "addressLine2": null,
    "addressLine3": null,
    "city": null,
    "country": null,
    "postCode": null,
    "firstName": null,
    "lastName": null,
    "phone": null,
    "email": null
  },
  "billingAddress": {
    "addressLine1": null,
    "addressLine2": null,
    "addressLine3": null,
    "city": null,
    "country": null,
    "postCode": null,
    "firstName": null,
    "lastName": null,
    "phone": null,
    "email": null
  }
}'