---
title: "Notify the customer"
method: POST
path: "/billing_requests/{billing_request_id}/actions/notify"
tags: ["Billing Request"]
---

# Notify the customer

`POST /billing_requests/{billing_request_id}/actions/notify`

## Request

- Base URL: `https://api.gocardless.com`
- URL: `https://api.gocardless.com/billing_requests/{billing_request_id}/actions/notify`
- Auth: HTTP bearer

Notifies the customer linked to the billing request, asking them to authorise it.
Currently, the customer can only be notified by email.

This endpoint is currently supported only for Pay by Bank Billing Requests.

## Path parameters

- `billing_request_id` string, required

## Headers

- `GoCardless-Version` string, required

## Request body

- object
  - `billing_requests` object
    - `notification_type` 'email', required: Currently, can only be `email`.
    - `redirect_uri` string: URL that the payer can be redirected to after authorising the payment.

## Response `200`

Action completed successfully

- BillingRequestSingleResourceResponse
  - `billing_requests` BillingRequest: Billing Requests help create resources that require input or action from a customer. An example of required input might be additional customer billing details, while an action would be asking a customer to authorise a payment using their mobile banking app. See [Billing Requests: Overview](https://docs.gocardless.com/docs/collect-payments/setting-up-mandates) for how-to's, explanations and tutorials. <p class="notice"><strong>Important</strong>: All properties associated with `subscription_request` and `instalment_schedule_request` are only supported for ACH and PAD schemes.</p>
    - `id` string, required: Unique identifier, beginning with "BRQ".
    - `purpose_code` 'mortgage' | 'utility' | 'loan' | 'dependant_support' | 'gambling' | 'retail' | 'salary' | 'personal' | 'government' | 'pension' | 'tax' | 'other' | 'bonus_payment' | 'cash_management_transfer' | 'card_bulk_clearing' | 'credit_card_payment' | 'trade_settlement_payment' | 'debit_card_payment' | 'dividend' | 'deliver_against_payment' | 'epayment' | 'fee_collection_and_interest' | 'fee_collection' | 'person_to_person_payment' | 'government_payment' | 'hedging_transaction' | 'irrevocable_credit_card_payment' | 'irrevocable_debit_card_payment' | 'intra_company_payment' | 'interest' | 'lockbox_transactions' | 'commercial' | 'consumer' | 'other_payment' | 'pension_payment' | 'represented' | 'reimbursement_received_credit_transfer' | 'receive_against_payment' | 'salary_payment' | 'securities' | 'social_security_benefit' | 'supplier_payment' | 'tax_payment' | 'trade' | 'treasury_payment' | 'value_added_tax_payment' | 'with_holding' | 'cash_management_sweep_account' | 'cash_management_top_account' | 'cash_management_zero_balance_account' | 'crossborder_mi_payments' | 'foreign_currency_domestic_transfer' | 'cash_in_pre_credit' | 'cash_out_notes_coins' | 'carrier_guarded_wholesale_valuables': Specifies the high-level purpose/category of a mandate and/or payment using a set of pre-defined categories. Provides context on the nature and reason for the payment to facilitate processing and compliance. See [Billing Request Purpose Codes](https://docs.gocardless.com/docs/collect-payments/scheme-guidance/billing-request-purpose-codes) for the complete list of valid codes.
    - `payment_purpose_code` string: Specifies the underlying purpose of the payment. Defines the specific reason or type of service/goods the payment relates to, improving straight-through processing and compliance. See [VRP Commercial Payment Purpose Codes](https://docs.gocardless.com/docs/collect-payments/scheme-guidance/vrp-purpose-codes) for the complete list of valid codes.
    - `payment_context_code` 'billing_goods_and_services_in_advance' | 'billing_goods_and_services_in_arrears' | 'face_to_face_point_of_sale' | 'ecommerce_merchant_initiated_payment' | 'transfer_to_self' | 'transfer_to_third_party': Specifies the context or scenario in which the payment is being made. Defines whether the payment is for advance/arrears billing, point of sale transactions, ecommerce, or account transfers. This helps banks and payment processors understand the payment scenario and apply appropriate processing rules and risk controls.
    - `created_at` string, date-time: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created.
    - `status` 'pending' | 'ready_to_fulfil' | 'fulfilling' | 'fulfilled' | 'cancelled': One of: - `pending`: the billing request is pending and can be used - `ready_to_fulfil`: the billing request is ready to fulfil - `fulfilling`: the billing request is currently undergoing fulfilment - `fulfilled`: the billing request has been fulfilled and a payment created - `cancelled`: the billing request has been cancelled and cannot be used
    - `metadata` BillingRequestNullableMetadata, nullable: Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
    - `account_information_request` BillingRequestAccountInformationRequest, nullable: Request for account information
      - `country_code` string, required: [ISO 3166-1 alpha-2 code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
      - `scopes` string[], required: List of scopes for the account information request
    - `mandate_request` BillingRequestMandateRequest, nullable: Request for a mandate
      - `description` string, nullable: A human-readable description of the payment and/or mandate. This will be displayed to the payer when authorising the billing request.
      - `currency` string: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code.
      - `scheme` string, nullable: A bank payment scheme. Currently "ach", "autogiro", "bacs", "becs", "becs_nz", "betalingsservice", "faster_payments", "pad", "pay_to" and "sepa_core" are supported. Optional for mandate only requests - if left blank, the payer will be able to select the currency/scheme to pay with from a list of your available schemes.
      - `sweeping` boolean: If true, this billing request would be used to set up a mandate solely for moving (or sweeping) money from one account owned by the payer to another account that the payer also owns. This is required for Faster Payments
      - `verify` 'minimum' | 'recommended' | 'when_available' | 'always': Verification preference for the mandate. One of: - `minimum`: only verify if absolutely required, such as when part of scheme rules - `recommended`: in addition to `minimum`, use the GoCardless payment intelligence solution to decide if a payer should be verified - `when_available`: if verification mechanisms are available, use them - `always`: as `when_available`, but fail to create the Billing Request if a mechanism isn't available By default, all Billing Requests use the `recommended` verification preference. It uses GoCardless payment intelligence solution to determine if a payer is fraudulent or not. The verification mechanism is based on the response and the payer may be asked to verify themselves. If the feature is not available, `recommended` behaves like `minimum`. If you never wish to take advantage of our reduced risk products and Verified Mandates as they are released in new schemes, please use the `minimum` verification preference. See [Billing Requests: Creating Verified Mandates](https://docs.gocardless.com/docs/collect-payments/setting-up-mandates/verified-mandates) for more information.
      - `links` BillingRequestMandateRequestLinks
        - `mandate` string: (Optional) ID of the [mandate](https://docs.gocardless.com/docs/api-reference/mandate) that was created from this mandate request. this mandate request.
      - `metadata` CustomerMetadata: Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
      - `consent_type` string, nullable: This attribute represents the authorisation type between the payer and merchant. It can be set to `one_off`, `recurring` or `standing` for ACH scheme. And `single`, `recurring` and `sporadic` for PAD scheme. _Note:_ This is only supported for ACH and PAD schemes.
      - `constraints` BillingRequestMandateRequestConstraints, nullable: Constraints that will apply to the mandate_request. (Optional) Specifically required for PayTo and VRP.
        - `start_date` string, nullable: The date from which payments can be taken. This is an optional field and if it is not supplied the start date will be set to the day authorisation happens.
        - `end_date` string, nullable: The latest date at which payments can be taken, must occur after start_date if present This is an optional field and if it is not supplied the agreement will be considered open and will not have an end date. Keep in mind the end date must take into account how long it will take the user to set up this agreement via the Billing Request.
        - `max_amount_per_payment` integer: The maximum amount that can be charged for a single payment in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR). _Note:_ Required for PayTo and VRP.
        - `payment_method` string: A constraint where you can specify info (free text string) about how payments are calculated. For use when payments vary and cannot be expressed as a fixed amount and frequency. _Note:_ This is only supported for ACH and PAD schemes.
        - `periodic_limits` object[]: Caps on the total amount and/or number of payments that can be collected within a repeating period (e.g. no more than a set amount per month), as opposed to `max_amount_per_payment` which caps a single payment. _Note:_ Required for VRP, where exactly one periodic limit must be provided. Optional for PayTo.
          - `period` 'day' | 'week' | 'month' | 'year' | 'flexible': The repeating period for this mandate. Required whenever a periodic limit is provided (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, this defaults to flexible.
          - `max_total_amount` integer, nullable: The maximum total amount that can be charged for all payments in this periodic limit, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR). _Note:_ Required for VRP. This is not permitted for the PayTo scheme.
          - `max_payments` integer, nullable: The maximum number of payments that can be collected in this periodic limit. _Note:_ Only supported for the PayTo scheme, where it is optional.
          - `alignment` 'calendar' | 'creation_date': The alignment of the period. Defaults to `creation_date` if not specified. `calendar` - the period follows fixed calendar boundaries, the same for every mandate: `week` runs Monday to Sunday, `month` runs from the 1st to the last day of the calendar month, and `year` runs from 1 January to 31 December. If the mandate starts partway through a period, the limit for that first period is reduced proportionally to the days remaining (e.g. a monthly limit starting on the 15th gives roughly half the limit for that first month). `creation_date` - the period follows the mandate's own start date rather than the calendar. For example, if the mandate starts on the 15th, each monthly period runs from the 15th to the 14th of the following month. The first period is a full period, not reduced proportionally. _Note:_ Has no effect when period is `flexible`.
      - `payer_requested_dual_signature` boolean: This attribute can be set to true if the payer has indicated that multiple signatures are required for the mandate. As long as every other Billing Request actions have been completed, the payer will receive an email notification containing instructions on how to complete the additional signature. The dual signature flow can only be completed using GoCardless branded pages.
      - `authorisation_source` 'web' | 'telephone' | 'paper': This field is ACH specific, sometimes referred to as [SEC code](https://www.moderntreasury.com/learn/sec-codes). This is the way that the payer gives authorisation to the merchant. web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC code: WEB) telephone: Authorisation is provided orally over telephone (maps to SEC code: TEL) paper: Authorisation is provided in writing and signed, or similarly authenticated (maps to SEC code: PPD)
      - `funds_settlement` 'managed' | 'direct': This field will decide how GoCardless handles settlement of funds from the customer. - `managed` will be moved through GoCardless' account, batched, and payed out. - `direct` will be a direct transfer from the payer's account to the merchant where invoicing will be handled separately.
    - `payment_request` BillingRequestPaymentRequest, nullable: Request for a one-off strongly authorised payment
      - `description` string, nullable: A human-readable description of the payment and/or mandate. This will be displayed to the payer when authorising the billing request.
      - `currency` string: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. `GBP` and `EUR` supported; `GBP` with your customers in the UK and for `EUR` with your customers in supported Eurozone countries only.
      - `scheme` string, nullable: (Optional) A scheme used for Open Banking payments. Currently `faster_payments` is supported in the UK (GBP) and `sepa_credit_transfer` and `sepa_instant_credit_transfer` are supported in supported Eurozone countries (EUR). For Eurozone countries, `sepa_credit_transfer` is used as the default. Please be aware that `sepa_instant_credit_transfer` may incur an additional fee for your customer.
      - `amount` integer: Amount in minor unit (e.g. pence in GBP, cents in EUR).
      - `links` BillingRequestPaymentRequestLinks
        - `payment` string: (Optional) ID of the [payment](https://docs.gocardless.com/docs/api-reference/payment) that was created from this payment request.
      - `app_fee` integer, nullable: The amount to be deducted from the payment as an app fee, to be paid to the partner integration which created the billing request, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
      - `metadata` CustomerMetadata: Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
      - `reference` string, nullable: A custom payment reference defined by the merchant. It is only available for payments on the PayTo scheme or payments using the Direct Funds settlement model on the Faster Payments scheme.
      - `funds_settlement` 'managed' | 'direct': This field will decide how GoCardless handles settlement of funds from the customer. - `managed` will be moved through GoCardless' account, batched, and payed out. - `direct` will be a direct transfer from the payer's account to the merchant where invoicing will be handled separately.
      - `retry_if_possible` boolean: On failure, automatically retry the payment using [intelligent retries](https://docs.gocardless.com/docs/optimise/reduced-failed-payments-with-success-plus). Default is `false`. <p class="notice"><strong>Important</strong>: To be able to use intelligent retries, Success+ needs to be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus). </p>
    - `subscription_request` BillingRequestSubscriptionRequest, nullable: Request for a subscription
      - `amount` integer: Amount in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
      - `currency` string: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently "USD" and "CAD" are supported.
      - `interval_unit` 'weekly' | 'monthly' | 'yearly': The unit of time between customer charge dates. One of `weekly`, `monthly` or `yearly`.
      - `interval` integer: Number of `interval_units` between customer charge dates. Must be greater than or equal to `1`. Must result in at least one charge date per year. Defaults to `1`.
      - `app_fee` integer, nullable: The amount to be deducted from each payment as an app fee, to be paid to the partner integration which created the subscription, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
      - `count` integer, nullable: The total number of payments that should be taken by this subscription.
      - `day_of_month` integer, nullable: As per RFC 2445. The day of the month to charge customers on. `1`-`31` or `-1` to indicate the last day of the month. If the chosen day does not exist in a given month (e.g. `31` in April), the charge is made on the last day of that month.
      - `metadata` CustomerMetadata: Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
      - `links` BillingRequestSubscriptionRequestLinks
        - `subscription` string: (Optional) ID of the [subscription](https://docs.gocardless.com/docs/api-reference/subscription) that was created from this subscription request.
      - `month` 'january' | 'february' | 'march' | 'april' | 'may' | 'june' | 'july' | 'august' | 'september' | 'october' | 'november' | 'december', nullable: Name of the month on which to charge a customer. Must be lowercase. Only applies when the interval_unit is `yearly`.
      - `name` string, nullable: Optional name for the subscription. This will be set as the description on each payment created. Must not exceed 255 characters.
      - `payment_reference` string, nullable: An optional payment reference. This will be set as the reference on each payment created and will appear on your customer's bank statement. See the documentation for the [create payment endpoint](https://docs.gocardless.com/docs/api-reference/payment#create-a-payment) for more details. <br />
      - `start_date` string, date, nullable: The date on which the first payment should be charged. If fulfilled after this date, this will be set as the mandate's `next_possible_charge_date`. When left blank and `month` or `day_of_month` are provided, this will be set to the date of the first payment. If created without `month` or `day_of_month` this will be set as the mandate's `next_possible_charge_date`.
      - `retry_if_possible` boolean: On failure, automatically retry payments using [intelligent retries](https://docs.gocardless.com/docs/optimise/reduced-failed-payments-with-success-plus). Default is `false`. <p class="notice"><strong>Important</strong>: To be able to use intelligent retries, Success+ needs to be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus). </p>
    - `instalment_schedule_request` BillingRequestInstalmentScheduleRequest, nullable: Request for an instalment schedule. Has to contain either `instalments_with_schedule` object or an array of `instalments_with_dates` objects
      - `name` string: Name of the instalment schedule, up to 100 chars. This name will also be copied to the payments of the instalment schedule if you use schedule-based creation.
      - `currency` string: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently "USD" and "CAD" are supported.
      - `total_amount` integer: The total amount of the instalment schedule, defined as the sum of all individual payments, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR). If the requested payment amounts do not sum up correctly, a validation error will be returned.
      - `payment_reference` string, nullable: An optional payment reference. This will be set as the reference on each payment created and will appear on your customer's bank statement. See the documentation for the [create payment endpoint](https://docs.gocardless.com/docs/api-reference/payment#create-a-payment) for more details. <br />
      - `app_fee` integer, nullable: The amount to be deducted from each payment as an app fee, to be paid to the partner integration which created the subscription, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
      - `instalments_with_dates` object[], nullable: An explicit array of instalment payments, each specifying at least an `amount` and `charge_date`. See [create (with dates)](https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule)
        - `amount` integer, required: Amount, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR). Minimum and maximum amounts vary by payment scheme. For more information, see [Transaction limits](https://support.gocardless.com/hc/en-gb/articles/115000309245-Transaction-limits) For Variable Recurring Payments (VRP), this must not exceed the mandate's `max_amount_per_payment` constraint.
        - `charge_date` string, date, nullable, required: A future date on which the payment should be collected. If the date is before the next_possible_charge_date on the [mandate](https://docs.gocardless.com/docs/api-reference/mandate), it will be automatically rolled forwards to that date.
        - `description` string, nullable: A human-readable description of the payment. This will be included in the notification email GoCardless sends to your customer if your organisation does not send its own notifications (see [compliance requirements](https://docs.gocardless.com/docs/api-reference/compliance-requirements)).
      - `instalments_with_schedule` BillingRequestInstalmentsWithSchedule, nullable: Frequency of the payments you want to create, together with an array of payment amounts to be collected, with a specified start date for the first payment. See [create (with schedule)](https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule)
        - `start_date` string, date, nullable: The date on which the first payment should be charged. Must be on or after the [mandate](https://docs.gocardless.com/docs/api-reference/mandate)'s `next_possible_charge_date`. When left blank and `month` or `day_of_month` are provided, this will be set to the date of the first payment. If created without `month` or `day_of_month` this will be set as the mandate's `next_possible_charge_date`
        - `interval` integer, required: Number of `interval_units` between charge dates. Must be greater than or equal to `1`.
        - `interval_unit` 'weekly' | 'monthly' | 'yearly', required: The unit of time between customer charge dates. One of `weekly`, `monthly` or `yearly`.
        - `amounts` PaymentAmount[], required: List of amounts of each instalment, in the lowest denomination for the currency (e.g. cents in USD).
      - `metadata` CustomerMetadata: Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
      - `links` BillingRequestInstalmentScheduleRequestLinks
        - `instalment_schedule` string: (Optional) ID of the [instalment_schedule](https://docs.gocardless.com/docs/api-reference/instalment-schedule) that was created from this instalment schedule request.
      - `retry_if_possible` boolean: On failure, automatically retry payments using [intelligent retries](https://docs.gocardless.com/docs/optimise/reduced-failed-payments-with-success-plus). Default is `false`. <p class="notice"><strong>Important</strong>: To be able to use intelligent retries, Success+ needs to be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus). </p>
    - `actions` object[]: List of actions that can be performed before this billing request can be fulfilled.
      - `type` 'choose_currency' | 'collect_amount' | 'collect_customer_details' | 'collect_bank_account' | 'bank_authorisation' | 'confirm_payer_details' | 'select_institution': Unique identifier for the action.
      - `status` 'pending' | 'completed': Status of the action
      - `required` boolean: Informs you whether the action is required to fulfil the billing request or not.
      - `completes_actions` string[]: Which other action types this action can complete.
      - `requires_actions` string[]: Requires completing these actions before this action can be completed.
      - `bank_authorisation` object: Describes the behaviour of bank authorisations, for the bank_authorisation action
        - `adapter` 'open_banking_gateway_pis' | 'open_banking_gateway_ais' | 'bankid_ais' | 'bank_pay_recurring': Which authorisation adapter will be used to power these authorisations (GoCardless internal use only)
        - `authorisation_type` 'payment' | 'mandate': What type of bank authorisations are supported on this billing request
      - `collect_customer_details` object: Additional parameters to help complete the collect_customer_details action
        - `default_country_code` string, nullable: Default customer country code, as determined by scheme and payer location
        - `incomplete_fields` object
          - `customer` string[]
          - `customer_billing_detail` string[]
      - `available_currencies` BillingRequestCurrency[]: List of currencies the current mandate supports
      - `available_country_codes` string[]: List of country codes supported for collecting bank account details, for the collect_bank_account action
      - `institution_guess_status` 'not_needed' | 'pending' | 'failed' | 'success': Describes whether we inferred the institution from the provided bank account details. One of: - `not_needed`: we won't attempt to infer the institution as it is not needed. Either because it was manually selected or the billing request does not support this feature - `pending`: we are waiting on the bank details in order to infer the institution - `failed`: we weren't able to infer the institution - `success`: we inferred the institution and added it to the resources of a Billing Request
    - `resources` BillingRequestResources
      - `customer` object: Embedded customer
        - `id` string: Unique identifier, beginning with "CU".
        - `created_at` string, date-time: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created.
        - `email` string, nullable: Customer's email address. Required in most cases, as this allows GoCardless to send notifications to this customer.
        - `given_name` string, nullable: Customer's first name. Required unless a `company_name` is provided.
        - `family_name` string, nullable: Customer's surname. Required unless a `company_name` is provided.
        - `company_name` string, nullable: Customer's company name. Required unless a `given_name` and `family_name` are provided. For Canadian customers, the use of a `company_name` value will mean that any mandate created from this customer will be considered to be a "Business PAD" (otherwise, any mandate will be considered to be a "Personal PAD").
        - `language` string, nullable: [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used as the language for notification emails sent by GoCardless if your organisation does not send its own (see [compliance requirements](https://docs.gocardless.com/docs/api-reference/compliance-requirements)). Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are supported. If this is not provided, the language will be chosen based on the `country_code` (if supplied) or default to "en".
        - `phone_number` string, nullable: [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, including country code.
        - `metadata` CustomerMetadata: Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
      - `customer_billing_detail` object: Embedded customer billing detail
        - `id` string: Unique identifier, beginning with "CU".
        - `schemes` string[]: The schemes associated with this customer billing detail
        - `created_at` string, date-time: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created.
        - `address_line1` string, nullable: The first line of the customer's address.
        - `address_line2` string, nullable: The second line of the customer's address.
        - `address_line3` string, nullable: The third line of the customer's address.
        - `city` string, nullable: The city of the customer's address.
        - `region` string, nullable: The customer's address region, county or department. For US customers a 2 letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code is required (e.g. `CA` for California).
        - `postal_code` string, nullable: The customer's postal code.
        - `country_code` string, nullable: [ISO 3166-1 alpha-2 code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
        - `swedish_identity_number` string, nullable: For Swedish customers only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer. Must be supplied if the customer's bank account is denominated in Swedish krona (SEK). This field cannot be changed once it has been set.
        - `danish_identity_number` string, nullable: For Danish customers only. The civic/company number (CPR or CVR) of the customer. Must be supplied if the customer's bank account is denominated in Danish krone (DKK).
        - `ip_address` string, nullable: For ACH customers only. Required for ACH customers. A string containing the IP address of the payer to whom the mandate belongs (i.e. as a result of their completion of a mandate setup flow in their browser). Not required for creating offline mandates where `authorisation_source` is set to telephone or paper.
      - `customer_bank_account` object, nullable: Embedded customer bank account, only if a bank account is linked
        - `id` string: Unique identifier, beginning with "BA".
        - `created_at` string, date-time: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created.
        - `account_holder_name` string: Name of the account holder, as known by the bank. The full name provided when the customer is created is stored and is available via the API, but is transliterated, upcased, and truncated to 18 characters in bank submissions. This field is required unless the request includes a [customer bank account token](https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow).
        - `account_number_ending` string, nullable: The last few digits of the account number. Currently 4 digits for NZD bank accounts and 2 digits for other currencies.
        - `account_type` 'savings' | 'checking', nullable: Bank account type. Required for USD-denominated bank accounts. Must not be provided for bank accounts in other currencies. See [local details](https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states) for more information.
        - `country_code` string, nullable: [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). Defaults to the country code of the `iban` if supplied, otherwise is required.
        - `currency` string, nullable: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
        - `bank_name` string, nullable: Name of bank, taken from the bank details.
        - `enabled` boolean: Boolean value showing whether the bank account is enabled or disabled.
        - `metadata` CustomerMetadata: Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
        - `links` CustomerBankAccountLinks
          - `customer` string: ID of the [customer](https://docs.gocardless.com/docs/api-reference/customer) that owns this bank account.
        - `bank_account_token` string, nullable: A token to uniquely refer to a set of bank account details. This feature is still in early access and is only available for certain organisations.
        - `payer_name_verification_result` 'full' | 'close' | 'cannot_perform_verification': The result of the payer name verification check performed when the bank account was created. Only present if a check was performed. - `full`: The name provided matches the name held by the bank. - `close`: The name provided is a close but not exact match to the name held by the bank. - `cannot_perform_verification`: A verification was attempted but could not be completed. This can happen for a number of reasons, including the account holder's bank not participating in the verification scheme, the account not being eligible for verification (e.g. the account holder has opted out), or the bank details not being resolvable, among others.
    - `links` BillingRequestLinks
      - `customer` string: ID of the [customer](https://docs.gocardless.com/docs/api-reference/customer) that will be used for this request
      - `customer_billing_detail` string: ID of the customer billing detail that will be used for this request
      - `creditor` string: ID of the associated [creditor](https://docs.gocardless.com/docs/api-reference/creditor).
      - `organisation` string: ID of the associated organisation.
      - `customer_bank_account` string: (Optional) ID of the [customer_bank_account](https://docs.gocardless.com/docs/api-reference/customer-bank-account) that will be used for this request
      - `bank_authorisation` string: (Optional) ID of the [bank authorisation](https://docs.gocardless.com/docs/api-reference/bank-authorisation) that was used to verify this request.
      - `account_information_request` string: (Optional) ID of associated account information request
      - `payment_request` string: (Optional) ID of the associated payment request
      - `payment_request_payment` string: (Optional) ID of the [payment](https://docs.gocardless.com/docs/api-reference/payment) that was created from this payment request.
      - `mandate_request` string: (Optional) ID of the associated mandate request
      - `mandate_request_mandate` string: (Optional) ID of the [mandate](https://docs.gocardless.com/docs/api-reference/mandate) that was created from this mandate request. this mandate request.
      - `subscription_request` string: (Optional) ID of the associated subscription request
      - `subscription_request_subscription` string: (Optional) ID of the [subscription](https://docs.gocardless.com/docs/api-reference/subscription) that was created from this subscription request.
      - `instalment_schedule_request` string: (Optional) ID of the associated instalment schedule request
      - `instalment_schedule_request_instalment_schedule` string: (Optional) ID of the [instalment_schedule](https://docs.gocardless.com/docs/api-reference/instalment-schedule) that was created from this instalment schedule request.
      - `payment_provider` string: (Optional) ID of the associated payment provider
    - `fallback_enabled` boolean: (Optional) If true, this billing request can fallback from instant payment to direct debit. Should not be set if GoCardless payment intelligence feature is used. See [Billing Requests: Retain customers with Fallbacks](https://docs.gocardless.com/docs/optimise/retain-customers-with-fallbacks) for more information.
    - `fallback_occurred` boolean: True if the billing request was completed with direct debit.

## Other responses

- `400`: Bad Request
- `401`: Unauthorised
- `404`: Not found
- `422`: Validation Error
- `500`: Internal Error

---

[API](https://skmtc.dev/gocardless/apis/gocardless-api.md) - [All operations](https://skmtc.dev/gocardless/apis/gocardless-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gocardless/apis/gocardless-api/revisions/4dd3dae45364?raw)
