v50

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-169377194.1 KB

Gateway accounts

Search gateway accounts

get/v1/api/accounts

Query parameters

accountIdsstring

Comma separate list of gateway account IDs

Example:1,2

serviceIdsstring

Comma separated list of service external IDs

Example:46eb1b601348499196c99de90482ee68,service-external-id-2

moto_enabledstring

The accounts will be filtered by whether or not MOTO payment are enabled for the account if this parameter is provided. "true" or "false"

Example:true

apple_pay_enabledstring

The accounts will be filtered by whether or not Apple pay is enabled for the account if this parameter is provided. "true" or "false".

Example:true

google_pay_enabledstring

The accounts will be filtered by whether or not Google pay is enabled for the account if this parameter is provided. "true" or "false".

Example:true

requires_3dsstring

The accounts will be filtered by whether or not 3DS is required for the account if this parameter is provided. "true" or "false".

Example:true

typestring

The accounts will be filtered by type if this parameter is provided. "test" or "live".

Example:live

payment_providerstring

The accounts will be filtered by payment provider if this parameter is provided. One of "sandbox" or "worldpay", "smartpay", "epdq" or "stripe"

Example:live

payment_provider_account_idstring

Accounts will be filtered by payment provider account ID

Example:payment-provider-account-id

provider_switch_enabledstring

The accounts will be filtered by whether or not payment provider switch is enabled for the account if this parameter is provided. "true" or "false".

Example:true

recurring_enabledstring

The accounts will be filtered by whether or not recurring payments are enabled for the account when this parameter is provided.

Example:true

Response

Example response

{
  "accounts": [
    {
      "allow_apple_pay": true,
      "allow_authorisation_api": true,
      "allow_google_pay": true,
      "allow_zero_amount": true,
      "block_prepaid_cards": true,
      "corporate_credit_card_surcharge_amount": 250,
      "corporate_debit_card_surcharge_amount": 250,
      "description": "Account for service xxx",
      "disabled_reason": "No longer required",
      "email_notifications": {
        "PAYMENT_CONFIRMED": {
          "enabled": true,
          "template_body": null,
          "version": 1
        },
        "REFUND_ISSUED": {
          "enabled": true,
          "template_body": null,
          "version": 1
        }
      },
      "external_id": "fbf905a3f7ea416c8c252410eb45ddbd",
      "gateway_account_id": 1,
      "integration_version_3ds": 2,
      "live": true,
      "payment_provider": "sandbox",
      "recurring_enabled": true,
      "requires3ds": true,
      "send_payer_email_to_gateway": true,
      "send_payer_ip_address_to_gateway": true,
      "send_reference_to_gateway": true,
      "service_id": "cd1b871207a94a7fa157dee678146acd",
      "service_name": "service name",
      "type": "test",
      "worldpay_3ds_flex": {
        "exemption_engine_enabled": true,
        "issuer": "issuer",
        "organisational_unit_id": "org_unit_id"
      }
    }
  ]
}