Card Payments root resource, returns links to available payments actions.
Card Payments root resource, returns links to available payments actions.
A unique reference generated by you that is used to identify a payment throughout its lifecycle.
An object that contains information about the merchant.
Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for authentication and queries.
You can apply a merchant category code mcc
to an individual request. You can only provide an mcc
if we have enabled the dynamic mcc feature during boarding. If enabled but not provided, merchant.mcc
defaults to a configured value.
An object that contains all information related to the payment.
Indicates whether the transaction should be sent for settlement now true
or later false
at a time of your choosing.
The text that appears on your customer's statement. Used to identify the merchant.
Consumer Bill Payment is a flag which identifies a bill payment paid by providers on behalf of consumers.
Allows you to request a real-time account update (Visa cards only) when using a previously stored card. You can only use this on subsequest card requests.
Debt Repayment Indicator is a flag which identifies a payment with the purpose of repaying a debt.
Contains details of the funds transfer request, which is a money movement for a reason other than the purchase of goods or services (also known as Account Funding Transaction (AFT)).
Additional transaction recipient data.
An object containing details about the order.
Recurring authorization for subscriptions
{ "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "MindPalace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/plain", "cardNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } }, "customerAgreement": { "type": "subscription", "schemeReference": "MCCOLXT1C0104" } } }
The payment authorization has been successfully created
An exemption result and reason if a risk profile was included in your authorization request.
Details of the paymentInstrument used.
Any risk factors which have been identified for the authorization. This section will not appear if no risks are identified.
Payment authorization for GBP 2.50 with a successful outcome
{ "outcome": "authorized", "riskFactors": [ { "type": "cvc", "risk": "notSupplied" }, { "type": "avs", "risk": "notChecked", "detail": "address" }, { "type": "avs", "risk": "notChecked", "detail": "postcode" } ], "issuer": { "authorizationCode": "675725" }, "scheme": { "reference": "000000000000020005060720116005062" }, "paymentInstrument": { "type": "card/plain+masked", "cardBin": "555555", "lastFour": "4444", "category": "consumer", "countryCode": "GB", "expiryDate": { "month": 9, "year": 2029 }, "cardBrand": "mastercard", "fundingType": "credit", "issuerName": "AN ISSUING BANK LTD", "paymentAccountReference": "Q1HJZ28RKA1EBL470G9XYG90R5D3E" }, "_links": { "cardPayments:cancel": { "href": "https://try.access.worldpay.com/payments/authorizations/cancellations/" }, "cardPayments:settle": { "href": "https://try.access.worldpay.com/payments/settlements/full/" }, "cardPayments:partialSettle": { "href": "https://try.access.worldpay.com/payments/settlements/partials/" }, "cardPayments:events": { "href": "https://try.access.worldpay.com/payments/events/" }, "curies": [ { "name": "cardPayments", "href": "https://try.access.worldpay.com/rels/cardPayments/{rel}", "templated": true } ] } }
No request payload
Request to fully settle the authorization
{ "_links": { "cardPayments:refund": { "href": "/payments/settlements/refunds/full/:linkData" }, "cardPayments:partialRefund": { "href": "/payments/settlements/refunds/partials/:linkData" }, "cardPayments:events": { "href": "/payments/events/:linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } }