Prerequisites
- An Orchestra account (sign up here)
- A payment gateway account with API credentials
Two Different API Keys
Many payment providers use an API key as their authentication model, just like Orchestra does. These are two separate keys that authenticate two separate hops, and they are not interchangeable:
You need both: without the Orchestra API key your requests never reach Orchestra, and without the PSP key Orchestra cannot process the transaction at the provider.
Add a Provider
1
Navigate to Payment Gateway Accounts
In the Orchestra portal, go to Payment Gateway Account > Create.
2
Configure the Connection
Fill in the required fields:
The credentials fields change based on the gateway you select. Common fields include API keys, terminal IDs, merchant IDs, and secret keys.
3
Save
Click Save. Your provider is now connected and ready for transactions.
Gateway Credentials
Each gateway requires different credentials. Here are examples for common providers:Stripe
Stripe
- API Key: Your Stripe secret key (starts with
sk_test_orsk_live_)
Adyen
Adyen
- Merchant Account: Your merchant account name
- Username and Password: Your Adyen username and password
- Company Name: Your company name in Adyen
Worldpay
Worldpay
- SecurenetId: Your unique merchant identifier for Worldpay’s API.
- SecureNetKey: Your API authentication key for Worldpay backend configurations.
Test vs Production Credentials
Most gateways provide separate test and production credentials:
When you’re ready to go live, create a new Payment Gateway Account with your production credentials. You can keep both test and production accounts configured and reference them by name in your API calls.
Your Orchestra account is also either sandbox or live, and the two must match. A sandbox Orchestra account cannot run live operations (requests fail with HTTP 403 “The user cannot make Live operations”) and routes gateway traffic to the provider’s sandbox endpoints, so live PSP credentials configured in a sandbox account will not work, and vice versa. To go live, register a live Orchestra account, generate a new API key in it, and recreate your eWallet and Payment Gateway Accounts there with your production PSP credentials.
Next Steps
Generate API Key
Create credentials for API access
Quickstart
Make your first charge