Payments root resource, returns links to available payments actions.
Payments root resource, returns links to available payments actions.
An object that contains all information related to the payment.
An object that contains information about the value of the payment.
The text that appears on your customer's statement. Used to identify the merchant.
An identifier for the paymentInstrument
being used.
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.
A unique reference generated by you that is used to identify a payment throughout its lifecycle.
The payment channel indicates the interaction of the cardholder with the merchant. Supply a value of moto to process an authorization as a Mail Order or Telephone Order (MOTO) transaction. If channel is not provided, the authorization will be processed as ecommerce by default
An object that contains riskProfile and authentication of the customer.
Used to apply the SCA exemption in the payment request and update the FraudSight data model to benefit future payments.
An object containing 3DS or Network Token authnentication of the customer
Required, if authentication.eci value is 01, 02, 05 or 06. A cryptographic value that provides evidence of the outcome of a 3DS verification..
Payment authorization for GBP 2.50
{ "transactionReference": "transaction-ref", "merchant": { "entity": "an-entity" }, "instruction": { "narrative": { "line1": "trading name" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/plain", "cardNumber": "4444333322221111", "cardExpiryDate": { "month": 12, "year": 2024 } } } }
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", "_links": { "payments:cancel": { "href": "/payments/authorizations/cancellations/linkData" }, "payments:settle": { "href": "/payments/settlements/linkData" }, "payments:partialSettle": { "href": "/payments/settlements/partials/linkData" }, "payments:events": { "href": "/payments/events/linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } }