Base URL
All API requests use the same base URL for both production and sandbox:Authentication
Authenticate all API requests with your API key (created through the Orchestra Portal). Include it in theX-Api-Key header:
Choose Your Path
REST API
Direct HTTP calls for charges, refunds, tokenization. You handle card collection and UI.
Payments Library
Backend endpoints for the JavaScript library. The library handles card entry UI.
REST API Endpoints
Use these endpoints when integrating via direct HTTP calls from your backend.Payment Operations
Charge, authorize, capture, refund, and void transactions.
String Tokens
Tokenize and retrieve sensitive strings (card numbers, etc).
Payment Gateway Accounts
Store and manage your payment provider credentials.
Utilities
Validate API key, list supported gateways.
Payments Library Endpoints
Use these endpoints when integrating via the JavaScript Payments Library. Your server calls these endpoints; the client-side library handles UI.Start Session
Create a payment session for the client-side library.
Validate Results
Verify payment results returned from the library.
Payment Gateway Accounts
Store and manage your payment provider credentials.
eWallet Accounts
Configure accounts for Apple Pay, Google Pay, PayPal, and more.
Response Codes
Orchestra API endpoints use two response patterns:| Pattern | Status Code | Used By | Meaning |
|---|---|---|---|
| Async | 202 Accepted | Payment operations (charge, authorize, capture, refund, void) | Request forwarded to payment gateway. Check response body for gateway result. |
| Sync | 201 Created | StringTokens (create) | Operation completed. Resource created in Orchestra. |
| Sync | 200 OK | GET operations, status checks | Operation completed successfully. |
Common Error Codes
| Code | Description |
|---|---|
400 | Bad request - invalid parameters |
401 | Not authenticated - invalid or missing API key |
404 | Resource not found |
409 | Conflict - rejected by payment gateway or validation failed |
500 | Internal server error |
503 | Temporary failure - retry with exponential backoff |
Payment operations return
202 because they’re forwarded to external gateways asynchronously. The response body contains the gateway’s result. StringTokens returns 201 because tokens are stored synchronously in Orchestra’s vault.OpenAPI Specification
The Orchestra API is fully described in an OpenAPI 3.0 specification file. You can use this to:- Import into Postman or other API clients for quick testing and exploration
- Generate client libraries in your preferred language using tools like OpenAPI Generator
- Enable IDE autocomplete for API requests in supported editors
- Build integrations with API management platforms
Download OpenAPI Spec
OAS 3.0 format. Use with Postman, client generators, or your IDE