RECENT UPDATES:
05-Jun-2026 | v7.10.7 | All new article

Change Log

  • 05-Jun-2026 | v7.10.7 | All new article

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

Payment Gateways API

Retrieve, Update and Delete Payment Gateway Settings via the public API endpoint, as well as retrieve available Payment Provider Settings and manage Payment Flow Settings.

GET Payment Gateway Settings List

Retrieves a list of Payment Gateway Settings as a JSON response based on your provided query parameters.

/api/v2/admin/payment-gateways

Data / Response:

N/A

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

PUT Payment Gateway Settings Update

Updates a single Payment Gateway Settings record based on the data provided.

/api/v2/admin/payment-gateways

Data / Response:

{
  "CountryCurrency": {
    "Hash": 0,
    "CurrencyId": "string",
    "Currency": "string",
    "CountryId": "string",
    "CountryAbbreviation": "string"
  },
  "Type": "stripe",
  "Settings": {
    "ApiKey": "string",
    "ApiSecret": "string",
    "ClientKey": "string",
    "SignatureKey": "string",
    "HashKey": "string",
    "MerchantNumber": "string",
    "CurrencyId": "string",
    "Currency": "string",
    "Image": "string",
    "WebhooksToken": "string",
    "Password": "string",
    "Appearance": "string",
    "Endpoint": "Production",
    "TwoStepCardPayments": true,
    "GiveAccessForSubscriptionImmediately": true,
    "CheckoutIntegration": "Redirect",
    "ShowSuccessPage": true,
    "Language": "string"
  }
}

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

DELETE Payment Gateway Settings Delete

Deletes a single Payment Gateway Settings record based on the ID passed in the endpoint URL.

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

Data / Response:

N/A

Status 204

GET Payment Gateway Settings Payment Providers Settings List

Retrieves a list of Payment Gateway Setting's available Payment Providers Settings as a JSON response, including supported gateways, payment types, endpoints, and checkout integrations.

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

Data / Response:

N/A

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

PUT Payment Gateway Settings Flow Update

Updates a single Payment Gateway Setting's Flow Settings based on the data provided.

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

Data / Response:

{
  "CountryCurrency": {
    "Hash": 0,
    "CurrencyId": "string",
    "Currency": "string",
    "CountryId": "string",
    "CountryAbbreviation": "string"
  },
  "Type": "stripe",
  "Settings": {
    "ApiKey": "string",
    "ApiSecret": "string",
    "ClientKey": "string",
    "SignatureKey": "string",
    "HashKey": "string",
    "MerchantNumber": "string",
    "CurrencyId": "string",
    "Currency": "string",
    "Image": "string",
    "WebhooksToken": "string",
    "Password": "string",
    "Appearance": "string",
    "Endpoint": "Production",
    "TwoStepCardPayments": true,
    "GiveAccessForSubscriptionImmediately": true,
    "CheckoutIntegration": "Redirect",
    "ShowSuccessPage": true,
    "Language": "string"
  }
}

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

DELETE Payment Gateway Settings Flow Delete

Deletes a single Payment Gateway Setting's Flow Settings record based on the ID passed in the endpoint URL.

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

Data / Response:

N/A

Status 204