--- title: "Find gateway account by gateway account external ID" method: GET path: "/v1/frontend/accounts/external-id/{externalId}" tags: ["Gateway accounts"] --- # Find gateway account by gateway account external ID `GET /v1/frontend/accounts/external-id/{externalId}` ## Request - The document declares no server URL. - Auth: none declared Get gateway account by external ID. Also returns notifications credentials, gateway account credentials (without password) ## Path parameters - `externalId` string, required ## Response `200` OK - GatewayAccountWithCredentialsWithInternalIdResponse - `_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_credentials` GatewayAccountCredentialsWithInternalId[]: Array of the credentials configured for this account - `active_end_date` string, date-time - `active_start_date` string, date-time - `created_date` string, date-time - `credentials` union - object - `gateway_merchant_id` string - `one_off_customer_initiated` WorldpayMerchantCodeCredentials - `merchant_code` string - `username` string - `recurring_customer_initiated` WorldpayMerchantCodeCredentials - `merchant_code` string - `username` string - `recurring_merchant_initiated` WorldpayMerchantCodeCredentials - `merchant_code` string - `username` string - object - `stripe_account_id` string - object - `merchant_id` string - `username` string - `external_id` string - `gateway_account_credential_id` integer - `gateway_account_id` integer - `last_updated_by_user_external_id` string: User external ID - `payment_provider` string - `state` 'CREATED' | 'ENTERED' | 'VERIFIED_WITH_LIVE_PAYMENT' | 'ACTIVE' | 'RETIRED' - `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. - `notifySettings` object: An object containing the Notify credentials and configuration for sending custom branded emails - `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 ## Other responses - `404`: Not found ## Changes - **2025-05-27** `33a2b0cf2f1e`: 1 warning - removed the optional property `notificationCredentials` from the response with the `200` status - **2024-08-14** `a3f78c6e1300`: 1 warning, 1 info - removed the optional property `worldpay_3ds_flex/corporate_exemption_enabled` from the response with the `200` status - added the optional property `worldpay_3ds_flex/corporate_exemptions_enabled` to the response with the `200` status - **2024-08-14** `d7f8ec22b852`: 1 info - added the optional property `worldpay_3ds_flex/corporate_exemption_enabled` to the response with the `200` status [Operation history](https://skmtc.dev/government-digital-service/apis/connector-api/changes/v1/frontend/accounts/external-id/:externalId/get.md) --- [API](https://skmtc.dev/government-digital-service/apis/connector-api.md) - [All operations](https://skmtc.dev/government-digital-service/apis/connector-api/llms.txt) - [OpenAPI document](https://skmtc.dev/government-digital-service/apis/connector-api/revisions/7f294e492d3c?raw)