Sign in

v50

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

Find gateway account by gateway account external ID

Get gateway account by external ID. Also returns notifications credentials, gateway account credentials (without password)

get/v1/frontend/accounts/external-id/{externalId}

Path parameters

externalIdstring required

Response

OK

_linksobject
allow_apple_payboolean

Set to true to enable Apple Pay

allow_authorisation_apiboolean

Flag to indicate whether the account is allowed to initiate MOTO payments that are authorised via an API request rather than the web interface

allow_google_payboolean

Set to true to enable Google Pay

allow_motoboolean

Indicates whether the Mail Order and Telephone Order (MOTO) payments are allowed

allow_telephone_payment_notificationsboolean

Indicates if the account is used for telephone payments reporting

allow_zero_amountboolean

Set to true to support charges with a zero amount

analytics_idstring

An identifier used to identify the service in Google Analytics. The default value is null

block_prepaid_cardsboolean

Whether pre-paid cards are allowed as a payment method for this gateway account

corporate_credit_card_surcharge_amountinteger

A corporate credit card surcharge amount in pence

corporate_debit_card_surcharge_amountinteger

A corporate debit card surcharge amount in pence

corporate_prepaid_debit_card_surcharge_amountinteger

A corporate prepaid debit card surcharge amount in pence

descriptionstring

An internal description to identify the gateway account. The default value is null.

disabledboolean

Flag to indicate whether the account is allowed to take payments and make refunds

disabled_reasonstring

The reason the account is disabled, if applicable

email_collection_mode'MANDATORY' | 'OPTIONAL' | 'OFF'

Whether email address is required from paying users. Can be MANDATORY, OPTIONAL or OFF

email_notificationsobject

The settings for the different emails (payments/refunds) that are sent out

external_idstring

External ID for the gateway account

gateway_account_idinteger

The account ID

integration_version_3dsinteger

3DS version used for payments for the gateway account

liveboolean

Whether the account is live

moto_mask_card_number_inputboolean

Indicates whether the card number is masked when being input for MOTO payments. The default value is false.

moto_mask_card_security_code_inputboolean

Indicates whether the card security code is masked when being input for MOTO payments.

notifySettingsobject

An object containing the Notify credentials and configuration for sending custom branded emails

payment_providerstring

The payment provider for which this account is created

provider_switch_enabledboolean

Flag to enable payment provider switching

recurring_enabledboolean

Flag to indicate whether the account is allowed to take recurring card payments

requires3dsboolean

Flag to indicate whether 3DS is enabled

send_payer_email_to_gatewayboolean

If enabled, user email address is included in the authorisation request to gateway

send_payer_ip_address_to_gatewayboolean

If enabled, user IP address is sent to to gateway

send_reference_to_gatewayboolean

If enabled, service payment reference is sent to gateway as description. Otherwise payment description is sent to the gateway. Only applicable for Worldpay accounts. Default value is 'false'

service_idstring

Service external ID

service_namestring

The service name for the account

typestring

Account type for the payment provider (test/live)

Example response

{
  "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_credentials": [
    {
      "active_start_date": "2022-06-28T16:40:56.869Z",
      "created_date": "2022-06-30T15:44:19.323Z",
      "external_id": "787460d16d4a4d14b4c94787b8f427db",
      "gateway_account_credential_id": 1,
      "gateway_account_id": 1,
      "last_updated_by_user_external_id": "vdwke0d16d4a4d14b4c94787b8f427d",
      "payment_provider": "stripe",
      "state": "ACTIVE"
    }
  ],
  "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"
  }
}