Payment Gateway Settings

GET/api/v2/admin/payment-gateways#

Retrieves a payment gateways

Response

CountryCurrencyobject

Determines for which market they are applied.

PaymentGatewaySettingsobject

The payment gateway configuration bound to this currency-and-country market, including the chosen provider and its credentials.

PaymentFlowSettingsobject

Checkout flow behavior for this market's gateway, such as two-step card capture, immediate subscription access, and how the payment form is displayed.

curl "https://your-site.webinone.com/api/v2/admin/payment-gateways" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/payment-gateways", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/payment-gateways",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/payment-gateways', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/payment-gateways");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

[
  {
    "CountryCurrency": {
      "Hash": 0,
      "CurrencyId": "USD",
      "Currency": "USD",
      "CountryId": "string",
      "CountryAbbreviation": "string"
    },
    "PaymentGatewaySettings": {
      "CountryCurrency": {
        "Hash": 0,
        "CurrencyId": "USD",
        "Currency": "USD",
        "CountryId": "string",
        "CountryAbbreviation": "string"
      },
      "Id": "string",
      "Settings": "string",
      "Type": "stripe",
      "DisplayName": "Example"
    },
    "PaymentFlowSettings": {
      "CountryCurrency": {
        "Hash": 0,
        "CurrencyId": "USD",
        "Currency": "USD",
        "CountryId": "string",
        "CountryAbbreviation": "string"
      },
      "Id": "string",
      "Settings": "string",
      "Type": "stripe",
      "DisplayName": "Example"
    }
  }
]

PUT/api/v2/admin/payment-gateways#

Updates an existing payment gateway settings

Body parameters

CountryCurrencyobjectrequired

Determines for which market they are applied.

Typeenumrequired

Provider name. Possible values: stripe, eway, paypal, bamboraEU, authorizeNet, paypalFlow, stripeElements, braintree.Possible values: stripeewaypaypalbamboraEUauthorizeNetpaypalFlowstripeElementsbraintree

Settingsobjectrequired

Technical keys and logic.

ApiKeystring · nullable

Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions.

ApiSecretstring · nullable

Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions.

ClientKeystring · nullable

Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions.

SignatureKeystring · nullable

Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions.

HashKeystring · nullable

Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions.

MerchantNumberstring · nullable

Your unique ID in the payment gateway system.

CurrencyIdstring · nullable

Internal system identifier of the country in the database.

Currencystring · nullable

Currency code (e.g. USD).

Imagestring · nullable

A link to your brand logo that will be displayed on the payment page.

WebhooksTokenstring · nullable

Secret token for validating incoming messages (Webhooks) from the gateway about successful payment.

Passwordstring · nullable

Additional password if the gateway requires Basic Auth or specific authorization.

Appearancestring · nullable

JSON string or theme name for design customization (button colors, fonts).

Endpointenum

Gateway operating mode. Possible values: Production, Sandbox.Possible values: ProductionSandbox

TwoStepCardPaymentsboolean

With this option enabled, the customer's card payment, at time of form submission, is authorised only and the funds will be captured later, after a second step has been completed - such as processing the payment from the Order details pages in the WebinOne admin once the purchase has been delivered, for example.

GiveAccessForSubscriptionImmediatelyboolean

Allows the client to use the service immediately after creating a subscription, without waiting for final confirmation from the bank.

CheckoutIntegrationenum

Payment display method. Possible values: Redirect, Modal, Inline.Possible values: RedirectModalInline

ShowSuccessPageboolean

Whether to show the default gateway successful payment page after the transaction is complete.

Languagestring · nullable

The language of the payment page interface for the customer.

Response

CountryCurrencyobject

Determines for which market they are applied.

Idstring · nullable

Unique identifier. Technical record number in the database. Read-only.

Settingsobject · nullable

Configuration options for this resource.

Typeenum

Provider name. Possible values: stripe, eway, paypal, bamboraEU, authorizeNet, paypalFlow, stripeElements, braintree.Possible values: stripeewaypaypalbamboraEUauthorizeNetpaypalFlowstripeElementsbraintree

DisplayNamestring · nullable

The name of the payment method that the customer sees at checkout.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/payment-gateways" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"CountryCurrency":{"Hash":0,"CurrencyId":"USD","Currency":"USD","CountryId":"string","CountryAbbreviation":"string"},"Type":"stripe","Settings":{"ApiKey":"string","ApiSecret":"string","ClientKey":"string","SignatureKey":"string","HashKey":"string","MerchantNumber":"string","CurrencyId":"USD","Currency":"USD","Image":"string","WebhooksToken":"string","Password":"string","Appearance":"string","Endpoint":"Production","TwoStepCardPayments":false,"GiveAccessForSubscriptionImmediately":false,"CheckoutIntegration":"Redirect","ShowSuccessPage":false,"Language":"string"}}'

await fetch("https://your-site.webinone.com/api/v2/admin/payment-gateways", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "CountryCurrency": {
      "Hash": 0,
      "CurrencyId": "USD",
      "Currency": "USD",
      "CountryId": "string",
      "CountryAbbreviation": "string"
    },
    "Type": "stripe",
    "Settings": {
      "ApiKey": "string",
      "ApiSecret": "string",
      "ClientKey": "string",
      "SignatureKey": "string",
      "HashKey": "string",
      "MerchantNumber": "string",
      "CurrencyId": "USD",
      "Currency": "USD",
      "Image": "string",
      "WebhooksToken": "string",
      "Password": "string",
      "Appearance": "string",
      "Endpoint": "Production",
      "TwoStepCardPayments": false,
      "GiveAccessForSubscriptionImmediately": false,
      "CheckoutIntegration": "Redirect",
      "ShowSuccessPage": false,
      "Language": "string"
    }
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/payment-gateways",
    headers={"Authorization": "Bearer <token>"},
    json={
        "CountryCurrency": {
            "Hash": 0,
            "CurrencyId": "USD",
            "Currency": "USD",
            "CountryId": "string",
            "CountryAbbreviation": "string"
        },
        "Type": "stripe",
        "Settings": {
            "ApiKey": "string",
            "ApiSecret": "string",
            "ClientKey": "string",
            "SignatureKey": "string",
            "HashKey": "string",
            "MerchantNumber": "string",
            "CurrencyId": "USD",
            "Currency": "USD",
            "Image": "string",
            "WebhooksToken": "string",
            "Password": "string",
            "Appearance": "string",
            "Endpoint": "Production",
            "TwoStepCardPayments": False,
            "GiveAccessForSubscriptionImmediately": False,
            "CheckoutIntegration": "Redirect",
            "ShowSuccessPage": False,
            "Language": "string"
        }
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/payment-gateways', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'CountryCurrency' => [
            'Hash' => 0,
            'CurrencyId' => 'USD',
            'Currency' => 'USD',
            'CountryId' => 'string',
            'CountryAbbreviation' => 'string'
        ],
        'Type' => 'stripe',
        'Settings' => [
            'ApiKey' => 'string',
            'ApiSecret' => 'string',
            'ClientKey' => 'string',
            'SignatureKey' => 'string',
            'HashKey' => 'string',
            'MerchantNumber' => 'string',
            'CurrencyId' => 'USD',
            'Currency' => 'USD',
            'Image' => 'string',
            'WebhooksToken' => 'string',
            'Password' => 'string',
            'Appearance' => 'string',
            'Endpoint' => 'Production',
            'TwoStepCardPayments' => false,
            'GiveAccessForSubscriptionImmediately' => false,
            'CheckoutIntegration' => 'Redirect',
            'ShowSuccessPage' => false,
            'Language' => 'string'
        ]
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/payment-gateways");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"CountryCurrency\":{\"Hash\":0,\"CurrencyId\":\"USD\",\"Currency\":\"USD\",\"CountryId\":\"string\",\"CountryAbbreviation\":\"string\"},\"Type\":\"stripe\",\"Settings\":{\"ApiKey\":\"string\",\"ApiSecret\":\"string\",\"ClientKey\":\"string\",\"SignatureKey\":\"string\",\"HashKey\":\"string\",\"MerchantNumber\":\"string\",\"CurrencyId\":\"USD\",\"Currency\":\"USD\",\"Image\":\"string\",\"WebhooksToken\":\"string\",\"Password\":\"string\",\"Appearance\":\"string\",\"Endpoint\":\"Production\",\"TwoStepCardPayments\":false,\"GiveAccessForSubscriptionImmediately\":false,\"CheckoutIntegration\":\"Redirect\",\"ShowSuccessPage\":false,\"Language\":\"string\"}}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "CountryCurrency": {
    "Hash": 0,
    "CurrencyId": "USD",
    "Currency": "USD",
    "CountryId": "string",
    "CountryAbbreviation": "string"
  },
  "Id": "string",
  "Settings": "string",
  "Type": "stripe",
  "DisplayName": "Example"
}

DELETE/api/v2/admin/payment-gateways/{paymentGatewayId}#

Deletes an existing payment gateway settings

Parameters

paymentGatewayIdstring · pathrequired

Resource identifier.

curl -X DELETE "https://your-site.webinone.com/api/v2/admin/payment-gateways/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/payment-gateways/1", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.delete(
    "https://your-site.webinone.com/api/v2/admin/payment-gateways/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/payment-gateways/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/payment-gateways/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

PUT/api/v2/admin/payment-gateways/flow#

Updates an existing payment flow settings

Body parameters

CountryCurrencyobjectrequired

Determines for which market they are applied.

Typeenumrequired

Provider name. Possible values: stripe, eway, paypal, bamboraEU, authorizeNet, paypalFlow, stripeElements, braintree.Possible values: stripeewaypaypalbamboraEUauthorizeNetpaypalFlowstripeElementsbraintree

Settingsobjectrequired

Technical keys and logic.

ApiKeystring · nullable

Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions.

ApiSecretstring · nullable

Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions.

ClientKeystring · nullable

Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions.

SignatureKeystring · nullable

Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions.

HashKeystring · nullable

Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions.

MerchantNumberstring · nullable

Your unique ID in the payment gateway system.

CurrencyIdstring · nullable

Internal system identifier of the country in the database.

Currencystring · nullable

Currency code (e.g. USD).

Imagestring · nullable

A link to your brand logo that will be displayed on the payment page.

WebhooksTokenstring · nullable

Secret token for validating incoming messages (Webhooks) from the gateway about successful payment.

Passwordstring · nullable

Additional password if the gateway requires Basic Auth or specific authorization.

Appearancestring · nullable

JSON string or theme name for design customization (button colors, fonts).

Endpointenum

Gateway operating mode. Possible values: Production, Sandbox.Possible values: ProductionSandbox

TwoStepCardPaymentsboolean

With this option enabled, the customer's card payment, at time of form submission, is authorised only and the funds will be captured later, after a second step has been completed - such as processing the payment from the Order details pages in the WebinOne admin once the purchase has been delivered, for example.

GiveAccessForSubscriptionImmediatelyboolean

Allows the client to use the service immediately after creating a subscription, without waiting for final confirmation from the bank.

CheckoutIntegrationenum

Payment display method. Possible values: Redirect, Modal, Inline.Possible values: RedirectModalInline

ShowSuccessPageboolean

Whether to show the default gateway successful payment page after the transaction is complete.

Languagestring · nullable

The language of the payment page interface for the customer.

Response

CountryCurrencyobject

Determines for which market they are applied.

Idstring · nullable

Unique identifier. Technical record number in the database. Read-only.

Settingsobject · nullable

Configuration options for this resource.

Typeenum

Provider name. Possible values: stripe, eway, paypal, bamboraEU, authorizeNet, paypalFlow, stripeElements, braintree.Possible values: stripeewaypaypalbamboraEUauthorizeNetpaypalFlowstripeElementsbraintree

DisplayNamestring · nullable

The name of the payment method that the customer sees at checkout.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/payment-gateways/flow" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"CountryCurrency":{"Hash":0,"CurrencyId":"USD","Currency":"USD","CountryId":"string","CountryAbbreviation":"string"},"Type":"stripe","Settings":{"ApiKey":"string","ApiSecret":"string","ClientKey":"string","SignatureKey":"string","HashKey":"string","MerchantNumber":"string","CurrencyId":"USD","Currency":"USD","Image":"string","WebhooksToken":"string","Password":"string","Appearance":"string","Endpoint":"Production","TwoStepCardPayments":false,"GiveAccessForSubscriptionImmediately":false,"CheckoutIntegration":"Redirect","ShowSuccessPage":false,"Language":"string"}}'

await fetch("https://your-site.webinone.com/api/v2/admin/payment-gateways/flow", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "CountryCurrency": {
      "Hash": 0,
      "CurrencyId": "USD",
      "Currency": "USD",
      "CountryId": "string",
      "CountryAbbreviation": "string"
    },
    "Type": "stripe",
    "Settings": {
      "ApiKey": "string",
      "ApiSecret": "string",
      "ClientKey": "string",
      "SignatureKey": "string",
      "HashKey": "string",
      "MerchantNumber": "string",
      "CurrencyId": "USD",
      "Currency": "USD",
      "Image": "string",
      "WebhooksToken": "string",
      "Password": "string",
      "Appearance": "string",
      "Endpoint": "Production",
      "TwoStepCardPayments": false,
      "GiveAccessForSubscriptionImmediately": false,
      "CheckoutIntegration": "Redirect",
      "ShowSuccessPage": false,
      "Language": "string"
    }
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/payment-gateways/flow",
    headers={"Authorization": "Bearer <token>"},
    json={
        "CountryCurrency": {
            "Hash": 0,
            "CurrencyId": "USD",
            "Currency": "USD",
            "CountryId": "string",
            "CountryAbbreviation": "string"
        },
        "Type": "stripe",
        "Settings": {
            "ApiKey": "string",
            "ApiSecret": "string",
            "ClientKey": "string",
            "SignatureKey": "string",
            "HashKey": "string",
            "MerchantNumber": "string",
            "CurrencyId": "USD",
            "Currency": "USD",
            "Image": "string",
            "WebhooksToken": "string",
            "Password": "string",
            "Appearance": "string",
            "Endpoint": "Production",
            "TwoStepCardPayments": False,
            "GiveAccessForSubscriptionImmediately": False,
            "CheckoutIntegration": "Redirect",
            "ShowSuccessPage": False,
            "Language": "string"
        }
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/payment-gateways/flow', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'CountryCurrency' => [
            'Hash' => 0,
            'CurrencyId' => 'USD',
            'Currency' => 'USD',
            'CountryId' => 'string',
            'CountryAbbreviation' => 'string'
        ],
        'Type' => 'stripe',
        'Settings' => [
            'ApiKey' => 'string',
            'ApiSecret' => 'string',
            'ClientKey' => 'string',
            'SignatureKey' => 'string',
            'HashKey' => 'string',
            'MerchantNumber' => 'string',
            'CurrencyId' => 'USD',
            'Currency' => 'USD',
            'Image' => 'string',
            'WebhooksToken' => 'string',
            'Password' => 'string',
            'Appearance' => 'string',
            'Endpoint' => 'Production',
            'TwoStepCardPayments' => false,
            'GiveAccessForSubscriptionImmediately' => false,
            'CheckoutIntegration' => 'Redirect',
            'ShowSuccessPage' => false,
            'Language' => 'string'
        ]
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/payment-gateways/flow");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"CountryCurrency\":{\"Hash\":0,\"CurrencyId\":\"USD\",\"Currency\":\"USD\",\"CountryId\":\"string\",\"CountryAbbreviation\":\"string\"},\"Type\":\"stripe\",\"Settings\":{\"ApiKey\":\"string\",\"ApiSecret\":\"string\",\"ClientKey\":\"string\",\"SignatureKey\":\"string\",\"HashKey\":\"string\",\"MerchantNumber\":\"string\",\"CurrencyId\":\"USD\",\"Currency\":\"USD\",\"Image\":\"string\",\"WebhooksToken\":\"string\",\"Password\":\"string\",\"Appearance\":\"string\",\"Endpoint\":\"Production\",\"TwoStepCardPayments\":false,\"GiveAccessForSubscriptionImmediately\":false,\"CheckoutIntegration\":\"Redirect\",\"ShowSuccessPage\":false,\"Language\":\"string\"}}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "CountryCurrency": {
    "Hash": 0,
    "CurrencyId": "USD",
    "Currency": "USD",
    "CountryId": "string",
    "CountryAbbreviation": "string"
  },
  "Id": "string",
  "Settings": "string",
  "Type": "stripe",
  "DisplayName": "Example"
}

DELETE/api/v2/admin/payment-gateways/flow/{paymentFlowSettingsId}#

Deletes an existing payment flow settings

Parameters

paymentFlowSettingsIdstring · pathrequired

Resource identifier.

curl -X DELETE "https://your-site.webinone.com/api/v2/admin/payment-gateways/flow/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/payment-gateways/flow/1", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.delete(
    "https://your-site.webinone.com/api/v2/admin/payment-gateways/flow/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/payment-gateways/flow/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/payment-gateways/flow/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

GET/api/v2/admin/payment-gateways/payment-providers-settings#

Retrieves a payment gateway settings

Response

PaymentGatewaysarray of objects

The currency-and-country markets that have a payment gateway configured.

PaymentTypesarray of objects

The available payment provider types, each paired with its display name.

Endpointsarray of strings

The gateway operating modes available for selection, such as Production and Sandbox.

BamboraLanguagearray of objects

The interface languages supported by the Bambora gateway payment page, each paired with its display name.

CheckoutIntegrationsarray of strings

The available payment-form display methods, such as Redirect, Modal, and Inline.

curl "https://your-site.webinone.com/api/v2/admin/payment-gateways/payment-providers-settings" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/payment-gateways/payment-providers-settings", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/payment-gateways/payment-providers-settings",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/payment-gateways/payment-providers-settings', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/payment-gateways/payment-providers-settings");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "PaymentGateways": [
    {
      "Hash": 0,
      "CurrencyId": "USD",
      "Currency": "USD",
      "CountryId": "string",
      "CountryAbbreviation": "string"
    }
  ],
  "PaymentTypes": [
    {
      "Item1": "string",
      "Item2": "string"
    }
  ],
  "Endpoints": [
    "string"
  ],
  "BamboraLanguage": [
    {
      "Item1": "string",
      "Item2": "string"
    }
  ],
  "CheckoutIntegrations": [
    "string"
  ]
}