---
title: "Create a new gateway account"
method: POST
path: "/v1/api/accounts"
tags: ["Gateway accounts"]
---

# Create a new gateway account

`POST /v1/api/accounts`

## Query parameters

- `degatewayification` boolean

## Request body

- GatewayAccountRequest
  - `allow_apple_pay` boolean — Set to 'true' to enable Apple Pay for this account
  - `allow_google_pay` boolean — Set to 'true' to enable Google Pay for this account
  - `analytics_id` string — Google Analytics (GA) unique ID for the GOV.UK Pay platform
  - `description` string — Some useful non-ambiguous description about the gateway account
  - `payment_provider` string — The payment provider for which this account is created
  - `requires_3ds` boolean — Set to 'true' to enable 3DS for this account
  - `send_payer_email_to_gateway` boolean — Set to 'true' to enable send payer's email for this account
  - `send_payer_ip_address_to_gateway` boolean — Set to 'true' to enable send payer's IP address for this account
  - `service_id` string
  - `service_name` string
  - `type` string — Account type for this provider (test/live)

## Response `201`

Created

- CreateGatewayAccountResponse
  - `analytics_id` string
  - `description` string
  - `external_id` string
  - `gateway_account_id` string
  - `links` object[]
  - `requires_3ds` boolean
  - `send_payer_email_to_gateway` boolean
  - `send_payer_ip_address_to_gateway` boolean
  - `service_name` string
  - `type` string

## Other responses

- `422` — Missing required fields or invalid values

## Changes

- **2025-07-08** `87479b0d193b` — 4 info
  - added the new optional request property `send_payer_email_to_gateway`
  - added the new optional request property `send_payer_ip_address_to_gateway`
  - added the optional property `send_payer_email_to_gateway` to the response with the `201` status
  - added the optional property `send_payer_ip_address_to_gateway` to the response with the `201` status
- **2025-01-16** `c12941ae518b` — 1 warning
  - added the new `AMOUNT_BELOW_MINIMUM` enum value to the `error_identifier` response property for the response status `422`
- **2024-11-25** `414b11cd97c0` — 1 warning
  - added the new `NON_HTTPS_RETURN_URL_NOT_ALLOWED_FOR_A_LIVE_ACCOUNT` enum value to the `error_identifier` response property for the response status `422`

[Change history](https://skmtc.dev/government-digital-service/apis/connector-api/changes/v1/api/accounts/post.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-service-production.skmtc.workers.dev/v1/apis/government-digital-service/connector-api/revisions/1e19a94c93a9/schema)