The Adyen Checkout API lets merchants programmatically create and authorize online payments across cards, mobile wallets, and local payment methods, and provides supporting operations such as Apple Pay session retrieval, card‑brand detection, payment cancellations, and donation processing.
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/cancels
Cancel an authorised payment
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/cardDetails
Get the list of brands on the card
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/donations
Start a transaction for donations
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/orders
Create an order
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/orders/cancel
Cancel an order
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/originKeys
Create originKey values for domains
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/paymentLinks
Create a payment link
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
GET
/paymentLinks/{linkId}
Get a payment link
linkId(path, required) — Unique identifier of the payment link.
PATCH
/paymentLinks/{linkId}
Update the status of a payment link
linkId(path, required) — Unique identifier of the payment link.
POST
/paymentMethods
Get a list of available payment methods
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/paymentMethods/balance
Get the balance of a gift card
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/paymentSession
Create a payment session
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/payments
Start a transaction
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/payments/details
Submit details for a payment
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/payments/result
Verify a payment result
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/payments/{paymentPspReference}/amountUpdates
Update an authorised amount
paymentPspReference(path, required) — The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment.
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/payments/{paymentPspReference}/cancels
Cancel an authorised payment
paymentPspReference(path, required) — The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel.
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/payments/{paymentPspReference}/captures
Capture an authorised payment
paymentPspReference(path, required) — The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture.
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/payments/{paymentPspReference}/refunds
Refund a captured payment
paymentPspReference(path, required) — The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund.
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/payments/{paymentPspReference}/reversals
Refund or cancel a payment
paymentPspReference(path, required) — The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse.
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
POST
/sessions
Create a payment session
Idempotency-Key(header) — A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
GET
/storedPaymentMethods
Get tokens for stored payment details
shopperReference(query) — Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
merchantAccount(query) — Your merchant account.
DELETE
/storedPaymentMethods/{recurringId}
Delete a token for stored payment details
recurringId(path, required) — The unique identifier of the token.
shopperReference(query, required) — Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
merchantAccount(query, required) — Your merchant account.
24 endpoints auto-detected
Authentication
This API uses an API key, passed in the "X-API-Key" header. No OAuth required.
curl -X POST \
"https://checkout-test.adyen.com/v70/applePay/sessions" \
-H "X-API-Key: YOUR_API_KEY"
