Payments root resource, returns links to available payments actions.
Download OpenAPI specification:Download
Payments root resource, returns links to available payments actions.
testing (try)
live
To take a payment, you must first create an authorization request. Your response contains links to your next available actions.
Use our card on file authorize resource when your customer is initiating a payment using stored card details verifying their account first
An example of a payment authorization for GBP 2.50 with a successful outcome
{ "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 }, "cardHolderName": "John Appleseed" } } }
201
The payment authorization has been successfully created
An example of a 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" }, "payments:cardOnFileAuthorize": { "href": "/payments/cardOnFile/linkData" }, "payments:recurringAuthorize": { "href": "/payments/recurring/linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } }
Use our card on file authorize resource when your customer is initiating a payment using stored card details (without verifying their account first)
An example of a payment authorization for GBP 2.50 with a successful outcome
{ "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 }, "cardHolderName": "John Appleseed" } } }
201
The authorization for migrated Card On File has been successfully created
An example of a 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" }, "payments:cardOnFileAuthorize": { "href": "/payments/cardOnFile/linkData" }, "payments:recurringAuthorize": { "href": "/payments/recurring/linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } }
Use our card on file sale resource when your customer is initiating a payment using stored card details, and you want to instantly trigger the settlement process
An example of a sale for GBP 2.50 with a successful outcome
{ "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 }, "cardHolderName": "John Appleseed" } } }
201
The sale for migrated Card On File has been successfully created
An example of a sale for GBP 2.50 with a successful outcome
{ "outcome": "Sent For Settlement", "_links": { "payments:refund": { "href": "/payments/settlements/refunds/:linkData" }, "payments:partialRefund": { "href": "/payments/settlements/refunds/partials/:linkData" }, "payments:reversal": { "href": "/payments/sales/reversals/linkData" }, "payments:events": { "href": "/payments/events/linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } }
Use our migrate recurring authorize resource when you are initiating a payment using your customer's stored card details, without verifying their account first
Request to partially settle the authorization
{ "value": { "amount": 500, "currency": "EUR" }, "reference": "partial-settle-reference" }
202
The partial settlement has been accepted
Request to partially settle the authorization
{ "_links": { "payments:refund": { "href": "/payments/settlements/refunds/full/:linkData" }, "payments:partialRefund": { "href": "/payments/settlements/refunds/partials/:linkData" }, "payments:partialSettle": { "href": "/payments/settlements/partials/:linkData" }, "payments:cancel": { "href": "/payments/authorizations/cancellations/:linkData" }, "payments:events": { "href": "/payments/events/:linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } }
Use our recurring authorize resources when you are initiating a payment using your customer's stored card details, verifying your customer's account first.
An example of a recurring payment authorization for GBP 2.50 with a successful outcome
{ "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 }, "cardHolderName": "John Appleseed" } } }
201
The recurring payment authorization has been successfully created
An example of a recurring 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 } ] } }
Use our recurring sale resource to authorize and settle merchant initiated transactions where you have stored the card details. You must verify your customer's account before submitting your first recurring payment for authorization.
An example of a payment sale with all optional fields
{ "transactionReference": "transaction-ref", "merchant": { "entity": "an-entity", "mcc": "1234", "paymentFacilitator": { "pfId": "12345", "isoId": "12345", "subMerchant": { "name": "Merchant Plc", "merchantId": "12345", "postalCode": "SW1 1AA", "street": "Regent Street", "city": "London", "countryCode": "123", "taxId": "12345", "state": "St8" } } }, "instruction": { "debtRepayment": true, "narrative": { "line1": "trading name", "line2": "order number" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/plain", "cardNumber": "4444333322221111", "cardExpiryDate": { "month": 12, "year": 2024 }, "cardHolderName": "John Appleseed", "billingAddress": { "address1": "address line 1", "address2": "address line 2", "address3": "address line 3", "city": "city", "state": "state", "postalCode": "12345", "countryCode": "IT" } } } }
201
The recurring payment has been successfully created
An example of a payment sale with all optional fields
{ "outcome": "authorized", "issuer": { "authorizationCode": "012345" }, "riskFactors": [ { "type": "cvc", "risk": "not_matched" }, { "type": "avs", "detail": "postcode", "risk": "not_checked" } ], "_links": { "payments:refund": { "href": "/payments/settlements/refunds/:linkData" }, "payments:partialRefund": { "href": "/payments/settlements/refunds/partials/:linkData" }, "payments:reversal": { "href": "/payments/sales/reversals/linkData" }, "payments:events": { "href": "/payments/events/linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } }
If you don’t want to proceed with a payment, you can send a cancel request Note: You can only cancel a payment which is authorized. If the payment is settled, you must create a refund.
202
The cancellation request has been accepted
To receive all the funds from the customer, send us a settle request.
202
The payment settlement has been accepted
Request to fully settle the authorization
{ "_links": { "payments:refund": { "href": "/payments/settlements/refunds/full/:linkData" }, "payments:partialRefund": { "href": "/payments/settlements/refunds/partials/:linkData" }, "payments:events": { "href": "/payments/events/:linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } }
Send a refund request to return the full settled amount to your customer. Note: No request body is needed for this request.
202
The refund request has been accepted
Send a partial refund request to return a portion of the settled amount to your customer. Send the amount to refund and the authorization currency in the body.
Request to perform a partial refund of the settlement
{ "value": { "amount": 10, "currency": "EUR" }, "reference": "partial-refund-reference" }
202
The partial refund has been accepted
To receive a portion of the funds of a payment, send us a partial settle request.
Request to partially settle the authorization
{ "value": { "amount": 500, "currency": "EUR" }, "reference": "partial-settle-reference" }
202
The partial settlement has been accepted
Request to partially settle the authorization
{ "_links": { "payments:refund": { "href": "/payments/settlements/refunds/full/:linkData" }, "payments:partialRefund": { "href": "/payments/settlements/refunds/partials/:linkData" }, "payments:partialSettle": { "href": "/payments/settlements/partials/:linkData" }, "payments:cancel": { "href": "/payments/authorizations/cancellations/:linkData" }, "payments:events": { "href": "/payments/events/:linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } }
Your reversal request is processed as a cancel or refund request. This depends on the time passed after your sale request was submitted. For US entities the payment is refunded after one day after a successful sale request. Any other payment moves to refunded after 15 minutes. Note: No request body is needed for this request.
202
The reversal request has been accepted
Create a recurring mandate using a scheme transaction ID
An example of a request to create a recurring mandate from a scheme transaction ID
{ "schemeTransactionId": "123456789" }
201
Recurring mandate created
Send a request to find out the current status of your payment after it has been authorized.
Send a request to find out the current status of your payment after it has been authorized using the events action link. Note: It can take up to 15 minutes for a payment event to update.
An example of querying a payment event with a transaction reference REF123
{ "lastEvent": "Authorized", "_links": { "payments:cancel": "/payments/authorizations/cancellations/:linkData", "payments:settle": "/payments/settlements/full/:linkData", "payments:partialSettle": "/payments/settlements/partials/:linkData", "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } }
Send a request to find out the current status of your payment after it has been authorized using the events action link. This action is only to be used for recovery purposes. Use this action if your authorization requests timed out. The response determines if your authorization request was successful and your next available actions are returned.
An example of querying a payment event with a transaction reference REF123
{ "lastEvent": "Authorized", "_links": { "payments:cancel": "/payments/authorizations/cancellations/:linkData", "payments:settle": "/payments/settlements/full/:linkData", "payments:partialSettle": "/payments/settlements/partials/:linkData", "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } }