# Adyen Checkout API API

> Adyen Checkout API API on Apizie: 27 endpoints (Get an Apple Pay session, Cancel an authorised payment, Get the brands and other details of a card, Get a list of donation campaigns., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:adyen-checkout-service-v71`
- Category: Payments
- Status: byok
- Source: https://github.com/Adyen/adyen-openapi
- Page: https://zieapi.vercel.app/api/payments/adyen-checkout-service-v71
- OpenAPI: https://zieapi.vercel.app/api/payments/adyen-checkout-service-v71/openapi.json

Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment…

## Endpoints

### Get an Apple Pay session
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-apple-pay-sessions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Cancel an authorised payment
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-cancels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Get the brands and other details of a card
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-card-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Get a list of donation campaigns.
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-donation-campaigns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Make a donation
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-donations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Forward stored payment details
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-forward` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Create an order
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Cancel an order
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-orders-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Create a payment link
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-payment-links` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Get a payment link
`GET https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/get-payment-links-link-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| linkId | string | yes | Unique identifier of the payment link. |

### Update the status of a payment link
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/patch-payment-links-link-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| linkId | string | yes | Unique identifier of the payment link. |
| body | object | no | JSON request body |

### Get a list of available payment methods
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-payment-methods` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Get the balance of a gift card
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-payment-methods-balance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Start a transaction
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Submit details for a payment
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-payments-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Update an authorised amount
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-payments-payment-psp-reference-amount-updates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| paymentPspReference | string | yes | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment. |
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Cancel an authorised payment
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-payments-payment-psp-reference-cancels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| paymentPspReference | string | yes | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment that you… |
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Capture an authorised payment
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-payments-payment-psp-reference-captures` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| paymentPspReference | string | yes | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment that you… |
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Refund a captured payment
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-payments-payment-psp-reference-refunds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| paymentPspReference | string | yes | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment that you… |
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Refund or cancel a payment
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-payments-payment-psp-reference-reversals` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| paymentPspReference | string | yes | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment that you… |
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Updates the order for PayPal Express Checkout
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-paypal-update-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Create a payment session
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-sessions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Get the result of a payment session
`GET https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/get-sessions-session-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sessionId | string | yes | A unique identifier of the session. |
| sessionResult | string | yes | The `sessionResult` value from the Drop-in or Component. |

### Get tokens for stored payment details
`GET https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/get-stored-payment-methods` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shopperReference | string | no | Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must… |
| merchantAccount | string | no | Your merchant account. |

### Create a token to store payment details
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-stored-payment-methods` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
| body | object | no | JSON request body |

### Delete a token for stored payment details
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/delete-stored-payment-methods-stored-payment-method-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| storedPaymentMethodId | string | yes | The unique identifier of the token. |
| shopperReference | string | yes | Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must… |
| merchantAccount | string | yes | Your merchant account. |

### Validates shopper Id
`POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-validate-shopper-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-apple-pay-sessions" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Adyen Checkout API API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/payments:adyen-checkout-service-v71/post-apple-pay-sessions with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Adyen Checkout API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Adyen Checkout API itself also needs your own key from adyen.

### Can AI agents use the Adyen Checkout API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:adyen-checkout-service-v71.

### What is the status of the Adyen Checkout API API?
Needs your own provider key (bring your own key)
