Gateway Accounts

This page is part of the REST API Guides. View all REST API guides →

Automate gateway credential management: create, update, and delete payment gateway accounts programmatically instead of using the Portal UI. Ideal for CI/CD pipelines and multi-environment deployments.

Payment Gateway Accounts store your processor credentials securely in Orchestra. While most users configure these through the Portal, you can also manage them programmatically.

Account names must be 3-64 alphanumeric characters (no spaces or special characters).

Create or Update an Account

Endpoint: PUT /PaymentGatewayAccounts/{name}

const response = await fetch('https://api.orchestrasolutions.com/PaymentGatewayAccounts/stripeProduction', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
    'X-Api-Key': 'YOUR_API_KEY'
  },
  body: JSON.stringify({
    paymentGatewayName: 'Stripe',
    credentials: [
      { Key: 'SecretKey', Value: 'sk_live_...' }
    ]
  })
});

curl -X PUT https://api.orchestrasolutions.com/PaymentGatewayAccounts/stripeProduction \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "paymentGatewayName": "Stripe",
    "credentials": [
      { "Key": "SecretKey", "Value": "sk_live_..." }
    ]
  }'

import requests

response = requests.put(
    'https://api.orchestrasolutions.com/PaymentGatewayAccounts/stripeProduction',
    headers={
        'Content-Type': 'application/json',
        'X-Api-Key': 'YOUR_API_KEY'
    },
    json={
        'paymentGatewayName': 'Stripe',
        'credentials': [
            {'Key': 'SecretKey', 'Value': 'sk_live_...'}
        ]
    }
)

API Reference

Complete parameter reference, response fields, and status codes for all operations

Finding Required Credentials

Each gateway requires different credentials. Use List Gateways to find the credentialsNames for your gateway:

// GET /PaymentGateway returns:
// { "name": "Adyen", "credentialsNames": ["ApiKey", "MerchantAccount"] }

// So your credentials array should include:
{
  "paymentGatewayName": "Adyen",
  "credentials": [
    { "Key": "ApiKey", "Value": "your-api-key" },
    { "Key": "MerchantAccount", "Value": "your-merchant-account" }
  ]
}

Retrieve an Account

Endpoint: GET /PaymentGatewayAccounts/{name}

const response = await fetch('https://api.orchestrasolutions.com/PaymentGatewayAccounts/stripeProduction', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY'
  }
});

const account = await response.json();

List All Accounts

Endpoint: GET /PaymentGatewayAccounts

const response = await fetch('https://api.orchestrasolutions.com/PaymentGatewayAccounts', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY'
  }
});

const accounts = await response.json();

The list endpoint returns brief information without credentials. Use the retrieve endpoint to get full details.

Delete an Account

Endpoint: DELETE /PaymentGatewayAccounts/{name}

const response = await fetch('https://api.orchestrasolutions.com/PaymentGatewayAccounts/oldAccount', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY'
  }
});

Deletion is permanent. Ensure no active integrations reference the account before deleting.

Naming Conventions

Suggested naming patterns for gateway accounts:

Pattern	Example	Use Case
`{gateway}{Environment}`	`stripeProduction`	Single gateway per environment
`{gateway}{Region}`	`adyenEu`	Regional gateway routing
`{gateway}{Channel}`	`stripeWeb`, `stripeMobile`	Channel-specific accounts

List Gateways

Find required credentials

Portal Setup

UI-based configuration

Start Here

Beyond the Quickstart

Concepts

Orchestra Payments Library Guides

Orchestra REST API Guides

Utilities

Merchant Account Setup

Support

Changelog

Create or Update an Account

API Reference

Finding Required Credentials

Retrieve an Account

List All Accounts

Delete an Account

Naming Conventions

List Gateways

Portal Setup

​Create or Update an Account

API Reference

​Finding Required Credentials

​Retrieve an Account

​List All Accounts

​Delete an Account

​Naming Conventions

​Related

List Gateways

Portal Setup

Create or Update an Account

Finding Required Credentials

Retrieve an Account

List All Accounts

Delete an Account

Naming Conventions

Related