Skip to main content
This reference documents all Orchestra API endpoints. See how the Library and API work together.

​
Base URL

All API requests use the same base URL for both production and sandbox:
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:

​
Two Parts, One Platform

REST API

Backend calls for everything after capture: charges, refunds, tokenization.

Payments Library

Backend endpoints for the JavaScript library, which handles card capture in your frontend.

​
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

Payment operations (charge, authorize, capture, refund, void) are synchronous: Orchestra calls the gateway and returns its result in the same response. The HTTP status reflects the gateway’s result: StringTokens create returns 201 Created. Other GET operations return 200 OK. All operations are synchronous except scheduled payments.

​
Common Error Codes

​
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