Important: This endpoint will no longer return events older than 18 months, including when filtering by resource. This takes effect no sooner than 1 August 2026 in sandbox environments, and no sooner than 1 October 2026 in live environments.
## Query parameters - `before` string, nullable - `after` string, nullable - `limit` union - integer - string - `created_at` object - `gt` string, date-time: Limit to records created after the specified date-time. - `lt` string, date-time: Limit to records created before the specified date-time. - `gte` string, date-time: Limit to records created on or after the specified date-time. - `lte` string, date-time: Limit to records created on or before the specified date-time. - `billing_request` string - `creditor` string - `export` string - `instalment_schedule` string - `mandate` string - `outbound_payment` string - `payer_authorisation` string - `payment` string - `payment_account_transaction` string - `payout` string - `refund` string - `subscription` string - `scheme_identifier` string - `parent_event` string - `action` string - `resource_type` 'billing_requests' | 'creditors' | 'customers' | 'exports' | 'instalment_schedules' | 'mandates' | 'organisations' | 'outbound_payments' | 'payer_authorisations' | 'payments' | 'payment_account_transactions' | 'payouts' | 'refunds' | 'scheme_identifiers' | 'subscriptions': Type of resource that you'd like to get all events for. Cannot be used together with the `billing_request`, `creditor`, `export`,`instalment_schedule`, `mandate`, `payer_authorisation`, `payment`, `payout`, `refund`, `scheme_identifier`, `subscription`, `outbound_payment` or `payment_account_transaction` parameters. - `include` 'billing_request' | 'creditor' | 'customer' | 'instalment_schedule' | 'mandate' | 'outbound_payment' | 'payer_authorisation' | 'payment' | 'payment_account_transaction' | 'payout' | 'refund' | 'scheme_identifier' | 'subscription': The resource type of a linked resource that can be requested via the `include` query parameter. ## Headers - `GoCardless-Version` string, required ## Response `200` Successful response - EventMultiResourceResponse - `events` Event[] - `id` string: Unique identifier, beginning with "EV". - `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. - `resource_type` 'billing_requests' | 'creditors' | 'customers' | 'exports' | 'instalment_schedules' | 'mandates' | 'organisations' | 'outbound_payments' | 'payer_authorisations' | 'payments' | 'payment_account_transactions' | 'payouts' | 'refunds' | 'scheme_identifiers' | 'subscriptions': The resource type for this event. - `action` string: What has happened to the resource. See [Event Types](https://docs.gocardless.com/docs/api-reference/events) for the possible actions. - `customer_notifications` object[], nullable: Present only in webhooks when an integrator is authorised to send their own notifications. See [here](https://docs.gocardless.com/docs/tutorials/handling-customer-notifications) for further information. - `id` string: The id of the notification. - `type` string: See [here](https://docs.gocardless.com/docs/api-reference/customer-notification) for a complete list of customer notification types. - `mandatory` boolean: Whether or not the notification must be sent. - `deadline` string, date-time: Time after which GoCardless will send the notification by email. - `details` EventDetails - `origin` 'bank' | 'api' | 'gocardless' | 'customer' | 'payer': Who initiated the event. One of: - `bank`: this event was triggered by a report from the banks - `gocardless`: this event was performed by GoCardless automatically - `api`: this event was triggered by an API endpoint - `customer`: this event was triggered by a Customer - `payer`: this event was triggered by a Payer - `cause` string: What triggered the event. _Note:_ `cause` is our simplified and predictable key indicating what triggered the event. - `description` string: Human readable description of the cause. _Note:_ Changes to event descriptions are not considered breaking. - `scheme` 'ach' | 'autogiro' | 'bacs' | 'becs' | 'becs_nz' | 'betalingsservice' | 'faster_payments' | 'pad' | 'pay_to' | 'sepa_core' | 'sepa_cor1' | 'sepa_credit_transfer' | 'sepa_instant_credit_transfer', nullable: A bank payment scheme. Set when a bank is the origin of the event. - `reason_code` string: Set when a `bank` is the origin of the event. This is the reason code received in the report from the customer's bank. See the [GoCardless Direct Debit guide](https://gocardless.com/direct-debit/receiving-messages) for information on the meanings of different reason codes. _Note:_ `reason_code` is payment scheme-specific and can be inconsistent between banks. - `will_attempt_retry` boolean: Whether the payment will be retried automatically. Set on a payment failed event. - `not_retried_reason` string: When will_attempt_retry is set to false, this field will contain the reason the payment was not retried. This can be one of: - `failure_filter_applied`: The payment won't be intelligently retried as there is a high likelihood of failure on retry. - `other`: The payment won't be intelligently retried due to any other reason. - `bank_account_id` string: When we send a creditor `new_payout_currency_added` webhook, we also send the bank account id of the new account - `currency` string: When we send a creditor `new_payout_currency_added` webhook, we also send the currency of the new account - `property` string: When we send a creditor `creditor_updated` webhook, this tells you which property on the creditor has been updated - `item_count` integer: Count of rows in the csv. This is sent for export events - `metadata` EventMetadata: The metadata that was passed when making the API request that triggered the event (for instance, cancelling a mandate). This field will only be populated if the `details[origin]` field is `api` otherwise it will be an empty object. - `resource_metadata` EventResourceMetadata: The metadata of the resource that the event is for. For example, this field will have the same value of the `mandate[metadata]` field on the response you would receive from performing a GET request on a mandate. - `source` EventSource: Audit information about the source of the event. - `type` 'app' | 'user' | 'gc_team' | 'access_token' | 'billing_request' | 'billing_request_flow' | 'dropin' | 'hosted_payment_page': The type of the event's source. - `name` string: The name of the event's source. - `links` EventLinks - `billing_request` string: ID of a [billing request](https://docs.gocardless.com/docs/api-reference/billing-request). - `billing_request_flow` string: ID of a [billing request flow](https://docs.gocardless.com/docs/api-reference/billing-request-flow). - `bank_authorisation` string: ID of a [bank authorisation](https://docs.gocardless.com/docs/api-reference/bank-authorisation). - `payment_request_payment` string: If `resource_type` is `billing_requests`, this is the ID of the [payment](https://docs.gocardless.com/docs/api-reference/payment) which has been created for Pay by Bank. - `mandate_request` string: This is the id of the mandate request associated to this event - `mandate_request_mandate` string: If `resource_type` is `billing_requests`, this is the ID of the [mandate](https://docs.gocardless.com/docs/api-reference/mandate) which has been created. - `customer` string: ID of a [customer](https://docs.gocardless.com/docs/api-reference/customer). - `customer_bank_account` string: ID of a [customer bank account](https://docs.gocardless.com/docs/api-reference/customer-bank-account). - `payment` string: If `resource_type` is `payments`, this is the ID of the [payment](https://docs.gocardless.com/docs/api-reference/payment) which has been updated. - `mandate` string: If `resource_type` is `mandates`, this is the ID of the [mandate](https://docs.gocardless.com/docs/api-reference/mandate) which has been updated. - `payer_authorisation` string: ID of a [payer authorisation](https://docs.gocardless.com/docs/api-reference/payer-authorisation). - `payout` string: If `resource_type` is `payouts`, this is the ID of the [payout](https://docs.gocardless.com/docs/api-reference/payout) which has been updated. - `refund` string: If `resource_type` is `refunds`, this is the ID of the [refund](https://docs.gocardless.com/docs/api-reference/refund) which has been updated. - `subscription` string: If `resource_type` is `subscription`, this is the ID of the [subscription](https://docs.gocardless.com/docs/api-reference/subscription) which has been updated. - `instalment_schedule` string: If `resource_type` is `instalment_schedule`, this is the ID of the [instalment schedule](https://docs.gocardless.com/docs/api-reference/instalment-schedule) which has been updated. - `creditor` string: If `resource_type` is `creditor`, this is the ID of the [creditor](https://docs.gocardless.com/docs/api-reference/creditor) which has been updated. - `parent_event` string: If this event was caused by another, this is the ID of the cause. For example, if a mandate is cancelled it automatically cancels all pending payments associated with it; in this case, the payment cancellation events would have the ID of the mandate cancellation event in this field. - `previous_customer_bank_account` string: This is only included for mandate transfer events, when it is the ID of the [customer bank account](https://docs.gocardless.com/docs/api-reference/customer-bank-account) which the mandate is being transferred from. - `new_customer_bank_account` string: This is only included for mandate transfer events, when it is the ID of the [customer bank account](https://docs.gocardless.com/docs/api-reference/customer-bank-account) which the mandate is being transferred to. - `new_mandate` string: This is only included for mandate replaced events, when it is the ID of the new [mandate](https://docs.gocardless.com/docs/api-reference/mandate) that replaces the existing mandate. - `organisation` string: If the event is included in a [webhook](https://docs.gocardless.com/docs/api-reference/webhooks) to an [OAuth app](https://docs.gocardless.com/docs/api-reference/oauth-reference), this is the ID of the account to which it belongs. - `outbound_payment` string: If `resource_type` is `outbound_payments`, this is the ID of the outbound_payment which has been updated. - `payment_account_transaction` string: If `resource_type` is `payment_account_transaction`, this is the ID of a transaction which has been recorded on the payment account. - `scheme_identifier` string: If `resource_type` is `scheme_identifiers`, this is the ID of the [scheme_identifier](https://docs.gocardless.com/docs/api-reference/scheme-identifier) which has been updated. - `meta` EventPaginationMeta: Cursor pagination information - `limit` integer, required - `cursors` object, required - `before` string, nullable, required: Cursor pointing to the end of the desired set. - `after` string, nullable, required: Cursor pointing to the start of the desired set. - `linked` EventLinked - `billing_requests` BillingRequest[]: A list of billing requests linked to the events returned in the list of events. - `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`.Important: To be able to use intelligent retries, Success+ needs to be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
- `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.Important: To be able to use intelligent retries, Success+ needs to be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
- `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.Important: To be able to use intelligent retries, Success+ needs to be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
- `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. - `creditors` Creditor[]: A list of creditors linked to the events returned in the list of events. - `id` string: Unique identifier, beginning with "CR". - `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. - `name` string: The creditor's trading name. - `address_line1` string, nullable: The first line of the creditor's address. - `address_line2` string, nullable: The second line of the creditor's address. - `address_line3` string, nullable: The third line of the creditor's address. - `city` string, nullable: The city of the creditor's address. - `region` string, nullable: The creditor's address region, county or department. - `postal_code` string, nullable: The creditor'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) - `can_create_refunds` boolean: Boolean indicating whether the creditor is permitted to create refunds. - `bank_reference_prefix` string: Prefix for the bank reference of payouts sent to this creditor. For instance, if the creditor's `bank_reference_prefix` was `ACME`, the bank reference of a payout sent to that creditor could be `ACME-8G7Q8`. This prefix is also used for refunds in EUR and GBP. - `links` CreditorLinks - `default_aud_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in AUD. - `default_gbp_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in GBP. - `default_eur_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in EUR. - `default_sek_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in SEK. - `default_dkk_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in DKK. - `default_nzd_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in NZD. - `default_cad_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in CAD. - `default_usd_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in USD. - `scheme_identifiers` object[]: An array of the scheme identifiers this creditor can create mandates against. The support address, `phone_number` and `email` fields are for customers to contact the merchant for support purposes. They must be displayed on the payment page, please see our [compliance requirements](https://docs.gocardless.com/docs/api-reference/compliance-requirements) for more details. - `id` string: Unique identifier, usually beginning with "SU". - `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. - `name` string: The name which appears on customers' bank statements. This should usually be the merchant's trading name. - `scheme` 'ach' | 'autogiro' | 'bacs' | 'becs' | 'becs_nz' | 'betalingsservice' | 'faster_payments' | 'pad' | 'pay_to' | 'sepa' | 'sepa_credit_transfer' | 'sepa_instant_credit_transfer': The scheme which this scheme identifier applies to. - `reference` string, nullable: The scheme-unique identifier against which payments are submitted. - `status` 'pending' | 'active': The status of the scheme identifier. Only `active` scheme identifiers will be applied to a creditor and used against payments. - `minimum_advance_notice` integer: The minimum interval, in working days, between the sending of a pre-notification to the customer, and the charge date of a payment using this scheme identifier. By default, GoCardless sends these notifications automatically. Please see our [compliance requirements](https://docs.gocardless.com/docs/api-reference/compliance-requirements) for more details. - `address_line1` string, nullable: The first line of the scheme identifier's support address. - `address_line2` string, nullable: The second line of the scheme identifier's support address. - `address_line3` string, nullable: The third line of the scheme identifier's support address. - `city` string, nullable: The city of the scheme identifier's support address. - `region` string, nullable: The scheme identifier's support address region, county or department. - `postal_code` string, nullable: The scheme identifier's support 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) - `email` string, nullable: Scheme identifier's support email address. - `phone_number` string, nullable: Scheme identifier's support phone number. - `currency` 'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD': The currency of the scheme identifier. - `can_specify_mandate_reference` boolean: Whether a custom reference can be submitted for mandates using this scheme identifier. - `logo_url` string, nullable: URL for the creditor's logo, which may be shown on their payment pages. - `verification_status` 'successful' | 'in_review' | 'action_required': The creditor's verification status, indicating whether they can yet receive payouts. For more details on handling verification as a partner, see our ["Helping your users get verified" guide](https://docs.gocardless.com/docs/partner-integrations/getting-your-users-verified). One of: - `successful`: The creditor's account is fully verified, and they can receive payouts. Once a creditor has been successfully verified, they may in the future require further verification - for example, if they change their payout bank account, we will have to check that they own the new bank account before they can receive payouts again. - `in_review`: The creditor has provided all of the information currently requested, and it is awaiting review by GoCardless before they can be verified and receive payouts. - `action_required`: The creditor needs to provide further information to verify their account so they can receive payouts, and should visit the verification flow. - `merchant_responsible_for_notifications` boolean: Boolean value indicating whether the organisation is responsible for sending all customer notifications (note this is separate from the functionality described [here](https://docs.gocardless.com/docs/tutorials/handling-customer-notifications)). If you are a partner app, and this value is true, you should not send notifications on behalf of this organisation. - `mandate_imports_enabled` boolean: Boolean value indicating whether creditor has the [Mandate Imports](https://docs.gocardless.com/docs/api-reference/mandate-import) functionality enabled. - `custom_payment_pages_enabled` boolean: Boolean value indicating whether creditor has the [Custom Payment Pages](https://hub.gocardless.com/s/article/Custom-payment-pages) functionality enabled. - `fx_payout_currency` 'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD', nullable: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency in which amounts will be paid out (after foreign exchange). Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported. Present only if payouts will be (or were) made via foreign exchange. - `creditor_type` 'company' | 'individual' | 'charity' | 'partnership' | 'trust', nullable: The type of business of the creditor. Currently, `individual`, `company`, `charity`, `partnership`, and `trust` are supported. - `instalment_schedules` InstalmentSchedule[]: A list of instalment schedules linked to the events returned in the list of events. - `id` string: Unique identifier, beginning with "IS". - `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. - `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. - `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` 'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD': [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. - `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. - `status` 'pending' | 'active' | 'creation_failed' | 'completed' | 'cancelled' | 'errored': One of: - `pending`: we're waiting for GC to create the payments - `active`: the payments have been created, and the schedule is active - `creation_failed`: payment creation failed - `completed`: we have passed the date of the final payment and all payments have been collected - `cancelled`: the schedule has been cancelled - `errored`: one or more payments have failed - `payment_errors` InstalmentSchedulePaymentErrors: If the status is `creation_failed`, this property will be populated with validation failures from the individual payments, arranged by the index of the payment that failed. - `links` InstalmentScheduleLinks: Links to associated objects - `mandate` string, required: ID of the associated [mandate](https://docs.gocardless.com/docs/api-reference/mandate) which the instalment schedule will create payments against. - `customer` string, required: ID of the associated [customer](https://docs.gocardless.com/docs/api-reference/customer). - `payments` string[]: Array of IDs of the associated [payments](https://docs.gocardless.com/docs/api-reference/payment) - `mandates` Mandate[]: A list of mandates linked to the events returned in the list of events. - `id` string: Unique identifier, beginning with "MD". Note that this prefix may not apply to mandates created before 2016. - `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. - `reference` string, nullable: Unique reference. Different schemes have different length and [character set](https://docs.gocardless.com/docs/api-reference/character-sets) requirements. GoCardless will generate a unique reference satisfying the different scheme requirements if this field is left blank. - `status` 'pending_customer_approval' | 'pending_submission' | 'submitted' | 'active' | 'failed' | 'cancelled' | 'expired' | 'consumed' | 'blocked' | 'suspended_by_payer': One of: - `pending_customer_approval`: the mandate has not yet been signed by the second customer - `pending_submission`: the mandate has not yet been submitted to the customer's bank - `submitted`: the mandate has been submitted to the customer's bank but has not been processed yet - `active`: the mandate has been successfully set up by the customer's bank - `suspended_by_payer`: the mandate has been suspended by payer - `failed`: the mandate could not be created - `cancelled`: the mandate has been cancelled - `expired`: the mandate has expired due to dormancy - `consumed`: the mandate has been consumed and cannot be reused (note that this only applies to schemes that are per-payment authorised) - `blocked`: the mandate has been blocked and payments cannot be created - `scheme` string, nullable: Bank payment scheme to which this mandate and associated payments are submitted. Can be supplied or automatically detected from the customer's bank account. - `mandate_type` 'bank_debit' | 'instant' | 'recurring' | 'vrp_commercial' | 'vrp_sweeping', nullable: Mandate type - `next_possible_charge_date` string, date, nullable: The earliest date that can be used as a `charge_date` on any newly created payment for this mandate. This value will change over time. - `next_possible_standard_ach_charge_date` string, date, nullable: If this is an ACH mandate, the earliest date that can be used as a `charge_date` on any newly created payment to be charged through standard ACH, rather than Faster ACH. This value will change over time. It is only present in the API response for ACH mandates. - `payments_require_approval` boolean: Boolean value showing whether payments and subscriptions under this mandate require approval via an automated email before being processed. - `verified_at` string, date-time, nullable: [Timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times) recording when this mandate was verified. - `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` MandateLinks - `customer_bank_account` string: ID of the associated [customer bank account](https://docs.gocardless.com/docs/api-reference/customer-bank-account) which the mandate is created and submits payments against. - `creditor` string: ID of the associated [creditor](https://docs.gocardless.com/docs/api-reference/creditor). - `new_mandate` string: ID of the new mandate if this mandate has been replaced. - `customer` string: ID of the associated [customer](https://docs.gocardless.com/docs/api-reference/customer) - `consent_parameters` MandateConsentParameters, nullable: (Optional) Payto and VRP Scheme specific information - `id` string: Unique identifier for the consent parameters - `scheme` string: The scheme associated with the consent parameters - `currency` string: The currency for the consent parameters - `fixed_amount_per_payment` integer, nullable: The fixed amount for each payment, in the lowest denomination for the currency - `max_amount_per_payment` integer, nullable: The maximum amount that can be charged for a single payment - `period` 'day' | 'week' | 'month' | 'year' | 'flexible': The repeating period for this mandate - `max_amount_per_period` integer, nullable: The maximum total amount that can be charged for all payments in this period - `max_payments_per_period` integer, nullable: The maximum number of payments that can be collected in this period - `start_date` string: The date from which payments can be taken - `end_date` string, nullable: The latest date at which payments can be taken, must occur after start_date if present - `period_alignment` 'calendar' | 'consent' | 'creation_date': The alignment of the payment period. - `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. - `consent_type` 'one_off' | 'single' | 'recurring' | 'standing' | 'sporadic', nullable: (Optional) Specifies the type of authorisation agreed between the payer and merchant. It can be set to one-off, recurring or standing for ACH, or single, recurring and sporadic for PAD. - `outbound_payments` OutboundPayment[]: A list of outbound payments linked to the events returned in the list of events. - `id` string, required: Unique identifier of the outbound payment. - `created_at` string, date-time: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when the outbound payment was created. - `status` 'verifying' | 'pending_approval' | 'scheduled' | 'executing' | 'executed' | 'cancelled' | 'failed': One of: - `verifying`: The payment has been [created](https://docs.gocardless.com/docs/api-reference/outbound-payment#create-an-outbound-payment) and the verification process has begun. - `pending_approval`: The payment is awaiting [approval](https://docs.gocardless.com/docs/api-reference/outbound-payment#approve-an-outbound-payment). - `scheduled`: The payment has passed verification & [approval](https://docs.gocardless.com/docs/api-reference/outbound-payment#approve-an-outbound-payment), but processing has not yet begun. - `executing`: The execution date has arrived and the payment has been placed in queue for processing. - `executed`: The payment has been accepted by the scheme and is now on its way to the recipient. - `cancelled`: The payment has been [cancelled](https://docs.gocardless.com/docs/api-reference/outbound-payment#cancel-an-outbound-payment) or was not [approved](https://docs.gocardless.com/docs/api-reference/outbound-payment#approve-an-outbound-payment) on time. - `failed`: The payment was not sent, usually due to an error while or after executing. - `amount` integer: Amount, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR). - `scheme` 'faster_payments': Bank payment scheme to process the outbound payment. Currently only "faster_payments" (GBP) is supported. - `currency` 'GBP': [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency. Currently only "GBP" is supported. - `execution_date` string, date: A future date on which the outbound payment should be sent. If not specified, the payment will be sent as soon as possible. - `description` string: A human-readable description of the outbound payment - `reference` string: An optional reference that will appear on your customer's bank statement. The character limit for this reference is dependent on the scheme.Restricted: You can only specify a payment reference for Bacs payments (that is, when collecting from the UK) if you're on the GoCardless Plus, Pro or Enterprise packages.
Restricted: You can not specify a payment reference for Faster Payments.
- `metadata` CustomerMetadata, required: 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. - `status` 'pending_customer_approval' | 'pending_submission' | 'submitted' | 'confirmed' | 'paid_out' | 'cancelled' | 'customer_approval_denied' | 'failed' | 'charged_back', required: One of: - `pending_customer_approval`: we're waiting for the customer to approve this payment - `pending_submission`: the payment has been created, but not yet submitted to the banks - `submitted`: the payment has been submitted to the banks - `confirmed`: the payment has been confirmed as collected - `paid_out`: the payment has been included in a [payout](https://docs.gocardless.com/docs/api-reference/payout) - `cancelled`: the payment has been cancelled - `customer_approval_denied`: the customer has denied approval for the payment. You should contact the customer directly - `failed`: the payment failed to be processed. Note that payments can fail after being confirmed if the failure message is sent late by the banks. - `charged_back`: the payment has been charged back - `app_fee` integer, nullable: The amount to be deducted from the payment as the OAuth app''s fee, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR). Only present if the payment was created via an app. - `links` PaymentLinks, required - `mandate` string: ID of the [mandate](https://docs.gocardless.com/docs/api-reference/mandate) against which this payment should be collected. - `creditor` string: ID of [creditor](https://docs.gocardless.com/docs/api-reference/creditor) to which the collected payment will be sent. - `payout` string: ID of [payout](https://docs.gocardless.com/docs/api-reference/payout) which contains the funds from this payment.Important: To be able to use intelligent retries, Success+ needs to be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
- `scheme` string, nullable, required: A bank payment scheme. Currently "ach", "autogiro", "bacs", "becs", "becs_nz", "betalingsservice", "faster_payments", "pad", "pay_to", "sepa_core", "sepa_credit_transfer" and "sepa_instant_credit_transfer" are supported. - `payouts` Payout[]: A list of payouts linked to the events returned in the list of events. - `id` string, required: Unique identifier, beginning with "PO". - `created_at` string, date-time, required: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created. - `amount` integer, required: Amount in minor unit (e.g. pence in GBP, cents in EUR). - `deducted_fees` integer, required: Fees that have already been deducted from the payout amount in minor unit (e.g. pence in GBP, cents in EUR), inclusive of tax if applicable.Restricted: You can only specify a payment reference for Bacs payments (that is, when collecting from the UK) if you're on the GoCardless Plus, Pro or Enterprise packages.
Restricted: You can not specify a payment reference for Faster Payments.
- `metadata` CustomerMetadata, required: 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` RefundLinks, required - `payment` string: ID of the [payment](https://docs.gocardless.com/docs/api-reference/payment) against which the refund is being made. - `mandate` string: ID of the [mandate](https://docs.gocardless.com/docs/api-reference/mandate) against which the refund is being made. - `fx` RefundFx, required - `exchange_rate` string, nullable: Rate used in the foreign exchange of the `amount` into the `fx_currency`. Present only after a resource is paid out. Has up to 10 decimal places. - `estimated_exchange_rate` string, nullable: Estimated rate that will be used in the foreign exchange of the `amount` into the `fx_currency`. This will vary based on the prevailing market rate until the moment that it is paid out. Present only before a resource is paid out. Has up to 10 decimal places. - `fx_amount` union: Amount that was paid out in the `fx_currency` after foreign exchange. Present only after the resource has been paid out. - string, nullable - integer - `fx_currency` 'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD', nullable: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency in which amounts will be paid out (after foreign exchange). Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported. Present only if payouts will be (or were) made via foreign exchange. - `subscriptions` Subscription[]: A list of subscriptions linked to the events returned in the list of events. - `id` string: Unique identifier, beginning with "SB". - `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. - `amount` integer: Amount in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR). - `name` string, nullable: Optional name for the subscription. This will be set as the description on each payment created. Must not exceed 255 characters. - `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` - `end_date` string, date, nullable: Date on or after which no further payments should be created.Deprecated: This field will be removed in a future API version. Use count to specify a number of payments instead.
Restricted: You need your own Service User Number to specify a payment reference for Bacs payments.
- `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. - `status` 'pending_customer_approval' | 'customer_approval_denied' | 'active' | 'finished' | 'cancelled' | 'paused': One of: - `pending_customer_approval`: the subscription is waiting for customer approval before becoming active - `customer_approval_denied`: the customer did not approve the subscription - `active`: the subscription is currently active and will continue to create payments - `finished`: all of the payments scheduled for creation under this subscription have been created - `cancelled`: the subscription has been cancelled and will no longer create payments - `paused`: the subscription has been paused and will not create payments - `upcoming_payments` object[]: Up to 10 upcoming payments with their amounts and charge dates. - `charge_date` string, date: The date on which this payment will be charged. - `amount` integer: The amount of this payment, in minor unit (e.g. pence in GBP, cents in EUR). - `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). - `links` SubscriptionLinks - `mandate` string: ID of the associated [mandate](https://docs.gocardless.com/docs/api-reference/mandate) which the subscription will create payments against. - `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`.Important: To be able to use intelligent retries, Success+ needs to be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
- `earliest_charge_date_after_resume` string, date, nullable: The earliest date that will be used as a `charge_date` on payments created for this subscription if it is resumed. Only present for `paused` subscriptions. This value will change over time. - `parent_plan_paused` boolean: Whether the parent plan of this subscription is paused. - `scheme_identifiers` SchemeIdentifier[]: A list of scheme identifiers linked to the events returned in the list of events. - `id` string, required: Unique identifier, usually beginning with "SU". - `created_at` string, date-time, required: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created. - `name` string, required: The name which appears on customers' bank statements. This should usually be the merchant's trading name. - `scheme` 'ach' | 'autogiro' | 'bacs' | 'becs' | 'becs_nz' | 'betalingsservice' | 'faster_payments' | 'pad' | 'pay_to' | 'sepa' | 'sepa_credit_transfer' | 'sepa_instant_credit_transfer', required: The scheme which this scheme identifier applies to. - `reference` string, nullable, required: The scheme-unique identifier against which payments are submitted. - `status` 'pending' | 'active', required: The status of the scheme identifier. Only `active` scheme identifiers will be applied to a creditor and used against payments. - `minimum_advance_notice` integer, required: The minimum interval, in working days, between the sending of a pre-notification to the customer, and the charge date of a payment using this scheme identifier. By default, GoCardless sends these notifications automatically. Please see our [compliance requirements](https://docs.gocardless.com/docs/api-reference/compliance-requirements) for more details. - `can_specify_mandate_reference` boolean, required: Whether a custom reference can be submitted for mandates using this scheme identifier. - `currency` 'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD', required: The currency of the scheme identifier. - `address_line1` string, nullable, required: The first line of the scheme identifier's support address. - `address_line2` string, nullable, required: The second line of the scheme identifier's support address. - `address_line3` string, nullable, required: The third line of the scheme identifier's support address. - `city` string, nullable, required: The city of the scheme identifier's support address. - `region` string, nullable, required: The scheme identifier's support address region, county or department. - `postal_code` string, nullable, required: The scheme identifier's support postal code. - `country_code` string, nullable, required: [ISO 3166-1 alpha-2 code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) - `email` string, nullable, required: Scheme identifier's support email address. - `phone_number` string, nullable, required: Scheme identifier's support phone number. - `customers` Customer[]: A list of customers linked to the events returned in the list of events. - `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"). - `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) - `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. - `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). - `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. ## 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)