Skip to main content
GET
Retrieve Payment Gateway Account

Gateway Accounts Guide

Complete guide with account management and best practices

Path Parameters

name
string
required

A unique name of this Payment Gateway Account

Pattern: ^[A-Za-z0-9]{3,64}$

Response

OK

Output Model for designating a payment gateway account

name
string | null

Name of account

creationTime
string<date-time>

Date and time the credentials were stored

paymentGatewayName
string | null

Unique name of the Payment Gateway the account information relates to.

credentials
object[] | null

An array of key-value pairs containing the authentication parameters required to connect Orchestra to your payment gateway account. Each payment gateway requires a specific set of credentials (such as API keys, merchant IDs, secret keys, etc.) to establish the connection. Structure: Each credential object contains a Key (string) for the parameter name and a Value (string) for the authentication value. ** Determining Required Credentials:** The specific credentials required vary by payment gateway.To retrieve the required credential parameters for your target gateway, call GET /paymentGateway to get all available payment gateways and their credential specifications. Each gateway will list which credential keys are required (e.g., "PrivateKey", "MerchantID", "ApiSecret"). Example:

**Security Note: **Credential values are sensitive authentication data. Ensure all API calls are made over HTTPS and values are stored securely.