Sign in
Gateway accounts

Create a new gateway account

post/v1/api/accounts

Query parameters

degatewayificationboolean

Request body

allow_apple_payboolean

Set to 'true' to enable Apple Pay for this account

allow_google_payboolean

Set to 'true' to enable Google Pay for this account

analytics_idstring

Google Analytics (GA) unique ID for the GOV.UK Pay platform

descriptionstring

Some useful non-ambiguous description about the gateway account

payment_providerstring

The payment provider for which this account is created

requires_3dsboolean

Set to 'true' to enable 3DS for this account

send_payer_email_to_gatewayboolean

Set to 'true' to enable send payer's email for this account

send_payer_ip_address_to_gatewayboolean

Set to 'true' to enable send payer's IP address for this account

service_idstring
service_namestring
typestring

Account type for this provider (test/live)

Example request

{
  "analytics_id": "analytics-id",
  "description": "account for some gov org",
  "payment_provider": "stripe",
  "service_id": "service-external-id",
  "service_name": "service name",
  "type": "live"
}

Response

Created

analytics_idstring
descriptionstring
external_idstring
gateway_account_idstring
linksobject[]
requires_3dsboolean
send_payer_email_to_gatewayboolean
send_payer_ip_address_to_gatewayboolean
service_namestring
typestring

Example response

{
  "analytics_id": "ananytics-id",
  "description": "account for some gov org",
  "external_id": "ab2c296ed98647e9a25f045f5e6e87a2",
  "gateway_account_id": "2",
  "links": [
    {
      "href": "https://connector.url/v1/api/accounts/2",
      "method": "GET",
      "rel": "self"
    }
  ],
  "requires_3ds": true,
  "send_payer_email_to_gateway": true,
  "send_payer_ip_address_to_gateway": true,
  "service_name": "service name",
  "type": "live"
}

Changes

Changed in 3 of the 59 revisions of this API.24

  • 87479b0d193b4See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • c12941ae518b1See the full diff
    • ●

      added the new AMOUNT_BELOW_MINIMUM enum value to the response property for the response status

      response-property-enum-value-added

  • 414b11cd97c01See the full diff
    • ●

      added the new NON_HTTPS_RETURN_URL_NOT_ALLOWED_FOR_A_LIVE_ACCOUNT enum value to the response property for the response status

      response-property-enum-value-added