Last Updated: 19 March 2024 | Change Log
The Payments API is for preview only and will be released soon.
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
- API only
- Checkout SDK
Request
- Token
- Plain card
- 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 assessment | Prevent fraudulent transactions. | |
3DS authentication | Shift Liability to the issuer / for EEA countries this is required as part of SCA compliance. | |
SCA Exemptions | Meet SCA compliance without the added friction of 3DS. | Coming Soon |
Auto Settlement | Request 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.