Apple Pay for Payment Setup API

Last updated: May 6, 2026

To accept Apple Pay payments, you must:

Create a payment setup.
Update the payment setup with the Apple Pay token.
Confirm the payment.

Call the Create a payment setup endpoint.

Information

The Payment Setup API supports idempotency. You can safely retry API requests without the risk of duplicate requests.

Information

Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see API endpoints.

post

https://{prefix}.api.checkout.com/payments/setups


1{
2  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
3  "currency": "GBP",
4  "amount": 2000,
5  "reference": "ORDER_01234",
6  "description": "Apple Pay payment",
7  "payment_type": "Regular",
8  "settings": {
9    "success_url": "https://example.com/payments/success",
10    "failure_url": "https://example.com/payments/failure"
11  }
12}

In the request body, provide the following:

processing_channel_id – The processing channel's unique identifier
amount – The payment amount
currency – The payment currency


1{
2  "id": "set_rcmepwrchqab2wsergcafvijfy",
3  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
4  "amount": 2000,
5  "currency": "GBP",
6  "payment_type": "Regular",
7  "reference": "ORDER_01234",
8  "description": "Apple Pay payment",
9  "payment_methods": {
10    "applepay": {
11      "status": "available",
12      "flags": [
13        "token_or_token_data_required"
14      ]
15    }
16  },
17  "available_payment_methods": [
18    "applepay"
19  ],
20  "settings": {
21    "success_url": "https://example.com/payments/success",
22    "failure_url": "https://example.com/payments/failure"
23  }
24}

The response returns a payment_methods object, which contains the payment methods enabled on your account.

For Apple Pay, payment_methods contains the following fields:

status – The status of the payment method.
flags – An array of error codes or indicators that highlight missing or invalid information.

When the customer selects Apple Pay as the payment method on the checkout page, Apple generates a payment token.

When the customer selects Apple Pay as the payment method, Apple generates a payment token. To process a payment using the Apple payment token, you can:

Convert it to a Checkout.com card token
Decrypt it and use the token data

Call the Update a payment setup endpoint to submit the token. Provide the following fields, depending on the token you use:

Field	Description
`amount` number	The payment amount, in the minor currency unit. Minimum: 1 Required
`currency` string	Three-letter ISO 4217 currency code. Required
`processing_channel_id` string	The processing channel's unique identifier. Pattern: `^(pc)_(\w{26})$` Required
`settings.failure_url` string	The URL to redirect the customer after a failed authorization. Format: uri Required
`settings.success_url` string	The URL to redirect the customer after a successful authorization. Format: uri Required
`payment_methods.applepay.token` object	The Checkout.com Apple Pay token. Required
`payment_methods.applepay.expires_on` string	The date and time at which the token expires. Format: date-time
`payment_methods.applepay.account_holder` object	The Apple Pay account holder details.
`payment_methods.applepay.account_holder.first_name` string	The account holder's first name.
`payment_methods.applepay.account_holder.last_name` string	The account holder's last name.
`payment_methods.applepay.account_holder.middle_name` string	The account holder's middle name.
`payment_methods.applepay.account_holder.type` string	Supported values: `individual` `corporate` `government`
`payment_methods.applepay.account_holder.account_name_inquiry` boolean	Indicates whether to perform an account name inquiry with the card scheme (Visa or Mastercard).
`payment_methods.applepay.phone` object	The customer's phone number details.
`payment_methods.applepay.phone.country_code` string	The international dialing code for the customer's phone number.
`payment_methods.applepay.phone.number` string	The customer's phone number.
`payment_methods.applepay.store_for_future_use` boolean	Set to `true` if you intend to reuse the payment credentials in subsequent payments. If set to `false`, a payment instrument will not be included in the payment response.


1{
2  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
3  "currency": "GBP",
4  "amount": 2000,
5  "reference": "ORDER_01234",
6  "description": "Apple Pay payment",
7  "payment_type": "Regular",
8  "settings": {
9    "success_url": "https://example.com/payments/success",
10    "failure_url": "https://example.com/payments/failure"
11  },
12  "payment_methods": {
13    "applepay": {
14      "token": "tok_hilxnnylkxtutoswkxx2425lzi",
15      "expires_on": "2026-09-15T16:12:05Z"
16    }
17  }
18}


1{
2  "id": "set_rcmepwrchqab2wsergcafvijfy",
3  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
4  "amount": 2000,
5  "currency": "GBP",
6  "payment_type": "Regular",
7  "reference": "ORDER_01234",
8  "description": "Apple Pay payment",
9  "payment_methods": {
10    "applepay": {
11      "status": "ready",
12      "token": "tok_hilxnnylkxtutoswkxx2425lzi",
13      "expires_on": "2026-09-15T16:12:05Z",
14      "flags": []
15    }
16  },
17  "available_payment_methods": [
18    "applepay"
19  ],
20  "settings": {
21    "success_url": "https://example.com/payments/success",
22    "failure_url": "https://example.com/payments/failure"
23  }
24}

The response returns a ready status when the token has been successfully validated. The payment is ready to confirm.

Field	Description
`amount` number	The payment amount, in the minor currency unit. Minimum: 1 Required
`currency` string	Three-letter ISO 4217 currency code. Required
`processing_channel_id` string	The processing channel's unique identifier. Pattern: `^(pc)_(\w{26})$` Required
`settings.failure_url` string	The URL to redirect the customer after a failed authorization. Format: uri Required
`settings.success_url` string	The URL to redirect the customer after a successful authorization. Format: uri Required
`payment_methods.applepay.token_data` object	The Apple Pay payment token data object, returned by the Apple Pay API. Required
`payment_methods.applepay.token_data.version` string	The version of the payment token. The token uses `EC_v1` for ECC-encrypted data, and `RSA_v1` for RSA-encrypted data. Required
`payment_methods.applepay.token_data.data` string	The encrypted payment data, Base64-encoded. Required
`payment_methods.applepay.token_data.signature` string	The signature of the payment and header data. The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm. Required
`payment_methods.applepay.token_data.header` object	Additional version-dependent information used to decrypt and verify the payment. Required
`payment_methods.applepay.token_data.header.ephemeral_public_key` string	The ephemeral public key.
`payment_methods.applepay.token_data.header.public_key_hash` string	The public key hash.
`payment_methods.applepay.token_data.header.transaction_id` string	The transaction ID.
`payment_methods.applepay.account_holder` object	The Apple Pay account holder details.
`payment_methods.applepay.account_holder.first_name` string	The account holder's first name.
`payment_methods.applepay.account_holder.last_name` string	The account holder's last name.
`payment_methods.applepay.account_holder.middle_name` string	The account holder's middle name.
`payment_methods.applepay.account_holder.type` string	Supported values: `individual` `corporate` `government`
`payment_methods.applepay.account_holder.account_name_inquiry` boolean	Indicates whether to perform an account name inquiry with the card scheme (Visa or Mastercard).
`payment_methods.applepay.phone` object	The customer's phone number details.
`payment_methods.applepay.phone.country_code` string	The international dialing code for the customer's phone number.
`payment_methods.applepay.phone.number` string	The customer's phone number.
`payment_methods.applepay.store_for_future_use` boolean	Set to `true` if you intend to reuse the payment credentials in subsequent payments. If set to `false`, a payment instrument will not be included in the payment response.


1{
2  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
3  "currency": "GBP",
4  "amount": 2000,
5  "reference": "ORDER_01234",
6  "description": "Apple Pay payment",
7  "payment_type": "Regular",
8  "settings": {
9    "success_url": "https://example.com/payments/success",
10    "failure_url": "https://example.com/payments/failure"
11  },
12  "payment_methods": {
13    "applepay": {
14      "token_data": {
15        "version": "EC_v1",
16        "data": "jMvlopbdmvRYOCSOdzmvvYrBmco8CLAVZHOFgKeVEtFdHHIm...",
17        "signature": "MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgA...",
18        "header": {
19          "ephemeral_public_key": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEMr6/nWeR6i1m...",
20          "public_key_hash": "fs98t0RqW8mMsSb7jdz6q7lg+0a1sKvXFTlckNN/DVc=",
21          "transaction_id": "a86b32a8009c49c4235c6b2beda29c885298588802fa81b83c8764a0d68a9eb9"
22        }
23      }
24    }
25  }
26}


1{
2  "id": "set_rcmepwrchqab2wsergcafvijfy",
3  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
4  "amount": 2000,
5  "currency": "GBP",
6  "payment_type": "Regular",
7  "reference": "ORDER_01234",
8  "description": "Apple Pay payment",
9  "payment_methods": {
10    "applepay": {
11      "status": "ready",
12      "token": "tok_hilxnnylkxtutoswkxx2425lzi",
13      "expires_on": "2026-09-15T16:12:05Z",
14      "flags": []
15    }
16  },
17  "available_payment_methods": [
18    "applepay"
19  ],
20  "settings": {
21    "success_url": "https://example.com/payments/success",
22    "failure_url": "https://example.com/payments/failure"
23  }
24}

The response returns a ready status when the token data is successfully validated and the payment is ready to confirm.

Information

The API returns payment_methods.applepay.status: unavailable for all non-validation technical failures occurring during the tokenization process.

When the payment status changes to ready, confirm the payment by calling the Confirm a payment setup endpoint and provide:

The payment setup id as the {id} path parameter.
applepay as the payment method name.

post

https://{prefix}.api.checkout.com/payments/setups/{id}/confirm/applepay

Apple Pay for Payment Setup API

Create a payment setup

Information

Information

Request example

Response example

Update the payment setup

Request example

Response example

Request example

Response example

Information

Confirm the payment