---
title: "Search gateway accounts"
method: GET
path: "/v1/api/accounts"
tags: ["Gateway accounts"]
---

# Search gateway accounts

`GET /v1/api/accounts`

## Query parameters

- `accountIds` string — Comma separate list of gateway account IDs
- `serviceIds` string — Comma separated list of service external IDs
- `moto_enabled` string — The accounts will be filtered by whether or not MOTO payment are enabled for the account if this parameter is provided. "true" or "false"
- `apple_pay_enabled` string — The accounts will be filtered by whether or not Apple pay is enabled for the account if this parameter is provided. "true" or "false".
- `google_pay_enabled` string — The accounts will be filtered by whether or not Google pay is enabled for the account if this parameter is provided. "true" or "false".
- `requires_3ds` string — The accounts will be filtered by whether or not 3DS is required for the account if this parameter is provided. "true" or "false".
- `type` string — The accounts will be filtered by type if this parameter is provided. "test" or "live".
- `payment_provider` string — The accounts will be filtered by payment provider if this parameter is provided. One of "sandbox" or "worldpay", "smartpay", "epdq" or "stripe"
- `payment_provider_account_id` string — Accounts will be filtered by payment provider account ID
- `provider_switch_enabled` string — 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".
- `recurring_enabled` string — The accounts will be filtered by whether or not recurring payments are enabled for the account when this parameter is provided.

## Response `200`

OK

- GatewayAccountsListDTO
  - `accounts` GatewayAccountResponse[]
    - `_links` object
    - `allow_apple_pay` boolean — Set to true to enable Apple Pay
    - `allow_authorisation_api` boolean — 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_pay` boolean — Set to true to enable Google Pay
    - `allow_moto` boolean — Indicates whether the Mail Order and Telephone Order (MOTO) payments are allowed
    - `allow_telephone_payment_notifications` boolean — Indicates if the account is used for telephone payments reporting
    - `allow_zero_amount` boolean — Set to true to support charges with a zero amount
    - `analytics_id` string — An identifier used to identify the service in Google Analytics. The default value is null
    - `block_prepaid_cards` boolean — Whether pre-paid cards are allowed as a payment method for this gateway account
    - `corporate_credit_card_surcharge_amount` integer — A corporate credit card surcharge amount in pence
    - `corporate_debit_card_surcharge_amount` integer — A corporate debit card surcharge amount in pence
    - `corporate_prepaid_debit_card_surcharge_amount` integer — A corporate prepaid debit card surcharge amount in pence
    - `description` string — An internal description to identify the gateway account. The default value is null.
    - `disabled` boolean — Flag to indicate whether the account is allowed to take payments and make refunds
    - `disabled_reason` string — 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_notifications` object — The settings for the different emails (payments/refunds) that are sent out
    - `external_id` string — External ID for the gateway account
    - `gateway_account_id` integer — The account ID
    - `integration_version_3ds` integer — 3DS version used for payments for the gateway account
    - `live` boolean — Whether the account is live
    - `moto_mask_card_number_input` boolean — Indicates whether the card number is masked when being input for MOTO payments. The default value is false.
    - `moto_mask_card_security_code_input` boolean — Indicates whether the card security code is masked when being input for MOTO payments.
    - `payment_provider` string — The payment provider for which this account is created
    - `provider_switch_enabled` boolean — Flag to enable payment provider switching
    - `recurring_enabled` boolean — Flag to indicate whether the account is allowed to take recurring card payments
    - `requires3ds` boolean — Flag to indicate whether 3DS is enabled
    - `send_payer_email_to_gateway` boolean — If enabled, user email address is included in the authorisation request to gateway
    - `send_payer_ip_address_to_gateway` boolean — If enabled, user IP address is sent to to gateway
    - `send_reference_to_gateway` boolean — 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_id` string — Service external ID
    - `service_name` string — The service name for the account
    - `type` string — Account type for the payment provider (test/live)
    - `worldpay_3ds_flex` Worldpay3dsFlexCredentials
      - `corporate_exemptions_enabled` boolean
      - `exemption_engine_enabled` boolean
      - `issuer` string
      - `organisational_unit_id` string

---

[API](https://skmtc.net/government-digital-service/apis/connector-api.md) · [All operations](https://skmtc.net/government-digital-service/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/government-digital-service/connector-api/versions/62149e57992f/schema)