# Orchestra Solutions API

> Orchestra is a payment orchestration platform. Integrate once and route transactions to any supported payment provider, add or swap providers, and process card and digital wallet payments without changing your code.

## Payments Library and REST API Guides - Start Here

- [Orchestra Solutions Documentation](https://developers.orchestrasolutions.com): Orchestra is a payment orchestration platform. Integrate once and route transactions to any supported payment provider, without changing your code.
- [Introduction to Payment Orchestration](https://developers.orchestrasolutions.com/p18n-the-orchestra-way): Understand what Orchestra does, how it works, and whether it's right for your integration.
- [Quickstart](https://developers.orchestrasolutions.com/quickstart): Make your first API call to Orchestra in under 5 minutes.
- [How Do I...?](https://developers.orchestrasolutions.com/how-to): Find the right guide for what you want to accomplish.

## Payments Library and REST API Guides - Beyond the Quickstart

- [Creating & Managing an Account](https://developers.orchestrasolutions.com/getting-started/create-account): Sign up for an Orchestra sandbox account to start integrating.
- [Generating API Keys](https://developers.orchestrasolutions.com/getting-started/generate-api-key): Create API credentials to authenticate your requests.
- [Creating eWallet Accounts](https://developers.orchestrasolutions.com/getting-started/create-ewallet-account): Configure eWallet accounts to use the Payments Library for card payments, digital wallets, and other payment methods.
- [Adding a Payment Provider](https://developers.orchestrasolutions.com/getting-started/add-payment-provider): Connect a payment gateway account to Orchestra with your API credentials so you can start routing real transactions.
- [Testing & Going Live](https://developers.orchestrasolutions.com/concepts/testing-and-going-live): Understand sandbox vs production environments and how to launch.

## Payments Library and REST API Guides - Concepts

- [How Orchestra Works](https://developers.orchestrasolutions.com/concepts/how-orchestra-works): Learn how Orchestra sits between your application and payment providers to route, retry, and process transactions.
- [Payments Library vs REST API](https://developers.orchestrasolutions.com/concepts/api-vs-library): Compare Orchestra integration options: JavaScript library with built-in UI vs direct REST API calls.
- [Architecture](https://developers.orchestrasolutions.com/concepts/architecture): How Orchestra connects your application to payment gateways, handles routing, and processes transactions.

## Payments Library and REST API Guides - Orchestra Payments Library Guides

- [Library Setup](https://developers.orchestrasolutions.com/guides/library/setup): Install and configure the Orchestra Payments Library.
- [Library Reference](https://developers.orchestrasolutions.com/guides/library/reference): Complete API reference for the Orchestra Payments Library.
- [Complete Example](https://developers.orchestrasolutions.com/guides/library/complete-example): End-to-end Payments Library integration in one page.
- [Supported Payment Methods](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/index): Overview of all payment methods available through the Orchestra Payments Library.
- [CardPay](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/card-pay): Accept credit and debit card payments with CardPay.
- [ApplePay](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/apple-pay): Accept Apple Pay for fast, secure payments on Apple devices.
- [GooglePay](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/google-pay): Accept Google Pay for fast checkout on Android and Chrome.
- [PayPal](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/paypal): Accept PayPal payments with redirect-based checkout.
- [BankPay](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/bank-pay): Accept direct bank transfers via Open Banking or ACH.
- [UPI](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/upi): Accept UPI payments for instant bank transfers in India.
- [Result Handling](https://developers.orchestrasolutions.com/guides/library/result-handling): Parse and validate payment results from all payment methods.
- [3D Secure](https://developers.orchestrasolutions.com/guides/library/3d-secure): How the Payments Library handles 3D Secure authentication automatically for card payments.

## Payments Library and REST API Guides - Orchestra REST API Guides

- [Charge Payments](https://developers.orchestrasolutions.com/guides/rest-api/charge): Process immediate card payments through Orchestra.
- [Multi-Gateway Failover](https://developers.orchestrasolutions.com/guides/rest-api/multi-gateway-failover): Configure automatic failover across multiple payment providers.
- [3D Secure Authentication](https://developers.orchestrasolutions.com/guides/rest-api/3d-secure): Implement 3D Secure authentication for enhanced payment security.
- [Transaction Status](https://developers.orchestrasolutions.com/guides/rest-api/transaction-status): Check the status of previous transactions.
- [Authorize & Capture](https://developers.orchestrasolutions.com/guides/rest-api/authorize-capture): Hold funds on a card and capture them later.
- [Refunds & Voids](https://developers.orchestrasolutions.com/guides/rest-api/refunds-voids): Return funds with refunds or cancel authorizations with voids via the REST API.
- [Tokenization](https://developers.orchestrasolutions.com/guides/rest-api/tokenization): Securely store sensitive strings like card numbers.
- [Gateway Tokenization](https://developers.orchestrasolutions.com/guides/rest-api/gateway-tokenization): Create payment gateway-native tokens for recurring payments.
- [Gateway-Specific Requirements](https://developers.orchestrasolutions.com/guides/rest-api/gateway-requirements): Additional parameters and configuration for specific payment gateways.

## Payments Library and REST API Guides - Utilities

- [Mock Payment Gateways](https://developers.orchestrasolutions.com/guides/utilities/mock-psps): Use Orchestra's built-in mock PSPs for rapid testing without external provider accounts.
- [Validate API Key](https://developers.orchestrasolutions.com/guides/rest-api/utilities/validate-api-key): Test your API key and verify connectivity.
- [List Supported Gateways](https://developers.orchestrasolutions.com/guides/rest-api/utilities/list-gateways): Discover available payment gateways and their requirements.
- [Gateway Accounts](https://developers.orchestrasolutions.com/guides/rest-api/utilities/gateway-accounts): Manage stored payment gateway credentials via API.
- [Card Tools](https://developers.orchestrasolutions.com/guides/rest-api/utilities/card-tools): Identify card brands, retrieve card metadata, validate card numbers, and assess transaction risk.
- [Brand Lookup](https://developers.orchestrasolutions.com/guides/rest-api/utilities/card-tools/brand-lookup): Identify the card brand from the BIN and get a brand logo URL.
- [Metadata Lookup](https://developers.orchestrasolutions.com/guides/rest-api/utilities/card-tools/metadata-lookup): Get full card metadata including brand, type, category, issuer, and country from the BIN.
- [Luhn Validation](https://developers.orchestrasolutions.com/guides/rest-api/utilities/card-tools/luhn-validation): Validate a card number using the Luhn algorithm and optionally retrieve card metadata.
- [Card Validation](https://developers.orchestrasolutions.com/guides/rest-api/utilities/card-tools/card-validation): Assess transaction risk by comparing card origin against the payer's IP and billing address.

## Payments Library and REST API Guides - Merchant Account Setup

- [Google Pay Setup](https://developers.orchestrasolutions.com/guides/library/googlepay-setup): Create a Google Pay Business Profile and get your Merchant ID for use with Orchestra's Payments Library.
- [Apple Pay Setup](https://developers.orchestrasolutions.com/guides/library/applepay-setup): Generate the required Apple Pay integration data for your eWallet Account.
- [PayPal Setup](https://developers.orchestrasolutions.com/guides/library/paypal-setup): Get your PayPal REST API credentials from a verified PayPal Business account for use with Orchestra's Payments Library.
- [Bank Pay Setup](https://developers.orchestrasolutions.com/guides/library/bankpay-setup): Enable bank transfer payments through Orchestra.
- [UPI Setup](https://developers.orchestrasolutions.com/guides/library/upi-setup): Enable UPI (Unified Payments Interface) payments through Orchestra's Payments Library for instant bank-to-bank transfers.
- [Payment Service Provider (PSP) Setup](https://developers.orchestrasolutions.com/guides/library/psp-setup): Get API credentials from your payment processor.
- [Store eWallet Account](https://developers.orchestrasolutions.com/guides/library/store-merchant-account): Save digital wallet credentials in the Orchestra Portal.

## Payments Library and REST API Guides - Support

- [Troubleshooting](https://developers.orchestrasolutions.com/guides/troubleshooting): Diagnose and resolve common integration issues with Orchestra.
- [Contact Us](https://developers.orchestrasolutions.com/support): Get support via email, documentation feedback, or community discussions.

## Payments Library and REST API Guides - Changelog

- [Changelog](https://developers.orchestrasolutions.com/changelog): API and platform updates for Orchestra developers.

## REST API Reference - Overview

- [API Reference](https://developers.orchestrasolutions.com/api-reference/overview): Complete endpoint documentation for the Orchestra API.

## REST API Reference - Payment Operations

- [Payment Operations API Overview](https://developers.orchestrasolutions.com/api-reference/paymentgateway/overview): Charge, authorize, capture, refund, void, and check status of card transactions.
- [List all payment gateways](https://developers.orchestrasolutions.com/api-reference/paymentgateway/list-all-payment-gateways): To provide you with full payment orchestration capabilities, we have integrated with many different payment gateways and processors around the world. This method allows you to retrieve the list of all integrated payment gateways in our system and provide you with the relevant connection settings required for each of them.
- [Perform a payment gateway charge operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-charge-operation): This method allows you to perform a "charge" operation through your payment gateway. A "charge" operation will request immediate payment from the card and the card owner will see this listed as a transaction in their card statement.
- [Perform a payment gateway authorize operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-authorize-operation): This method allows you to perform an "authorize" operation (also called "preauthorization" or "authorization") through your payment gateway. When you perform the "authorize" operation, the bank that issued the credit card will place an authorization of the total amount of the funds. This is how the bank determines if the funds are available to make the purchase. The card will not actually be “charged” until you perform the "capture" operation (using our `[PUT] /PaymentGateway/capture` method).
- [Perform a payment gateway capture operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-capture-operation): This method allows you to perform a "capture" operation on a previously created "authorize" operation (see our `[POST] /PaymentGateway/authorize` method for additional information).
- [Perform a payment gateway tokenize operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-tokenize-operation): This method allows you to perform a "tokenize" operation for a card.
- [Perform a payment gateway refund operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-refund-operation): This method allows you to submit a "refund" operation against a previously created "charge" (using `[POST] /PaymentGateway/charge`) or "capture" (using `[POST] /PaymentGateway/capture`) operations.
- [Perform a payment gateway Void operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-void-operation): This method allows you to submit a "void" operation against a previously created "charge" (using `[POST] /PaymentGateway/charge`) or "authorize" (using `[POST] /PaymentGateway/authorize`) operations.
- [Perform a payment gateway status operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-status-operation): This method allows you to get the status of a previously created "charge" (using `[POST] /PaymentGateway/charge`) or "authorize" (using `[POST] /PaymentGateway/authorize`) operations.

## REST API Reference - String Tokens

- [String Tokens API Overview](https://developers.orchestrasolutions.com/api-reference/stringtokens/overview): Tokenize and securely store any sensitive string data.
- [Store and tokenize a string](https://developers.orchestrasolutions.com/api-reference/stringtokens/store-and-tokenize-a-string): This method allows you to submit a string to be stored and tokenized in our system.
- [Retrieve content of StringToken](https://developers.orchestrasolutions.com/api-reference/stringtokens/retrieve-content-of-stringtoken): This method allows you to retrieve the stored content of the StringToken.
- [Delete an existing string by token](https://developers.orchestrasolutions.com/api-reference/stringtokens/delete-an-existing-string-by-token): This method allows you to delete a stringToken by its token
- [Retrieve meta data of a StringToken](https://developers.orchestrasolutions.com/api-reference/stringtokens/retrieve-meta-data-of-a-stringtoken): This method allows you to retrieve the meta data of a StringToken.

## REST API Reference - Payment Gateway Accounts

- [Payment Gateway Accounts API Overview](https://developers.orchestrasolutions.com/api-reference/paymentgatewayaccounts/overview): Store and manage payment processor credentials securely.
- [List Payment Gateway Accounts](https://developers.orchestrasolutions.com/api-reference/paymentgatewayaccounts/list-payment-gateway-accounts): This method allows you to list all stored Payment Gateway Accounts in the system
- [Retrieve Payment Gateway Account](https://developers.orchestrasolutions.com/api-reference/paymentgatewayaccounts/retrieve-payment-gateway-account): A Payment Gateway Account is the set of information necessary for connecting to a specific payment gateway through our system.
- [Add or Replace a Payment Gateway Account](https://developers.orchestrasolutions.com/api-reference/paymentgatewayaccounts/add-or-replace-a-payment-gateway-account): A Payment Gateway Account is the set of information necessary for connecting to a specific payment gateway through our system.
- [Delete a Payment Gateway Account](https://developers.orchestrasolutions.com/api-reference/paymentgatewayaccounts/delete-a-payment-gateway-account): This method allows you to delete a stored Payment Gateway Account in the system.

## REST API Reference - Card Tools

- [Card Tools API](https://developers.orchestrasolutions.com/api-reference/tools/overview): BIN/IIN lookup, brand identification, Luhn validation, and card risk assessment.
- [Brand Lookup](https://developers.orchestrasolutions.com/api-reference/tools/brand-lookup): This method allows you to lookup the brand of the card provided. By providing the card's BIN / IIN (the first 6 to 11 digits of the card number), we lookup and return the brand of the card (Visa, Mastercard, Amex, etc.). In addition, we will also provide the URL to the logo of the card brand - you can then reference this image in your card capture form.
- [Metadata Lookup](https://developers.orchestrasolutions.com/api-reference/tools/metadata-lookup): This method allows you to lookup the metadata of the card provided. By providing the card's BIN / IIN (the first 6 to 11 digits of the card number), we lookup and return the full metadata available for this card. This includes the card brand, type, category, issuing organization, country code, and a URL to the brand logo.
- [Luhn Algorithm Validation](https://developers.orchestrasolutions.com/api-reference/tools/luhn-validation): This method allows you to provide the card number and validate it against the Luhn algorithm. In addition, you can choose to receive the card's metadata in the response.
- [Card Validation](https://developers.orchestrasolutions.com/api-reference/tools/card-validation): This method allows you to validate the card details against the card's metadata. By providing the billing address and IP address of the card owner, we validate those against the metadata of the card and provide a risk assessment for this transaction. All you would need is the card's BIN / IIN (the first 6 to 11 digits of the card number), the billing address and IP address. The response of this method will include the full metadata information for this BIN including the risk assessment.

## REST API Reference - Utilities

- [Validate Apikey](https://developers.orchestrasolutions.com/api-reference/utils/validate-apikey): This operation allows you to validate your API key and make sure that it is operational. Additionally, this method will allow you to test and check that the API is functioning properly

## REST API Reference - Payments Library

- [Payments Library API Overview](https://developers.orchestrasolutions.com/api-reference/ewalletoperations/overview): Backend endpoints for the Orchestra Payments Library.
- [Start an eWallet session](https://developers.orchestrasolutions.com/api-reference/ewalletoperations/start-an-ewallet-session): Start an eWallet session
- [Validate Operation results](https://developers.orchestrasolutions.com/api-reference/ewalletoperations/validate-operation-results): Validate Operation results

## Support
- [Support Forum](https://github.com/orchestra-solutions/p18n/discussions): Ask questions and get help from the Orchestra team