Payment Gateways

Update direct payment gateway credentials

Updates only stripe, authorize_net, paypal or qpaypro for the current organization. Fields depend on name. Existing gateway IDs are organization/provider scoped. Empty credentials can remove an existing gateway; direct Stripe writes conflict with a managed Stripe connection or active link attempt. PayPal credentials are verified when both keys are nonblank. Authorize.Net can return an empty HTTP200 body after a successful save. This configures gateways and does not charge a donation. Requires permission: one of access_payment_gateways.

POST

payment-gateways

{name}

curl --request POST \
  --url https://api.gratona.com/v1/payment-gateways/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "stripe_gateway_id": 42,
  "id": 42,
  "paypal_gateway_id": 42,
  "qpay_gateway_id": 42,
  "stripe": "REDACTED",
  "pivateKey": "REDACTED",
  "publicKey": "REDACTED",
  "privateKey": "REDACTED",
  "stripe_webhook_signing_secret": "REDACTED",
  "paypal_webhook_id": "REDACTED",
  "paypal": "REDACTED",
  "x_login": "REDACTED",
  "x_api_secret": "REDACTED",
  "x_private_key": "REDACTED"
}
'

import requests

url = "https://api.gratona.com/v1/payment-gateways/{name}"

payload = {
    "stripe_gateway_id": 42,
    "id": 42,
    "paypal_gateway_id": 42,
    "qpay_gateway_id": 42,
    "stripe": "REDACTED",
    "pivateKey": "REDACTED",
    "publicKey": "REDACTED",
    "privateKey": "REDACTED",
    "stripe_webhook_signing_secret": "REDACTED",
    "paypal_webhook_id": "REDACTED",
    "paypal": "REDACTED",
    "x_login": "REDACTED",
    "x_api_secret": "REDACTED",
    "x_private_key": "REDACTED"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    stripe_gateway_id: 42,
    id: 42,
    paypal_gateway_id: 42,
    qpay_gateway_id: 42,
    stripe: 'REDACTED',
    pivateKey: 'REDACTED',
    publicKey: 'REDACTED',
    privateKey: 'REDACTED',
    stripe_webhook_signing_secret: 'REDACTED',
    paypal_webhook_id: 'REDACTED',
    paypal: 'REDACTED',
    x_login: 'REDACTED',
    x_api_secret: 'REDACTED',
    x_private_key: 'REDACTED'
  })
};

fetch('https://api.gratona.com/v1/payment-gateways/{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.gratona.com/v1/payment-gateways/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'stripe_gateway_id' => 42,
    'id' => 42,
    'paypal_gateway_id' => 42,
    'qpay_gateway_id' => 42,
    'stripe' => 'REDACTED',
    'pivateKey' => 'REDACTED',
    'publicKey' => 'REDACTED',
    'privateKey' => 'REDACTED',
    'stripe_webhook_signing_secret' => 'REDACTED',
    'paypal_webhook_id' => 'REDACTED',
    'paypal' => 'REDACTED',
    'x_login' => 'REDACTED',
    'x_api_secret' => 'REDACTED',
    'x_private_key' => 'REDACTED'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.gratona.com/v1/payment-gateways/{name}"

	payload := strings.NewReader("{\n  \"stripe_gateway_id\": 42,\n  \"id\": 42,\n  \"paypal_gateway_id\": 42,\n  \"qpay_gateway_id\": 42,\n  \"stripe\": \"REDACTED\",\n  \"pivateKey\": \"REDACTED\",\n  \"publicKey\": \"REDACTED\",\n  \"privateKey\": \"REDACTED\",\n  \"stripe_webhook_signing_secret\": \"REDACTED\",\n  \"paypal_webhook_id\": \"REDACTED\",\n  \"paypal\": \"REDACTED\",\n  \"x_login\": \"REDACTED\",\n  \"x_api_secret\": \"REDACTED\",\n  \"x_private_key\": \"REDACTED\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("https://api.gratona.com/v1/payment-gateways/{name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"stripe_gateway_id\": 42,\n  \"id\": 42,\n  \"paypal_gateway_id\": 42,\n  \"qpay_gateway_id\": 42,\n  \"stripe\": \"REDACTED\",\n  \"pivateKey\": \"REDACTED\",\n  \"publicKey\": \"REDACTED\",\n  \"privateKey\": \"REDACTED\",\n  \"stripe_webhook_signing_secret\": \"REDACTED\",\n  \"paypal_webhook_id\": \"REDACTED\",\n  \"paypal\": \"REDACTED\",\n  \"x_login\": \"REDACTED\",\n  \"x_api_secret\": \"REDACTED\",\n  \"x_private_key\": \"REDACTED\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/payment-gateways/{name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"stripe_gateway_id\": 42,\n  \"id\": 42,\n  \"paypal_gateway_id\": 42,\n  \"qpay_gateway_id\": 42,\n  \"stripe\": \"REDACTED\",\n  \"pivateKey\": \"REDACTED\",\n  \"publicKey\": \"REDACTED\",\n  \"privateKey\": \"REDACTED\",\n  \"stripe_webhook_signing_secret\": \"REDACTED\",\n  \"paypal_webhook_id\": \"REDACTED\",\n  \"paypal\": \"REDACTED\",\n  \"x_login\": \"REDACTED\",\n  \"x_api_secret\": \"REDACTED\",\n  \"x_private_key\": \"REDACTED\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Settings saved successfully."
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Not Found",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

name

enum<string>

required

Direct gateway provider.

Available options:

stripe,

authorize_net,

paypal,

qpaypro

Body

application/json

Validated request fields for this operation.

stripe_gateway_id

integer

Existing current-organization gateway record ID.

Example:

42

integer

Existing current-organization gateway record ID.

Example:

42

paypal_gateway_id

integer

Existing current-organization gateway record ID.

Example:

42

qpay_gateway_id

integer

Existing current-organization gateway record ID.

Example:

42

stripe

string

write-only

Presence enables saving direct Stripe; an empty value may remove the resulting row.

Example:

"REDACTED"

pivateKey

string

write-only

Legacy misspelled Stripe private-key field.

Example:

"REDACTED"

publicKey

string

write-only

Stripe publishable key, Authorize.Net transaction key or PayPal client ID, depending on gateway.

Example:

"REDACTED"

privateKey

string

write-only

Authorize.Net API login or PayPal client secret, depending on gateway.

Example:

"REDACTED"

stripe_webhook_signing_secret

string

write-only

Stripe endpoint signing secret.

Example:

"REDACTED"

paypal_webhook_id

string

write-only

PayPal webhook identifier.

Example:

"REDACTED"

paypal

string

write-only

Presence enables saving PayPal. Empty public and private keys remove an existing row.

Example:

"REDACTED"

Qpaypro login; all three Qpaypro fields are needed to save.

Example:

"REDACTED"

x_api_secret

string

write-only

Qpaypro API secret.

Example:

"REDACTED"

x_private_key

string

write-only

Qpaypro private key.

Example:

"REDACTED"

Response

Operation result.

message

string

Example:

"Settings saved successfully."

Update direct payment gateway credentials

curl --request POST \
  --url https://api.gratona.com/v1/payment-gateways/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "stripe_gateway_id": 42,
  "id": 42,
  "paypal_gateway_id": 42,
  "qpay_gateway_id": 42,
  "stripe": "REDACTED",
  "pivateKey": "REDACTED",
  "publicKey": "REDACTED",
  "privateKey": "REDACTED",
  "stripe_webhook_signing_secret": "REDACTED",
  "paypal_webhook_id": "REDACTED",
  "paypal": "REDACTED",
  "x_login": "REDACTED",
  "x_api_secret": "REDACTED",
  "x_private_key": "REDACTED"
}
'

import requests

url = "https://api.gratona.com/v1/payment-gateways/{name}"

payload = {
    "stripe_gateway_id": 42,
    "id": 42,
    "paypal_gateway_id": 42,
    "qpay_gateway_id": 42,
    "stripe": "REDACTED",
    "pivateKey": "REDACTED",
    "publicKey": "REDACTED",
    "privateKey": "REDACTED",
    "stripe_webhook_signing_secret": "REDACTED",
    "paypal_webhook_id": "REDACTED",
    "paypal": "REDACTED",
    "x_login": "REDACTED",
    "x_api_secret": "REDACTED",
    "x_private_key": "REDACTED"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    stripe_gateway_id: 42,
    id: 42,
    paypal_gateway_id: 42,
    qpay_gateway_id: 42,
    stripe: 'REDACTED',
    pivateKey: 'REDACTED',
    publicKey: 'REDACTED',
    privateKey: 'REDACTED',
    stripe_webhook_signing_secret: 'REDACTED',
    paypal_webhook_id: 'REDACTED',
    paypal: 'REDACTED',
    x_login: 'REDACTED',
    x_api_secret: 'REDACTED',
    x_private_key: 'REDACTED'
  })
};

fetch('https://api.gratona.com/v1/payment-gateways/{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.gratona.com/v1/payment-gateways/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'stripe_gateway_id' => 42,
    'id' => 42,
    'paypal_gateway_id' => 42,
    'qpay_gateway_id' => 42,
    'stripe' => 'REDACTED',
    'pivateKey' => 'REDACTED',
    'publicKey' => 'REDACTED',
    'privateKey' => 'REDACTED',
    'stripe_webhook_signing_secret' => 'REDACTED',
    'paypal_webhook_id' => 'REDACTED',
    'paypal' => 'REDACTED',
    'x_login' => 'REDACTED',
    'x_api_secret' => 'REDACTED',
    'x_private_key' => 'REDACTED'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.gratona.com/v1/payment-gateways/{name}"

	payload := strings.NewReader("{\n  \"stripe_gateway_id\": 42,\n  \"id\": 42,\n  \"paypal_gateway_id\": 42,\n  \"qpay_gateway_id\": 42,\n  \"stripe\": \"REDACTED\",\n  \"pivateKey\": \"REDACTED\",\n  \"publicKey\": \"REDACTED\",\n  \"privateKey\": \"REDACTED\",\n  \"stripe_webhook_signing_secret\": \"REDACTED\",\n  \"paypal_webhook_id\": \"REDACTED\",\n  \"paypal\": \"REDACTED\",\n  \"x_login\": \"REDACTED\",\n  \"x_api_secret\": \"REDACTED\",\n  \"x_private_key\": \"REDACTED\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("https://api.gratona.com/v1/payment-gateways/{name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"stripe_gateway_id\": 42,\n  \"id\": 42,\n  \"paypal_gateway_id\": 42,\n  \"qpay_gateway_id\": 42,\n  \"stripe\": \"REDACTED\",\n  \"pivateKey\": \"REDACTED\",\n  \"publicKey\": \"REDACTED\",\n  \"privateKey\": \"REDACTED\",\n  \"stripe_webhook_signing_secret\": \"REDACTED\",\n  \"paypal_webhook_id\": \"REDACTED\",\n  \"paypal\": \"REDACTED\",\n  \"x_login\": \"REDACTED\",\n  \"x_api_secret\": \"REDACTED\",\n  \"x_private_key\": \"REDACTED\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/payment-gateways/{name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"stripe_gateway_id\": 42,\n  \"id\": 42,\n  \"paypal_gateway_id\": 42,\n  \"qpay_gateway_id\": 42,\n  \"stripe\": \"REDACTED\",\n  \"pivateKey\": \"REDACTED\",\n  \"publicKey\": \"REDACTED\",\n  \"privateKey\": \"REDACTED\",\n  \"stripe_webhook_signing_secret\": \"REDACTED\",\n  \"paypal_webhook_id\": \"REDACTED\",\n  \"paypal\": \"REDACTED\",\n  \"x_login\": \"REDACTED\",\n  \"x_api_secret\": \"REDACTED\",\n  \"x_private_key\": \"REDACTED\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Settings saved successfully."
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Not Found",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}