This page will help you get started with the integration and will describe all our features and functionalities.
Orkestra helps businesses orchestrate payments at a global scale with flexibility and intelligence.
With a single unified API, you can receive, refund, and send payments locally.
Our platform provides intelligent routing and an automated retry engine to optimize approval rates, while enriched notifications deliver real-time insights, including payer and transaction details.
Orkestra supports asynchronous processing for greater scalability and offers multiple ways to integrate: from white-label, customizable payment pages to host-to-host connections and fully tailored checkout experiences.
Built for flexibility, Orkestra adapts to your payment creation and integration needs, giving you full control to scale across markets with ease.
How the Orkestra API Works
Orkestra API is structured around three core resources:
| Resource | Purpose | Typical Use |
|---|---|---|
| Orders | Receive payments (Cash-In) | Customers pay for goods or services, single or multiple participants per order. |
| Payouts | Send payments (Cash-Out) | Pay suppliers, partners, or users locally in their currency. |
| Refunds | Refund payments | Return funds from specific transactions via the original method or an alternative payout. |
๐ฆ Orders โ Receiving Payments, Charging Customers, Collecting Funds
An Order represents a payment request. It can have:
- Multiple Charges: split the cost among several customers.
- Multiple Transactions per Charge: accept different payment methods for a single customer (e.g., part card, part PIX).
- Submerchants or sellers: allowing the payment to be split between different suppliers
- Instant conversion, which allows businesses to protect their receivables from currency fluctuations by converting payments instantly after their receipt
Key Concepts:
- 1 Order โ N Charges โ N Transactions.
- All Transactions per Charge must be in the same currency and follow business validation rules.
- Transparent checkout (host-to-host) or Payment Page URL is always provided (iframe or redirect)
- Orders might be processed synchronously or asynchronously
Example of Synchronous order processing
Example of Asynchronous order processing
๐ธ Payouts โ Sending Payments
Payouts are asynchronous operations used to send funds to customers, partners, or suppliers.
- Supports local bank transfers, wallets, and more.
- Final states are delivered via Webhook (configured per request or per merchant).
- Ideal for mass disbursements, gig economy payments, affiliate payouts, and more.
๐ Refunds โ Returning Funds
Refunds are performed at the transaction level.
Orkestra supports:
- The return of the funds using the original transaction's payment method (e.g., Credit Card, PIX, Bank Transfer).
- Alternative payout refunds: when the original method is not reversible (e.g., boleto).
Refunds can be:
- Total or Partial.
- Multiple refunds per transaction are allowed, as long as there are still funds left to be refunded in the original transaction.
Service coverage
Our growing network ensures businesses can collect and disburse funds efficiently, wherever your customers or partners are. Local experience, global reach.
| Country | Currency | Method |
|---|---|---|
| ๐ฆ๐ท Argentina | ARS | Bank Transfer |
| ๐ง๐ท Brazil | BRL | Cards, PIX, Cash |
| ๐จ๐ฑ Chile | CLP | Cards, Cash, Bank Transfer |
| ๐จ๐ด Colombia | COP | Cards, PSE, Cash, Bank Transfer, Daviplata, Nequi |
| ๐ช๐จ Ecuador | USD | Cash |
| ๐ฒ๐ฝ Mexico | MXN | Cards, SPEI, Cash, Bank Transfer |
| ๐ต๐ช Peru | PEN | Cards, Cash, Bank Transfer |
| ๐ง๐ฏ Benin | XOF | Mobile Money |
| ๐ง๐ซ Burkina Faso | XOF | Bank Transfer |
| ๐จ๐ฒ Cameroon | XAF | Bank Transfer, Mobile Money |
| ๐ช๐ฌ Egypt | EGP | Cash, Bank Transfer |
| ๐ช๐น Ethiopia | ETB | Bank Transfer, Mobile Money |
| ๐ฌ๐ญ Ghana | GHS | Bank Transfer, Mobile Money |
| ๐จ๐ฎ Ivory Coast | XOF | Bank Transfer, Mobile Money |
| ๐ฐ๐ช Kenya | KES | Bank Transfer, Mobile Money |
| ๐ฒ๐ผ Malawi | MWK | Bank Transfer |
| ๐ณ๐ฌ Nigeria | NGN | Bank Transfer, Mobile Money |
| ๐ท๐ผ Rwanda | RWF | Bank Transfer, Mobile Money |
| ๐ธ๐ณ Senegal | XOF | Bank Transfer, Mobile Money |
| ๐ธ๐ฑ Sierra Leone | SLL | Bank Transfer |
| ๐ฟ๐ฆ South Africa | ZAR | Cash |
| ๐น๐ฟ Tanzania | TZS | Bank Transfer, Mobile Money |
| ๐บ๐ฌ Uganda | UGX | Bank Transfer, Mobile Money |
| ๐ฟ๐ฒ Zambia | ZMW | Mobile Money |
| ๐ช๐บ Europe | EUR | SEPA |
| ๐ World | USDT, USDC | Crypto Transfer |
Currently, this is the flowchart diagram flow of the full journey offered by the Orkestra API:
The Refund and Payout are not obligatory but can only be called if there are corresponding successful Orders.
For each of the provided web-methods there is a correspondent webhook.
Environments
Sandbox Environment
The Sandbox Environment is a safe and isolated testing environment where you can experiment with the API without affecting real-world data. It is designed to mimic the Production Environment as closely as possible, allowing you to:
- Test Integrations: Validate your API integrations and workflows;
- Simulate Transactions: Perform simulated transactions and data interactions;
- Debug Issues: Identify and fix issues in a controlled setting.
Accessing the Sandbox:
- URL: https://sandbox.orkestrapay.io
- Credentials: Obtain your sandbox API key by contacting us.
Production Environment
The Production Environment is the live environment where real transactions and data interactions occur. Use this environment to:
- Process Real Transactions: Interact with actual user data and perform live transactions;
- Deploy Live Services: Provide services to your end-users.
Accessing the Production Environment:
- URL: https://orkestrapay.io
- Credentials: Obtain your production API key by submitting a request through our support team.