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>"
}
]
}
'import requests
url = "https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name}"
payload = {
"paymentGatewayName": "<string>",
"credentials": [
{
"key": "<string>",
"value": "<string>"
}
]
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
paymentGatewayName: '<string>',
credentials: [{key: '<string>', value: '<string>'}]
})
};
fetch('https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'paymentGatewayName' => '<string>',
'credentials' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name}"
payload := strings.NewReader("{\n \"paymentGatewayName\": \"<string>\",\n \"credentials\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paymentGatewayName\": \"<string>\",\n \"credentials\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"paymentGatewayName\": \"<string>\",\n \"credentials\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"creationTime": "2023-11-07T05:31:56Z",
"paymentGatewayName": "<string>",
"credentials": [
{
"key": "<string>",
"value": "<string>"
}
]
}[
{
"fieldName": "<string>",
"errors": [
"<string>"
]
}
]Add or Replace a Payment Gateway Account
A Payment Gateway Account is the set of information necessary for connecting to a specific payment gateway through our system. This method allows you to add a new stored Payment Gateway Account in the system or to replace an existing one.
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>"
}
]
}
'import requests
url = "https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name}"
payload = {
"paymentGatewayName": "<string>",
"credentials": [
{
"key": "<string>",
"value": "<string>"
}
]
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
paymentGatewayName: '<string>',
credentials: [{key: '<string>', value: '<string>'}]
})
};
fetch('https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'paymentGatewayName' => '<string>',
'credentials' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name}"
payload := strings.NewReader("{\n \"paymentGatewayName\": \"<string>\",\n \"credentials\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paymentGatewayName\": \"<string>\",\n \"credentials\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orchestrasolutions.com/PaymentGatewayAccounts/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"paymentGatewayName\": \"<string>\",\n \"credentials\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"creationTime": "2023-11-07T05:31:56Z",
"paymentGatewayName": "<string>",
"credentials": [
{
"key": "<string>",
"value": "<string>"
}
]
}[
{
"fieldName": "<string>",
"errors": [
"<string>"
]
}
]related
Gateway Accounts Guide
Authorizations
Please enter ApiKey into field
Path Parameters
A unique name of this Payment Gateway Account
^[A-Za-z0-9]{3,64}$Body
Payment gateway account data
Input Model for designating a payment gateway account
Unique name of the Payment Gateway the account information relates to.
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"
}
]
Show child attributes
Show child attributes
Response
OK
Output Model for designating a payment gateway account
Name of account
Date and time the credentials were stored
Unique name of the Payment Gateway the account information relates to.
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"
}
]
Show child attributes
Show child attributes