Skip to main content
← Back to API Reference
Payment Gateway Accounts store your PSP (Payment Service Provider) credentials securely in Orchestra. Once stored, you can reference them by name when processing payments through either the REST API or the Payments Library.

​
How It Works

  1. Choose a PSP from Orchestra’s supported processors
  2. Obtain credentials from your PSP (API keys, merchant IDs, etc.)
  3. Store in Orchestra via the Portal or this API
  4. Reference by name in your payment requests

​
Why Use Payment Gateway Accounts?

  • Security - Keep sensitive PSP credentials out of your own systems
  • Multi-gateway setups - Store credentials for multiple processors and switch between them dynamically
  • Failover support - Configure multiple PSPs and let Orchestra route transactions automatically
  • Platforms/SaaS - Process payments on behalf of your customers using their merchant accounts
  • Environment separation - Maintain separate accounts for sandbox and production
You can also provide PSP credentials inline with each request instead of storing them, but stored accounts are recommended for security and convenience.
Prefer a UI? You can also manage Payment Gateway Accounts through the Orchestra Portal. The API is useful for automation, CI/CD pipelines, or programmatic management.

​
Finding Required Credentials

Each PSP requires different credentials. Use the List Gateways endpoint to find the credentialsNames required for your PSP, or check the Gateway Requirements guide for PSP-specific details.

​
Endpoints

List Accounts

Retrieve all stored payment gateway accounts.

Retrieve Account

Get details for a specific account including credentials.

Add or Replace

Store new PSP credentials or update existing ones.

Delete Account

Permanently remove a stored account.
Deleting an account is permanent. Ensure no active integrations reference the account before deleting.