Skip to main content
Discover all 60+ payment gateways Orchestra supports and see exactly what credentials each requires. No need to search documentation or contact support.
Retrieve the list of all payment gateways integrated with Orchestra, along with the credentials each requires. Endpoint: GET /PaymentGateway

List All Gateways

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

const gateways = await response.json();

Response

Returns an array of gateway descriptions:
[
  {
    "name": "Stripe",
    "displayName": "Stripe",
    "paymentGatewayUrl": "https://stripe.com",
    "description": "Global payment processing platform",
    "credentialsNames": ["SecretKey"],
    "supportsNetworkToken": true
  },
  {
    "name": "Adyen",
    "displayName": "Adyen",
    "paymentGatewayUrl": "https://adyen.com",
    "description": "Enterprise payment platform",
    "credentialsNames": ["ApiKey", "MerchantAccount"],
    "supportsNetworkToken": true
  }
]

Response Fields

FieldTypeDescription
namestringInternal identifier - use this in paymentGatewayName
displayNamestringHuman-readable gateway name
paymentGatewayUrlstringGateway’s website
descriptionstringBrief description
credentialsNamesarrayRequired credential keys for this gateway
supportsNetworkTokenbooleanWhether gateway supports network tokens

Using Gateway Information

Find Required Credentials

Before adding a payment provider, check what credentials you need:
const gateways = await response.json();
const stripe = gateways.find(g => g.name === 'Stripe');

console.log('Required credentials:', stripe.credentialsNames);
// ['SecretKey']

Create Gateway Account with Correct Credentials

Use the credentialsNames to structure your Gateway Account request:
// For a gateway requiring ['ApiKey', 'MerchantAccount']
const accountData = {
  paymentGatewayName: 'Adyen',
  credentials: [
    { Key: 'ApiKey', Value: 'your-api-key' },
    { Key: 'MerchantAccount', Value: 'your-merchant-account' }
  ]
};

Check Network Token Support

For card scheme network tokens (Visa, Mastercard, Amex):
const gateways = await response.json();
const networkTokenGateways = gateways.filter(g => g.supportsNetworkToken);

console.log('Gateways supporting network tokens:');
networkTokenGateways.forEach(g => console.log(`- ${g.displayName}`));

Response Codes

CodeDescription
200Success
401Not authenticated