AI resources

How to migrate from the Payments API to the Orders API

The Orders API unifies online payment processing for Checkout API, offering standardized endpoints, a transaction-level consolidated status model, and new native features that were not available in the Payments API. These include multiple transactions per order, manual or automatic processing, a dedicated capture endpoint, natively integrated 3DS 2.0 authentication, and a consolidated list of validation errors.

Migration involves updating request endpoints and fields, consolidating the status and notification model, and taking advantage of new native features. Migration does not involve changes to the business flow experienced by the buyer: the customer continues to complete the checkout within the seller's website, without redirects.

See below how to complete this migration, endpoint by endpoint and field by field, including the specific characteristics of each payment method.

Before implementing, classify each active Payments API flow into one of these situations:

  • It has a direct equivalent: when it is a mandatory feature with a direct equivalent between the APIs, migrate your flow by following the required steps in this guide.
  • It requires a technical adaptation: when it is an optional feature already part of your current integration, also implement the Based on your flow steps.
  • It has no documented equivalent: keep the flow in the Payments API until the Orders API supports it.