Skip to main content
PUT
/
PaymentGatewayAccounts
/
{name}
Add or Replace a Payment Gateway Account
curl --request PUT \
  --url https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "paymentGatewayName": "<string>",
  "credentials": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "name": "<string>",
  "creationTime": "2023-11-07T05:31:56Z",
  "paymentGatewayName": "<string>",
  "credentials": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}

Gateway Accounts Guide

Complete guide with credential structure and naming conventions

Authorizations

​
X-Api-Key
string
header
required

Please enter ApiKey into field

Path Parameters

​
name
string
required

A unique name of this Payment Gateway Account

Body

application/json

Payment gateway account data

Input Model for designating a payment gateway account

​
paymentGatewayName
string | null

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

​
credentials
object[] | null

A list of key-value pairs that represents your credentials within the Payment gateway. Each key should represent a parameter listed in the "CredentialsNames" element of the response from the list all payment gateways method at [GET] /paymentGateway Example: "Credentials": [ { "Key": "PrivateKey", "Value": "VBtt666M/G098098vgdewvk0Mc-GH" } ]

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

A list of key-value pairs that represents your credentials within the Payment gateway. Each key should represent a parameter listed in the "CredentialsNames" element of the response from the list all payment gateways method at [GET] /paymentGateway Example: "Credentials": [ { "Key": "PrivateKey", "Value": "VBtt666M/G098098vgdewvk0Mc-GH" } ]