Skip to content

Pay with a pre-decrypted Apple Pay token

Last updated: 14th July 2022

We also support the ability to make payments using Apple Pay tokens that you have decrypted. To make use of this feature, use the network_token source type and specify the token_type as applepay. This source type allows you to provide the details about the token, as well as the cryptogram and ECI value obtained from the Apple Pay token.

Use the details below to set up your request. To get a detailed view of all required and optional fields, see our API reference.

Endpoints

    post

    https://api.checkout.com/payments

    Request example

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    {
    "source": {
    "type": "network_token",
    "token": "4242424242424242",
    "token_type": "applepay",
    "expiry_month": "10",
    "expiry_year": "2025",
    "eci": "06",
    "cryptogram": "AgAAAAAAAIR8CQrXcIhbQAAAAAA"
    },
    "amount": 1000,
    "currency": "USD"
    }

    Response example

    If the approved field is true, your authorization was successful. If your authorization was not successful, it's possible the payment used an invalid/expired card, or a valid card with an insufficient available balance.

    A successful response will include a payment_account_reference value, which is a unique reference to the underlying card for network tokens. If the card scheme provided us with an eci value, it will be included in the response. The value indicates the security level that the card scheme decided to request the payment with.