Skip to main content

Introduction

The Orchestrapay Payment API that allows you to embed third-party payment gateways in your own checkout on a white-label & transparent basis. This API assumes that you have your own checkout.

Unified Approach​

Orchestrapay Unified Approach

The Payment API gives you a single API that you can integrate to access all current and future integrations of Orchestrapay. It fully abstracts both the front end and the back end and offers a product that's gateway-agnostic to you.

Customer Journey​

Embedded UI

  1. You create a gateway-agnostic Checkout Intent, all you need is an amount and a currency.
  2. You fetch a list of Gateways available.
  3. When a user selects an Orchestrapay managed gateway, you create a Payment Intent.
  4. Any gateway-specific workflows takes place in our Embedded UI.
  5. Your user is redirected to your payment success/failure page.

In the background, we send you a Webhook to all your Checkout Intent's webhook URLs, so you can authenticate the success/failure and store any error.

Payments & Refunds Lifecycle​

Embedded UI

Payment & Refund objects can have only 3 statuses: pending, success & canceled and only the pending status is muttable, i.e. once an object gets the success or canceled status it is guaranteed that it will not change again.

Because of the complexity of payments, objects also have a sub-status which are part of the Full Payment Lifecycle. Sub-statuses are always joined with their parent status with an underscore character.

You will receive webhook notifications every time the sub-status changes.

For your first implementation, we advise you to focus on statuses only and to use sub-statuses for data analytics or specific gateway-specific operations / reconciliations once you have live transactions going through.

Failure Management​

Embedded UI

Because customers can interact with our Embedded UI throughout multiple attempts on the same Payment Intent, it is quite common to have many transaction's status set to canceled_timeout_e2e, while the actual underlying failure reason may differ.

However you might want to record the failure reason to provide more granular analytics, especially if you have a tiered commercial relationship with the gateways: this is why we record & return the Last Error that occured for this Payment Intent.

Dashboard​

Dashboard

You can login on orchestrapay.com to access a read-only dashboard of all your transactions & refunds.

Daily Reports​

Reports

Every morning at 3am we can send you, your team and your merchants daily reports with volumes, accurate conversion rates and funnel drop position.