You're viewing our new Unified Payments API documentation. Click here to access our Classic API docs.


We take the utmost care in ensuring that changes to our APIs do not break your integrations. We consider the following changes to be backward-compatible:

  • Adding new API resources/endpoints.
  • Adding new, optional request fields/parameters to existing APIs.
  • Adding new fields to existing API responses.
  • Adding new, optional HTTP request headers.
  • Adding new HTTP response headers.
  • Increasing the length of existing string field values.
  • Changing the format of identifiers including changing or removing prefixes.
  • Adding new webhook event types (you will need to explicitly opt into these).

Note that the above also applies to changes in our webhook event schemas.

In the event that a breaking change is completely unavoidable (e.g., for compliance reasons), we will contact you in advance to ensure that you have sufficient time to update your integration.


January 10, 2019

The payment_approved, payment_declined, card_verifed, and card_verification_declined webhook notifications now include an approved flag. This allows you to easily know if the authorization or capture was a success without having to use the status or response code.

January 9, 2019

An approved flag has been added to the payment retrieval response, bringing it in line with the payment creation response. Primarily used in the redirection flows (3-D Secure and APMs), this allows you to easily know if the authorization or capture was a success without having to use the status or response code.

November 14, 2018

  • Our payments endpoint is now idempotent, allowing you to safely retry payments without a duplicate payment taking place. Find out more.
  • We now provide you with the scheme transaction ID (scheme_id) in the response when creating a payment.

October 24, 2018

Support for payments using pre-decrypted Apple Pay tokens has been added to the payments endpoint.

October 18, 2018

  • Support for network token payments has been added to the payments endpoint.
  • Support for 3-D Secure payments where the cardholder is authenticated using a third-party MPI has been added to the payments endpoint.
  • The ECI value that the payment was authorized with is now provided in the response to 3-D Secure and Visa token payments.

October 11, 2018

We now provide the payment_account_reference for digital wallet and Visa token payments. This is a reference to the underlying card and allows you to know if two tokens reference the same underlying card.

August 14, 2018

We’ve updated the Events API so you can search using payment_id and reference. This will allow you to easily find events related to a particular payment. Find out more.

June 26, 2018

previousChargeId now supports Visa’s scheme transaction ID. Find out more.

April 2, 2018

To support the new requirements from Visa and Mastercard for payments using stored card details, a new cardOnFile and a new previousChargeId field must be included in charge requests where applicable. Find out more.

March 21, 2018

Financial institutions now need to provide the recipientDetails in their charge requests when processing any domestic UK transactions. Find out more.

February 2, 2018

We have introduced new chargeback and retrieval webhooks to help keep you up to date on your payments. You can subscribe to them by updating your configuration through our API or via the Hub.

Can we help?

Thanks for using If you need any help or support, then message our support team at


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.