Last Updated: 19 March 2024 | Change Log

The Payments API is for preview only and will be released soon.

Apple Pay

Make a Apple Pay payment by providing the encrypted payload (wallet token) in the payments request.

Request

  1. Wallet Token
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default"
    },
    "instruction": {
        "method": "applepay",
        "paymentInstrument": {
            "type": "encrypted",
            "walletToken": "{\"version\": \"EC_v1\",\"data\": \"kdHd..GQ==\",\"signature\": \"MIAGCSqGSIb3DQEH...AAA\",\"header\": {\"transactionId\": \"d3b28af..f8\",\"ephemeralPublicKey\": \"MFkwE..Q==\",\"publicKeyHash\": \"dxCK..6o=\"}}"
        },
        "narrative": {
            "line1": "trading name"
        },
        "value": {
            "currency": "GBP",
            "amount": 42
        }
    }
}

Enable additional features

Fraud assessmentPrevent fraudulent transactions.
Not Available
3DS authenticationShift Liability to the issuer / for EEA countries this is required as part of SCA compliance.
Not Available
Auto SettlementRequest that payment authorizations are automatically sent for settlement (sometimes referred to as "capture").
Set instruction.settlement.auto to true in the payments request.

Response

For responses see the API reference.