Last Updated: 19 March 2024 | Change Log

Coming Soon - The Payments API is for preview only and subject to change.

Use a stored card

Use a previously stored card to send a payments request. This is for customer initiated transactions (CIT).

Additionally, to collect the CVC value, use the Checkout SDK to create a cvc session and maintain a low PCI burden.

Main objects for this scenario:

  • customerAgreement - used to indicate the customer has agreed to you storing their card
  1. API only
  2. Checkout SDK

Request

  1. Token
  2. Plain card
  3. Recommended Key-values
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default"
    },
    "instruction": {
        "customerAgreement": {
            "type": "cardOnFile",
            "storedCardUsage":"subsequent"
        },
        "method": "card",
        "paymentInstrument": {
            "type": "token",
            "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNC...",
            "cvc": "123"
        },
        "narrative": {
            "line1": "trading name"
        },
        "value": {
            "currency": "GBP",
            "amount": 42
        }
    }
}

Enable additional features

Fraud assessmentPrevent fraudulent transactions.
3DS authenticationShift Liability to the issuer / for EEA countries this is required as part of SCA compliance.
SCA ExemptionsMeet SCA compliance without the added friction of 3DS.
Coming Soon
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.