Last Updated: 19 March 2024 | Change Log
The Payments API is for preview only and will be released soon.
Guest Checkout card Payment
Provide the card details in an API request or use our Checkout SDK for low PCI hosted card fields.
- API only
- Checkout SDK
Collect the card details and send an API request with these details to the payments
resource.
Request
- Plain card
- Recommended Key-values
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
A one-off card payment using a plain card number
{ "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "instruction": { "method": "card", "paymentInstrument": { "type": "plain", "cardNumber": "4000000000001091", "expiryDate": { "month": 5, "year": 2035 } }, "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
The response differs based on the features you have enabled:
If 3DS is enabled you will receive a response to perform device data collection and additionally, if prompted by the card issuer, a challenge response.
If FraudSight is enabled, you can recieve a
fraudHighRisk
response, stopping the transaction.If auto settlement is set to
true
, the successful outcome will besentForSettlement
. If set tofalse
. it will beauthorized
.
The payment response will contain additional details:
- riskFactors (avs/cvc) - if providing billing address & cvc, check these details against the customer's issuing bank
- refusal code and description which gives additional context on the refusal
- refusal advice code (only if returned by the card scheme and acquirer)
- 3DS authentication details - details on 3DS authentication outcome (e.g. challenged)
- fraud assessment details - details on the fraud assessment outcome (e.g. lowRisk, review)
- token creation - details of the card tokenized and the
token href
itself