# Orchestra Solutions

> Payment orchestration platform documentation

## Docs

- [Overview](https://developers.orchestrasolutions.com/api-reference/ewalletoperations/overview.md): Backend endpoints for the Orchestra Payments Library.
- [Start an eWallet session](https://developers.orchestrasolutions.com/api-reference/ewalletoperations/start-an-ewallet-session.md)
- [Validate Operation results](https://developers.orchestrasolutions.com/api-reference/ewalletoperations/validate-operation-results.md)
- [API Reference](https://developers.orchestrasolutions.com/api-reference/overview.md): Complete endpoint documentation for the Orchestra API.
- [List all payment gateways](https://developers.orchestrasolutions.com/api-reference/paymentgateway/list-all-payment-gateways.md): 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 req…
- [Overview](https://developers.orchestrasolutions.com/api-reference/paymentgateway/overview.md): Charge, authorize, capture, refund, void, and check status of card transactions.
- [Perform a payment gateway authorize operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-authorize-operation.md): 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…
- [Perform a payment gateway capture operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-capture-operation.md): This method allows you to perform a "capture" operation on a previously created "authorize" operation (see our `[POST] /PaymentGateway/authorize` method for additional information). When you perform the "authorize" operation, the bank that issued the credit card will place an authorization of the to…
- [Perform a payment gateway charge operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-charge-operation.md): 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. If needed, you can void this "charge" operation by using the `[DELE…
- [Perform a payment gateway refund operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-refund-operation.md): 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 status operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-status-operation.md): This method allows you to get the status of a previously created "charge" (using `[POST] /PaymentGateway/charge`) or "authorize" (using `[POST] /PaymentGateway/authorize`) operations.
- [Perform a payment gateway tokenize operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-tokenize-operation.md): This method allows you to perform a "tokenize" operation for a card. This will take the card details and will generate a payment gateway-specific token. Please note that not all payment gateways support this operation.
- [Perform a payment gateway Void operation](https://developers.orchestrasolutions.com/api-reference/paymentgateway/perform-a-payment-gateway-void-operation.md): 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.
- [Add or Replace a Payment Gateway Account](https://developers.orchestrasolutions.com/api-reference/paymentgatewayaccounts/add-or-replace-a-payment-gateway-account.md): A Payment Gateway Account is the set of information necessary for connecting to a specific payment gateway through our system. This method allows you to add a new stored Payment Gateway Account in the system or to replace an existing one.
- [Delete a Payment Gateway Account](https://developers.orchestrasolutions.com/api-reference/paymentgatewayaccounts/delete-a-payment-gateway-account.md): This method allows you to delete a stored Payment Gateway Account in the system.
- [List Payment Gateway Accounts](https://developers.orchestrasolutions.com/api-reference/paymentgatewayaccounts/list-payment-gateway-accounts.md): This method allows you to list all stored Payment Gateway Accounts in the system
- [Overview](https://developers.orchestrasolutions.com/api-reference/paymentgatewayaccounts/overview.md): Store and manage payment processor credentials securely.
- [Retrieve Payment Gateway Account](https://developers.orchestrasolutions.com/api-reference/paymentgatewayaccounts/retrieve-payment-gateway-account.md): A Payment Gateway Account is the set of information necessary for connecting to a specific payment gateway through our system. This method allows you to retrieve the information set on a particular payment gateway account. You can then update it using the `[PUT] PaymentGatewayAccounts/{name}` method
- [Delete an existing string by token](https://developers.orchestrasolutions.com/api-reference/stringtokens/delete-an-existing-string-by-token.md): This method allows you to delete a stringToken by its token
- [Overview](https://developers.orchestrasolutions.com/api-reference/stringtokens/overview.md): Tokenize and securely store any sensitive string data.
- [Retrieve content of StringToken](https://developers.orchestrasolutions.com/api-reference/stringtokens/retrieve-content-of-stringtoken.md): This method allows you to retrieve the stored content of the StringToken.
- [Retrieve meta data of a StringToken](https://developers.orchestrasolutions.com/api-reference/stringtokens/retrieve-meta-data-of-a-stringtoken.md): This method allows you to retrieve the meta data of a StringToken. The response to this method will **not** retrieve the content of the StringToken (you can do that by using `GET /StringTokens/{token}`)
- [Store and tokenize a string](https://developers.orchestrasolutions.com/api-reference/stringtokens/store-and-tokenize-a-string.md): This method allows you to submit a string to be stored and tokenized in our system. Once tokenized, the token ID will be returned in the body of the response and the full token URI will be returned in the `Location` header.
- [Validate Apikey](https://developers.orchestrasolutions.com/api-reference/utils/validate-apikey.md): 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
- [Changelog](https://developers.orchestrasolutions.com/changelog.md): API and platform updates for Orchestra developers.
- [Payments Library vs REST API](https://developers.orchestrasolutions.com/concepts/api-vs-library.md): Compare Orchestra integration options: JavaScript library with built-in UI vs direct REST API calls.
- [Architecture](https://developers.orchestrasolutions.com/concepts/architecture.md): How Orchestra connects your application to payment gateways, handles routing, and processes transactions.
- [How Orchestra Works](https://developers.orchestrasolutions.com/concepts/how-orchestra-works.md): Learn how Orchestra sits between your application and payment providers to route, retry, and process transactions.
- [Testing & Going Live](https://developers.orchestrasolutions.com/concepts/testing-and-going-live.md): Understand sandbox vs production environments and how to launch.
- [Adding a Payment Provider](https://developers.orchestrasolutions.com/getting-started/add-payment-provider.md): Connect a payment gateway to Orchestra.
- [Creating & Managing an Account](https://developers.orchestrasolutions.com/getting-started/create-account.md): Sign up for an Orchestra sandbox account to start integrating.
- [Creating eWallet Accounts](https://developers.orchestrasolutions.com/getting-started/create-ewallet-account.md): Configure eWallet accounts to use the Payments Library for card payments, digital wallets, and other payment methods.
- [Generating API Keys](https://developers.orchestrasolutions.com/getting-started/generate-api-key.md): Create API credentials to authenticate your requests.
- [3D Secure](https://developers.orchestrasolutions.com/guides/library/3d-secure.md): How the Payments Library handles 3D Secure authentication automatically for card payments.
- [Apple Pay Setup](https://developers.orchestrasolutions.com/guides/library/applepay-setup.md): Generate the required Apple Pay integration data for your eWallet Account.
- [Bank Pay Setup](https://developers.orchestrasolutions.com/guides/library/bankpay-setup.md): Enable bank transfer payments through Orchestra.
- [Complete Example](https://developers.orchestrasolutions.com/guides/library/complete-example.md): End-to-end Payments Library integration in one page.
- [Google Pay Setup](https://developers.orchestrasolutions.com/guides/library/googlepay-setup.md): Get your Google Pay Merchant ID.
- [PayPal Setup](https://developers.orchestrasolutions.com/guides/library/paypal-setup.md): Get your PayPal REST API credentials.
- [Payment Service Provider (PSP) Setup](https://developers.orchestrasolutions.com/guides/library/psp-setup.md): Get API credentials from your payment processor.
- [Library Reference](https://developers.orchestrasolutions.com/guides/library/reference.md): Complete API reference for the Orchestra Payments Library.
- [Result Handling](https://developers.orchestrasolutions.com/guides/library/result-handling.md): Parse and validate payment results from all payment methods.
- [Library Setup](https://developers.orchestrasolutions.com/guides/library/setup.md): Install and configure the Orchestra Payments Library.
- [Store eWallet Account](https://developers.orchestrasolutions.com/guides/library/store-merchant-account.md): Save digital wallet credentials in the Orchestra Portal.
- [ApplePay](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/apple-pay.md): Accept Apple Pay for fast, secure payments on Apple devices.
- [BankPay](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/bank-pay.md): Accept direct bank transfers via Open Banking or ACH.
- [CardPay](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/card-pay.md): Accept credit and debit card payments with CardPay.
- [GooglePay](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/google-pay.md): Accept Google Pay for fast checkout on Android and Chrome.
- [Supported Payment Methods](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/index.md): Overview of all payment methods available through the Orchestra Payments Library.
- [PayPal](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/paypal.md): Accept PayPal payments with redirect-based checkout.
- [UPI](https://developers.orchestrasolutions.com/guides/library/supported-payment-methods/upi.md): Accept UPI payments for instant bank transfers in India.
- [UPI Setup](https://developers.orchestrasolutions.com/guides/library/upi-setup.md): Enable UPI payments through Orchestra.
- [3D Secure Authentication](https://developers.orchestrasolutions.com/guides/rest-api/3d-secure.md): Implement 3D Secure authentication for enhanced payment security.
- [Authorize & Capture](https://developers.orchestrasolutions.com/guides/rest-api/authorize-capture.md): Hold funds on a card and capture them later.
- [Charge Payments](https://developers.orchestrasolutions.com/guides/rest-api/charge.md): Process immediate card payments through Orchestra.
- [Gateway-Specific Requirements](https://developers.orchestrasolutions.com/guides/rest-api/gateway-requirements.md): Additional parameters and configuration for specific payment gateways.
- [Gateway Tokenization](https://developers.orchestrasolutions.com/guides/rest-api/gateway-tokenization.md): Create payment gateway-native tokens for recurring payments.
- [Multi-Gateway Failover](https://developers.orchestrasolutions.com/guides/rest-api/multi-gateway-failover.md): Configure automatic failover across multiple payment providers.
- [Refunds & Voids](https://developers.orchestrasolutions.com/guides/rest-api/refunds-voids.md): Return funds with refunds or cancel authorizations with voids via the REST API.
- [Tokenization](https://developers.orchestrasolutions.com/guides/rest-api/tokenization.md): Securely store sensitive strings like card numbers.
- [Transaction Status](https://developers.orchestrasolutions.com/guides/rest-api/transaction-status.md): Check the status of previous transactions.
- [Gateway Accounts](https://developers.orchestrasolutions.com/guides/rest-api/utilities/gateway-accounts.md): Manage stored payment gateway credentials via API.
- [List Supported Gateways](https://developers.orchestrasolutions.com/guides/rest-api/utilities/list-gateways.md): Discover available payment gateways and their requirements.
- [Validate API Key](https://developers.orchestrasolutions.com/guides/rest-api/utilities/validate-api-key.md): Test your API key and verify connectivity.
- [Mock Payment Gateways](https://developers.orchestrasolutions.com/guides/utilities/mock-psps.md): Use Orchestra's built-in mock PSPs for rapid testing without external provider accounts.
- [How Do I...?](https://developers.orchestrasolutions.com/how-to.md): Find the right guide for what you want to accomplish.
- [Orchestra Solutions Documentation](https://developers.orchestrasolutions.com/index.md): Orchestra is a payment orchestration platform that lets you integrate once and route transactions to any supported payment provider. Add providers, swap them out, or run multiple providers simultaneously without changing your code.
- [Introduction to Payment Orchestration](https://developers.orchestrasolutions.com/p18n-the-orchestra-way.md): Understand what Orchestra does, how it works, and whether it's right for your integration.
- [Quickstart](https://developers.orchestrasolutions.com/quickstart.md): Make your first API call to Orchestra in under 5 minutes.
- [Contact Us](https://developers.orchestrasolutions.com/support.md): Get support via email, documentation feedback, or community discussions.

## OpenAPI Specs

- [orchsol](https://developers.orchestrasolutions.com/orchsol.json)

## Optional

- [GitHub](https://github.com/orchestra-solutions/p18n)
- [Support Forum](https://github.com/orchestra-solutions/p18n/discussions)