Skip to main content
This reference documents all Orchestra API endpoints. Not sure which integration approach is right for you? See REST API vs Payments Library.

​
Base URL

All API requests use the same base URL for both production and sandbox: 
https://api.orchestrasolutions.com
All request and response bodies are JSON format.

​
Authentication

Authenticate all API requests with your API key (created through the Orchestra Portal). Include it in the X-Api-Key header: 
curl -X GET "https://api.orchestrasolutions.com/PaymentGateway" \
  -H "X-Api-Key: YOUR_API_KEY"

​
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.

​
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.

Merchant Accounts

Configure accounts for Google Pay, Apple Pay, PayPal.

​
Response Codes

Orchestra API endpoints use two response patterns:
PatternStatus CodeUsed ByMeaning
Async202 AcceptedPayment operations (charge, authorize, capture, refund, void)Request forwarded to payment gateway. Check response body for gateway result.
Sync201 CreatedStringTokens (create)Operation completed. Resource created in Orchestra.
Sync200 OKGET operations, status checksOperation completed successfully.

​
Common Error Codes

CodeDescription
400Bad request - invalid parameters
401Not authenticated - invalid or missing API key
404Resource not found
409Conflict - rejected by payment gateway or validation failed
500Internal server error
503Temporary 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

Download OpenAPI Spec

OAS 3.0 format — use with Postman, client generators, or your IDE