Can I use GoCardless as a CLI?

Yes. KosmoKrator exposes a GoCardless CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose GoCardless through MCP?

Yes. The KosmoKrator MCP gateway can expose selected GoCardless tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are GoCardless credentials stored?

GoCardless credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for GoCardless MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

GoCardless Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the GoCardless KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.gocardless.*. Use lua_read_doc("integrations.gocardless") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic GoCardless workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.gocardless.list_balance({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("gocardless"))' --json
kosmo integrations:lua --eval 'print(docs.read("gocardless.list_balance"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local gocardless = app.integrations.gocardless
local result = gocardless.list_balance({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.gocardless, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.gocardless.default.* or app.integrations.gocardless.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need GoCardless, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

GoCardless Integration

Use the gocardless integration to manage GoCardless payments, mandates, billing requests, customers, creditor bank accounts, subscriptions, instalment schedules, outbound payments, payouts, refunds, institutions, events, webhooks, and related actions.

All tools are generated from the official GoCardless OpenAPI document at https://developer.gocardless.com/openapi-schema-public.json. Configure a GoCardless access token; runtime calls send Authorization: Bearer <access_token> and GoCardless-Version: 2015-07-06 by default.

Common Tools

gocardless_list_payment, gocardless_create_payment, gocardless_get_payments, gocardless_update_payments, gocardless_cancel_payment, and gocardless_retry_payment handle payment lifecycle operations.
gocardless_list_mandate, gocardless_create_mandate, gocardless_get_mandates, gocardless_update_mandates, gocardless_cancel_mandate, and gocardless_reinstate_mandate manage mandates.
gocardless_list_billing_request, gocardless_create_billing_request, and the gocardless_*_billing_request action tools manage billing request collection and fulfilment workflows.
Customer, creditor, payout, refund, subscription, institution, event, export, webhook, and verification tools map directly to the official endpoints.

Request Shape

Path and query parameters are exposed as snake_case tool parameters. JSON request bodies are passed through the body object and should match the official GoCardless schema for that endpoint. Write tools also accept idempotency_key, which is sent as the Idempotency-Key header for safe retries.

gocardless_get_bank_account_details also requires gc_key_id, which is sent as the Gc-Key-Id header for encrypted bank account detail access.

Return Shape

JSON responses are returned as decoded arrays/objects from GoCardless. Empty successful responses return { success = true, status = <http_status> }.

Examples

local payments = app.integrations.gocardless.list_payment({
  limit = 20,
  created_at_gte = "2026-01-01T00:00:00Z"
})

local payment = app.integrations.gocardless.create_payment({
  idempotency_key = "example-payment-key-001",
  body = {
    payments = {
      amount = 1299,
      currency = "GBP",
      links = { mandate = "MD000000000000" },
      metadata = { order_id = "example-order-001" }
    }
  }
})

local mandate = app.integrations.gocardless.get_mandates({ mandate_id = "MD000000000000" })

Use fake IDs and example metadata in tests and prompts. Do not place real customer names, bank details, mandate IDs, payment IDs, webhooks, emails, access tokens, or creditor data in fixtures or Lua examples.

Raw agent markdown

# GoCardless Integration

Use the `gocardless` integration to manage GoCardless payments, mandates, billing requests, customers, creditor bank accounts, subscriptions, instalment schedules, outbound payments, payouts, refunds, institutions, events, webhooks, and related actions.

All tools are generated from the official GoCardless OpenAPI document at `https://developer.gocardless.com/openapi-schema-public.json`. Configure a GoCardless access token; runtime calls send `Authorization: Bearer <access_token>` and `GoCardless-Version: 2015-07-06` by default.

## Common Tools

- `gocardless_list_payment`, `gocardless_create_payment`, `gocardless_get_payments`, `gocardless_update_payments`, `gocardless_cancel_payment`, and `gocardless_retry_payment` handle payment lifecycle operations.
- `gocardless_list_mandate`, `gocardless_create_mandate`, `gocardless_get_mandates`, `gocardless_update_mandates`, `gocardless_cancel_mandate`, and `gocardless_reinstate_mandate` manage mandates.
- `gocardless_list_billing_request`, `gocardless_create_billing_request`, and the `gocardless_*_billing_request` action tools manage billing request collection and fulfilment workflows.
- Customer, creditor, payout, refund, subscription, institution, event, export, webhook, and verification tools map directly to the official endpoints.

## Request Shape

Path and query parameters are exposed as snake_case tool parameters. JSON request bodies are passed through the `body` object and should match the official GoCardless schema for that endpoint. Write tools also accept `idempotency_key`, which is sent as the `Idempotency-Key` header for safe retries.

`gocardless_get_bank_account_details` also requires `gc_key_id`, which is sent as the `Gc-Key-Id` header for encrypted bank account detail access.

## Return Shape

JSON responses are returned as decoded arrays/objects from GoCardless. Empty successful responses return `{ success = true, status = <http_status> }`.

## Examples

```lua
local payments = app.integrations.gocardless.list_payment({
  limit = 20,
  created_at_gte = "2026-01-01T00:00:00Z"
})

local payment = app.integrations.gocardless.create_payment({
  idempotency_key = "example-payment-key-001",
  body = {
    payments = {
      amount = 1299,
      currency = "GBP",
      links = { mandate = "MD000000000000" },
      metadata = { order_id = "example-order-001" }
    }
  }
})

local mandate = app.integrations.gocardless.get_mandates({ mandate_id = "MD000000000000" })
```

Use fake IDs and example metadata in tests and prompts. Do not place real customer names, bank details, mandate IDs, payment IDs, webhooks, emails, access tokens, or creditor data in fixtures or Lua examples.

Metadata-derived Lua example

local result = app.integrations.gocardless.list_balance({})
print(result)

Functions

list_balance Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of balances for a given creditor. This endpoint is rate limited to 60 requests per minute. Official GoCardless endpoint: GET /balances.

Lua path: app.integrations.gocardless.list_balance
Full name: gocardless.gocardless_list_balance

Parameter	Type	Required	Description
No parameters.

get_bank_account_details Read

Returns bank account details in the flattened JSON Web Encryption format described in RFC 7516. You must specify a `Gc-Key-Id` header when using this endpoint. See [Public Key Setup](https://developer.gocardless.com/gc-embed/bank-details-access#public_key_setup) for more details. Official GoCardless endpoint: GET /bank_account_details/{customer_bank_account_id}.

Lua path: app.integrations.gocardless.get_bank_account_details
Full name: gocardless.gocardless_get_bank_account_details

Parameter	Type	Required	Description
`customer_bank_account_id`	string	yes	The customer bank account id
`gc_key_id`	string	yes	Public key identifier sent as the Gc-Key-Id header for encrypted bank account details.

create_bank_account_holder_verification Write

Verify the account holder of the bank account. A complete verification can be attached when creating an outbound payment. This endpoint allows partner merchants to create Confirmation of Payee checks on customer bank accounts before sending outbound payments. Official GoCardless endpoint: POST /bank_account_holder_verifications.

Lua path: app.integrations.gocardless.create_bank_account_holder_verification
Full name: gocardless.gocardless_create_bank_account_holder_verification

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

get_bank_account_holder_verifications Read

Fetches a bank account holder verification by ID. Official GoCardless endpoint: GET /bank_account_holder_verifications/{bank_account_holder_verification_id}.

Lua path: app.integrations.gocardless.get_bank_account_holder_verifications
Full name: gocardless.gocardless_get_bank_account_holder_verifications

Parameter	Type	Required	Description
`bank_account_holder_verification_id`	string	yes	The bank account holder verification id

create_bank_authorisation Write

Create a Bank Authorisation. Official GoCardless endpoint: POST /bank_authorisations.

Lua path: app.integrations.gocardless.create_bank_authorisation
Full name: gocardless.gocardless_create_bank_authorisation

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

get_bank_authorisations Read

Get a single bank authorisation. Official GoCardless endpoint: GET /bank_authorisations/{bank_authorisation_id}.

Lua path: app.integrations.gocardless.get_bank_authorisations
Full name: gocardless.gocardless_get_bank_authorisations

Parameter	Type	Required	Description
`bank_authorisation_id`	string	yes	The bank authorisation id

create_bank_details_lookup Write

Perform a bank details lookup Official GoCardless endpoint: POST /bank_details_lookups.

Lua path: app.integrations.gocardless.create_bank_details_lookup
Full name: gocardless.gocardless_create_bank_details_lookup

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_billing_request Write

Important: All properties associated with `subscription_request` and `instalment_schedule_request` are only supported for ACH and PAD schemes. Official GoCardless endpoint: POST /billing_requests.

Lua path: app.integrations.gocardless.create_billing_request
Full name: gocardless.gocardless_create_billing_request

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_billing_request Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your billing requests. Official GoCardless endpoint: GET /billing_requests.

Lua path: app.integrations.gocardless.list_billing_request
Full name: gocardless.gocardless_list_billing_request

Parameter	Type	Required	Description
No parameters.

collect_customer_details_billing_request Read

Collect customer details Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/collect_customer_details.

Lua path: app.integrations.gocardless.collect_customer_details_billing_request
Full name: gocardless.gocardless_collect_customer_details_billing_request

Parameter	Type	Required	Description
`billing_request_id`	string	yes	The billing request id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

collect_bank_account_billing_request Read

Collect bank account details Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/collect_bank_account.

Lua path: app.integrations.gocardless.collect_bank_account_billing_request
Full name: gocardless.gocardless_collect_bank_account_billing_request

Parameter	Type	Required	Description
`billing_request_id`	string	yes	The billing request id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

confirm_payer_details_billing_request Read

This is needed when you have a mandate request. As a scheme compliance rule we are required to allow the payer to crosscheck the details entered by them and confirm it. Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/confirm_payer_details.

Lua path: app.integrations.gocardless.confirm_payer_details_billing_request
Full name: gocardless.gocardless_confirm_payer_details_billing_request

Parameter	Type	Required	Description
`billing_request_id`	string	yes	The billing request id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

fulfil_billing_request Read

If a billing request is ready to be fulfilled, call this endpoint to cause it to fulfil, executing the payment. Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/fulfil.

Lua path: app.integrations.gocardless.fulfil_billing_request
Full name: gocardless.gocardless_fulfil_billing_request

Parameter	Type	Required	Description
`billing_request_id`	string	yes	The billing request id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

cancel_billing_request Write

Immediately cancels a billing request, causing all billing request flows to expire. Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/cancel.

Lua path: app.integrations.gocardless.cancel_billing_request
Full name: gocardless.gocardless_cancel_billing_request

Parameter	Type	Required	Description
`billing_request_id`	string	yes	The billing request id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

get_billing_requests Read

Fetches a billing request Official GoCardless endpoint: GET /billing_requests/{billing_request_id}.

Lua path: app.integrations.gocardless.get_billing_requests
Full name: gocardless.gocardless_get_billing_requests

Parameter	Type	Required	Description
`billing_request_id`	string	yes	The billing request id

notify_billing_request Read

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 Instant Bank Pay Billing Requests. Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/notify.

Lua path: app.integrations.gocardless.notify_billing_request
Full name: gocardless.gocardless_notify_billing_request

Parameter	Type	Required	Description
`billing_request_id`	string	yes	The billing request id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

fallback_billing_request Read

Triggers a fallback from the open-banking flow to direct debit. Note, the billing request must have fallback enabled. Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/fallback.

Lua path: app.integrations.gocardless.fallback_billing_request
Full name: gocardless.gocardless_fallback_billing_request

Parameter	Type	Required	Description
`billing_request_id`	string	yes	The billing request id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

choose_currency_billing_request Read

This will allow for the updating of the currency and subsequently the scheme if needed for a Billing Request. This will only be available for mandate only flows which do not have the lock_currency flag set to true on the Billing Request Flow. It will also not support any request which has a payments request. Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/choose_currency.

Lua path: app.integrations.gocardless.choose_currency_billing_request
Full name: gocardless.gocardless_choose_currency_billing_request

Parameter	Type	Required	Description
`billing_request_id`	string	yes	The billing request id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

select_institution_billing_request Read

Creates an Institution object and attaches it to the Billing Request Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/select_institution.

Lua path: app.integrations.gocardless.select_institution_billing_request
Full name: gocardless.gocardless_select_institution_billing_request

Parameter	Type	Required	Description
`billing_request_id`	string	yes	The billing request id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_billing_request_flow Write

Creates a new billing request flow. Official GoCardless endpoint: POST /billing_request_flows.

Lua path: app.integrations.gocardless.create_billing_request_flow
Full name: gocardless.gocardless_create_billing_request_flow

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

initialise_billing_request_flow Read

Returns the flow having generated a fresh session token which can be used to power integrations that manipulate the flow. Official GoCardless endpoint: POST /billing_request_flows/{billing_request_flow_id}/actions/initialise.

Lua path: app.integrations.gocardless.initialise_billing_request_flow
Full name: gocardless.gocardless_initialise_billing_request_flow

Parameter	Type	Required	Description
`billing_request_flow_id`	string	yes	The billing request flow id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_billing_request_template Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your Billing Request Templates. Official GoCardless endpoint: GET /billing_request_templates.

Lua path: app.integrations.gocardless.list_billing_request_template
Full name: gocardless.gocardless_list_billing_request_template

Parameter	Type	Required	Description
No parameters.

create_billing_request_template Write

Create a Billing Request Template Official GoCardless endpoint: POST /billing_request_templates.

Lua path: app.integrations.gocardless.create_billing_request_template
Full name: gocardless.gocardless_create_billing_request_template

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

get_billing_request_templates Read

Fetches a Billing Request Template Official GoCardless endpoint: GET /billing_request_templates/{billing_request_template_id}.

Lua path: app.integrations.gocardless.get_billing_request_templates
Full name: gocardless.gocardless_get_billing_request_templates

Parameter	Type	Required	Description
`billing_request_template_id`	string	yes	The billing request template id

update_billing_request_templates Write

Updates a Billing Request Template, which will affect all future Billing Requests created by this template. Official GoCardless endpoint: PUT /billing_request_templates/{billing_request_template_id}.

Lua path: app.integrations.gocardless.update_billing_request_templates
Full name: gocardless.gocardless_update_billing_request_templates

Parameter	Type	Required	Description
`billing_request_template_id`	string	yes	The billing request template id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_with_actions_billing_requests Write

Creates a billing request and completes any specified actions in a single request. This endpoint allows you to create a billing request and immediately complete actions such as collecting customer details, bank account details, or other required actions. Official GoCardless endpoint: POST /billing_requests/create_with_actions.

Lua path: app.integrations.gocardless.create_with_actions_billing_requests
Full name: gocardless.gocardless_create_with_actions_billing_requests

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_block Write

Creates a new Block of a given type. By default it will be active. Official GoCardless endpoint: POST /blocks.

Lua path: app.integrations.gocardless.create_block
Full name: gocardless.gocardless_create_block

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_block Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your blocks. Official GoCardless endpoint: GET /blocks.

Lua path: app.integrations.gocardless.list_block
Full name: gocardless.gocardless_list_block

Parameter	Type	Required	Description
No parameters.

get_blocks Read

Retrieves the details of an existing block. Official GoCardless endpoint: GET /blocks/{block_id}.

Lua path: app.integrations.gocardless.get_blocks
Full name: gocardless.gocardless_get_blocks

Parameter	Type	Required	Description
`block_id`	string	yes	The block id

disable_block Write

Disables a block so that it no longer will prevent mandate creation. Official GoCardless endpoint: POST /blocks/{block_id}/actions/disable.

Lua path: app.integrations.gocardless.disable_block
Full name: gocardless.gocardless_disable_block

Parameter	Type	Required	Description
`block_id`	string	yes	The block id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

enable_block Write

Enables a previously disabled block so that it will prevent mandate creation Official GoCardless endpoint: POST /blocks/{block_id}/actions/enable.

Lua path: app.integrations.gocardless.enable_block
Full name: gocardless.gocardless_enable_block

Parameter	Type	Required	Description
`block_id`	string	yes	The block id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

block_by_ref_blocks Read

Creates new blocks for a given reference. By default blocks will be active. Returns 201 if at least one block was created. Returns 200 if there were no new blocks created. Official GoCardless endpoint: POST /blocks/block_by_ref.

Lua path: app.integrations.gocardless.block_by_ref_blocks
Full name: gocardless.gocardless_block_by_ref_blocks

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_creditor Write

Creates a new creditor. Official GoCardless endpoint: POST /creditors.

Lua path: app.integrations.gocardless.create_creditor
Full name: gocardless.gocardless_create_creditor

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_creditor Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your creditors. Official GoCardless endpoint: GET /creditors.

Lua path: app.integrations.gocardless.list_creditor
Full name: gocardless.gocardless_list_creditor

Parameter	Type	Required	Description
No parameters.

get_creditors Read

Retrieves the details of an existing creditor. Official GoCardless endpoint: GET /creditors/{creditor_id}.

Lua path: app.integrations.gocardless.get_creditors
Full name: gocardless.gocardless_get_creditors

Parameter	Type	Required	Description
`creditor_id`	string	yes	The creditor id

update_creditors Write

Updates a creditor object. Supports all of the fields supported when creating a creditor. Official GoCardless endpoint: PUT /creditors/{creditor_id}.

Lua path: app.integrations.gocardless.update_creditors
Full name: gocardless.gocardless_update_creditors

Parameter	Type	Required	Description
`creditor_id`	string	yes	The creditor id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_creditor_bank_account Write

Creates a new creditor bank account object. Official GoCardless endpoint: POST /creditor_bank_accounts.

Lua path: app.integrations.gocardless.create_creditor_bank_account
Full name: gocardless.gocardless_create_creditor_bank_account

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_creditor_bank_account Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your creditor bank accounts. Official GoCardless endpoint: GET /creditor_bank_accounts.

Lua path: app.integrations.gocardless.list_creditor_bank_account
Full name: gocardless.gocardless_list_creditor_bank_account

Parameter	Type	Required	Description
No parameters.

get_creditor_bank_accounts Read

Retrieves the details of an existing creditor bank account. Official GoCardless endpoint: GET /creditor_bank_accounts/{creditor_bank_account_id}.

Lua path: app.integrations.gocardless.get_creditor_bank_accounts
Full name: gocardless.gocardless_get_creditor_bank_accounts

Parameter	Type	Required	Description
`creditor_bank_account_id`	string	yes	The creditor bank account id

disable_creditor_bank_account Write

Immediately disables the bank account, no money can be paid out to a disabled account. This will return a `disable_failed` error if the bank account has already been disabled. A disabled bank account can be re-enabled by creating a new bank account resource with the same details. Official GoCardless endpoint: POST /creditor_bank_accounts/{creditor_bank_account_id}/actions/disable.

Lua path: app.integrations.gocardless.disable_creditor_bank_account
Full name: gocardless.gocardless_disable_creditor_bank_account

Parameter	Type	Required	Description
`creditor_bank_account_id`	string	yes	The creditor bank account id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_currency_exchange_rate Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of all exchange rates. Official GoCardless endpoint: GET /currency_exchange_rates.

Lua path: app.integrations.gocardless.list_currency_exchange_rate
Full name: gocardless.gocardless_list_currency_exchange_rate

Parameter	Type	Required	Description
No parameters.

create_customer Write

Creates a new customer object. Official GoCardless endpoint: POST /customers.

Lua path: app.integrations.gocardless.create_customer
Full name: gocardless.gocardless_create_customer

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_customer Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your customers. Official GoCardless endpoint: GET /customers.

Lua path: app.integrations.gocardless.list_customer
Full name: gocardless.gocardless_list_customer

Parameter	Type	Required	Description
No parameters.

get_customers Read

Retrieves the details of an existing customer. Official GoCardless endpoint: GET /customers/{customer_id}.

Lua path: app.integrations.gocardless.get_customers
Full name: gocardless.gocardless_get_customers

Parameter	Type	Required	Description
`customer_id`	string	yes	The customer id

update_customers Write

Updates a customer object. Supports all of the fields supported when creating a customer. Official GoCardless endpoint: PUT /customers/{customer_id}.

Lua path: app.integrations.gocardless.update_customers
Full name: gocardless.gocardless_update_customers

Parameter	Type	Required	Description
`customer_id`	string	yes	The customer id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

delete_customers Write

Removed customers will not appear in search results or lists of customers (in our API or exports), and it will not be possible to load an individually removed customer by ID. The action of removing a customer cannot be reversed, so please use with care. Official GoCardless endpoint: DELETE /customers/{customer_id}.

Lua path: app.integrations.gocardless.delete_customers
Full name: gocardless.gocardless_delete_customers

Parameter	Type	Required	Description
`customer_id`	string	yes	The customer id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.

create_customer_bank_account Write

Creates a new customer bank account object. There are three different ways to supply bank account details: - [Local details](#appendix-local-bank-details) - IBAN - [Customer Bank Account Tokens](#javascript-flow-create-a-customer-bank-account-token) For more information on the different fields required in each country, see [local bank details](#appendix-local-bank-details). Official GoCardless endpoint: POST /customer_bank_accounts.

Lua path: app.integrations.gocardless.create_customer_bank_account
Full name: gocardless.gocardless_create_customer_bank_account

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_customer_bank_account Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your bank accounts. Official GoCardless endpoint: GET /customer_bank_accounts.

Lua path: app.integrations.gocardless.list_customer_bank_account
Full name: gocardless.gocardless_list_customer_bank_account

Parameter	Type	Required	Description
No parameters.

get_customer_bank_accounts Read

Retrieves the details of an existing bank account. Official GoCardless endpoint: GET /customer_bank_accounts/{customer_bank_account_id}.

Lua path: app.integrations.gocardless.get_customer_bank_accounts
Full name: gocardless.gocardless_get_customer_bank_accounts

Parameter	Type	Required	Description
`customer_bank_account_id`	string	yes	The customer bank account id

update_customer_bank_accounts Write

Updates a customer bank account object. Only the metadata parameter is allowed. Official GoCardless endpoint: PUT /customer_bank_accounts/{customer_bank_account_id}.

Lua path: app.integrations.gocardless.update_customer_bank_accounts
Full name: gocardless.gocardless_update_customer_bank_accounts

Parameter	Type	Required	Description
`customer_bank_account_id`	string	yes	The customer bank account id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

disable_customer_bank_account Write

Immediately cancels all associated mandates and cancellable payments. This will return a `disable_failed` error if the bank account has already been disabled. A disabled bank account can be re-enabled by creating a new bank account resource with the same details. Official GoCardless endpoint: POST /customer_bank_accounts/{customer_bank_account_id}/actions/disable.

Lua path: app.integrations.gocardless.disable_customer_bank_account
Full name: gocardless.gocardless_disable_customer_bank_account

Parameter	Type	Required	Description
`customer_bank_account_id`	string	yes	The customer bank account id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

handle_customer_notification Read

"Handling" a notification means that you have sent the notification yourself (and don't want GoCardless to send it). If the notification has already been actioned, or the deadline to notify has passed, this endpoint will return an `already_actioned` error and you should not take further action. This endpoint takes no additional parameters. Official GoCardless endpoint: POST /customer_notifications/{customer_notification_id}/actions/handle.

Lua path: app.integrations.gocardless.handle_customer_notification
Full name: gocardless.gocardless_handle_customer_notification

Parameter	Type	Required	Description
`customer_notification_id`	string	yes	The customer notification id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_event Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your events. Official GoCardless endpoint: GET /events.

Lua path: app.integrations.gocardless.list_event
Full name: gocardless.gocardless_list_event

Parameter	Type	Required	Description
No parameters.

get_events Read

Retrieves the details of a single event. Official GoCardless endpoint: GET /events/{event_id}.

Lua path: app.integrations.gocardless.get_events
Full name: gocardless.gocardless_get_events

Parameter	Type	Required	Description
`event_id`	string	yes	The event id

get_exports Read

Returns a single export. Official GoCardless endpoint: GET /exports/{export_id}.

Lua path: app.integrations.gocardless.get_exports
Full name: gocardless.gocardless_get_exports

Parameter	Type	Required	Description
`export_id`	string	yes	The export id

list_export Read

Returns a list of exports which are available for download. Official GoCardless endpoint: GET /exports.

Lua path: app.integrations.gocardless.list_export
Full name: gocardless.gocardless_list_export

Parameter	Type	Required	Description
No parameters.

get_funds_availability Read

Checks if the payer's current balance is sufficient to cover the amount the merchant wants to charge within the consent parameters defined on the mandate. Official GoCardless endpoint: GET /funds_availability/{mandate_id}.

Lua path: app.integrations.gocardless.get_funds_availability
Full name: gocardless.gocardless_get_funds_availability

Parameter	Type	Required	Description
`mandate_id`	string	yes	The mandate id

create_instalment_schedule Write

Create (with schedule) Official GoCardless endpoint: POST /instalment_schedules.

Lua path: app.integrations.gocardless.create_instalment_schedule
Full name: gocardless.gocardless_create_instalment_schedule

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_instalment_schedule Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your instalment schedules. Official GoCardless endpoint: GET /instalment_schedules.

Lua path: app.integrations.gocardless.list_instalment_schedule
Full name: gocardless.gocardless_list_instalment_schedule

Parameter	Type	Required	Description
No parameters.

get_instalment_schedules Read

Retrieves the details of an existing instalment schedule. Official GoCardless endpoint: GET /instalment_schedules/{instalment_schedule_id}.

Lua path: app.integrations.gocardless.get_instalment_schedules
Full name: gocardless.gocardless_get_instalment_schedules

Parameter	Type	Required	Description
`instalment_schedule_id`	string	yes	The instalment schedule id

update_instalment_schedules Write

Updates an instalment schedule. This accepts only the metadata parameter. Official GoCardless endpoint: PUT /instalment_schedules/{instalment_schedule_id}.

Lua path: app.integrations.gocardless.update_instalment_schedules
Full name: gocardless.gocardless_update_instalment_schedules

Parameter	Type	Required	Description
`instalment_schedule_id`	string	yes	The instalment schedule id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

cancel_instalment_schedule Write

Immediately cancels an instalment schedule; no further payments will be collected for it. This will fail with a `cancellation_failed` error if the instalment schedule is already cancelled or has completed. Official GoCardless endpoint: POST /instalment_schedules/{instalment_schedule_id}/actions/cancel.

Lua path: app.integrations.gocardless.cancel_instalment_schedule
Full name: gocardless.gocardless_cancel_instalment_schedule

Parameter	Type	Required	Description
`instalment_schedule_id`	string	yes	The instalment schedule id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_institution Read

Returns a list of supported institutions. Official GoCardless endpoint: GET /institutions.

Lua path: app.integrations.gocardless.list_institution
Full name: gocardless.gocardless_list_institution

Parameter	Type	Required	Description
No parameters.

get_institutions_from_institution Read

Returns all institutions valid for a Billing Request. This endpoint is currently supported only for FasterPayments. Official GoCardless endpoint: GET /billing_requests/{billing_request_id}/institutions.

Lua path: app.integrations.gocardless.get_institutions_from_institution
Full name: gocardless.gocardless_get_institutions_from_institution

Parameter	Type	Required	Description
`billing_request_id`	string	yes	The billing request id

logos_branding Read

Create a logo associated with a creditor Official GoCardless endpoint: POST /branding/logos.

Lua path: app.integrations.gocardless.logos_branding
Full name: gocardless.gocardless_logos_branding

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_mandate Write

Creates a new mandate object. Official GoCardless endpoint: POST /mandates.

Lua path: app.integrations.gocardless.create_mandate
Full name: gocardless.gocardless_create_mandate

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_mandate Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your mandates. Official GoCardless endpoint: GET /mandates.

Lua path: app.integrations.gocardless.list_mandate
Full name: gocardless.gocardless_list_mandate

Parameter	Type	Required	Description
No parameters.

get_mandates Read

Retrieves the details of an existing mandate. Official GoCardless endpoint: GET /mandates/{mandate_id}.

Lua path: app.integrations.gocardless.get_mandates
Full name: gocardless.gocardless_get_mandates

Parameter	Type	Required	Description
`mandate_id`	string	yes	The mandate id

update_mandates Write

Updates a mandate object. This accepts only the metadata parameter. Official GoCardless endpoint: PUT /mandates/{mandate_id}.

Lua path: app.integrations.gocardless.update_mandates
Full name: gocardless.gocardless_update_mandates

Parameter	Type	Required	Description
`mandate_id`	string	yes	The mandate id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

cancel_mandate Write

Immediately cancels a mandate and all associated cancellable payments. Any metadata supplied to this endpoint will be stored on the mandate cancellation event it causes. This will fail with a `cancellation_failed` error if the mandate is already cancelled. Official GoCardless endpoint: POST /mandates/{mandate_id}/actions/cancel.

Lua path: app.integrations.gocardless.cancel_mandate
Full name: gocardless.gocardless_cancel_mandate

Parameter	Type	Required	Description
`mandate_id`	string	yes	The mandate id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

reinstate_mandate Read

Reinstate a mandate Official GoCardless endpoint: POST /mandates/{mandate_id}/actions/reinstate.

Lua path: app.integrations.gocardless.reinstate_mandate
Full name: gocardless.gocardless_reinstate_mandate

Parameter	Type	Required	Description
`mandate_id`	string	yes	The mandate id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_mandate_import Write

Mandate imports are first created, before mandates are added one-at-a-time, so this endpoint merely signals the start of the import process. Once you've finished adding entries to an import, you should [submit](#mandate-imports-submit-a-mandate-import) it. Official GoCardless endpoint: POST /mandate_imports.

Lua path: app.integrations.gocardless.create_mandate_import
Full name: gocardless.gocardless_create_mandate_import

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

get_mandate_imports Read

Returns a single mandate import. Official GoCardless endpoint: GET /mandate_imports/{mandate_import_id}.

Lua path: app.integrations.gocardless.get_mandate_imports
Full name: gocardless.gocardless_get_mandate_imports

Parameter	Type	Required	Description
`mandate_import_id`	string	yes	The mandate import id

submit_mandate_import Write

Submit a mandate import Official GoCardless endpoint: POST /mandate_imports/{mandate_import_id}/actions/submit.

Lua path: app.integrations.gocardless.submit_mandate_import
Full name: gocardless.gocardless_submit_mandate_import

Parameter	Type	Required	Description
`mandate_import_id`	string	yes	The mandate import id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

cancel_mandate_import Write

Cancels the mandate import, which aborts the import process and stops the mandates being set up in GoCardless. Once the import has been cancelled, it can no longer have entries added to it. Mandate imports which have already been submitted or processed cannot be cancelled. Official GoCardless endpoint: POST /mandate_imports/{mandate_import_id}/actions/cancel.

Lua path: app.integrations.gocardless.cancel_mandate_import
Full name: gocardless.gocardless_cancel_mandate_import

Parameter	Type	Required	Description
`mandate_import_id`	string	yes	The mandate import id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_mandate_import_entry Write

For an existing [mandate import](#core-endpoints-mandate-imports), this endpoint can be used to add individual mandates to be imported into GoCardless. You can add no more than 30,000 rows to a single mandate import. If you attempt to go over this limit, the API will return a `record_limit_exceeded` error. Official GoCardless endpoint: POST /mandate_import_entries.

Lua path: app.integrations.gocardless.create_mandate_import_entry
Full name: gocardless.gocardless_create_mandate_import_entry

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_mandate_import_entry Read

For an existing mandate import, this endpoint lists all of the entries attached. After a mandate import has been submitted, you can use this endpoint to associate records in your system (using the `record_identifier` that you provided when creating the mandate import). Official GoCardless endpoint: GET /mandate_import_entries.

Lua path: app.integrations.gocardless.list_mandate_import_entry
Full name: gocardless.gocardless_list_mandate_import_entry

Parameter	Type	Required	Description
No parameters.

create_mandate_pdf Write

Create a mandate PDF Official GoCardless endpoint: POST /mandate_pdfs.

Lua path: app.integrations.gocardless.create_mandate_pdf
Full name: gocardless.gocardless_create_mandate_pdf

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_negative_balance_limit Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of negative balance limits. Official GoCardless endpoint: GET /negative_balance_limits.

Lua path: app.integrations.gocardless.list_negative_balance_limit
Full name: gocardless.gocardless_list_negative_balance_limit

Parameter	Type	Required	Description
No parameters.

create_outbound_payment Write

Create an outbound payment Official GoCardless endpoint: POST /outbound_payments.

Lua path: app.integrations.gocardless.create_outbound_payment
Full name: gocardless.gocardless_create_outbound_payment

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_outbound_payment Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of outbound payments. Official GoCardless endpoint: GET /outbound_payments.

Lua path: app.integrations.gocardless.list_outbound_payment
Full name: gocardless.gocardless_list_outbound_payment

Parameter	Type	Required	Description
No parameters.

withdrawal_outbound_payments Read

Creates an outbound payment to your verified business bank account as the recipient. Official GoCardless endpoint: POST /outbound_payments/withdrawal.

Lua path: app.integrations.gocardless.withdrawal_outbound_payments
Full name: gocardless.gocardless_withdrawal_outbound_payments

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

cancel_outbound_payment Write

Cancels an outbound payment. Only outbound payments with either `verifying`, `pending_approval`, or `scheduled` status can be cancelled. Once an outbound payment is `executing`, the money moving process has begun and cannot be reversed. Official GoCardless endpoint: POST /outbound_payments/{outbound_payment_id}/actions/cancel.

Lua path: app.integrations.gocardless.cancel_outbound_payment
Full name: gocardless.gocardless_cancel_outbound_payment

Parameter	Type	Required	Description
`outbound_payment_id`	string	yes	The outbound payment id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

approve_outbound_payment Read

Approves an outbound payment. Only outbound payments with the “pending_approval” status can be approved. Official GoCardless endpoint: POST /outbound_payments/{outbound_payment_id}/actions/approve.

Lua path: app.integrations.gocardless.approve_outbound_payment
Full name: gocardless.gocardless_approve_outbound_payment

Parameter	Type	Required	Description
`outbound_payment_id`	string	yes	The outbound payment id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

get_outbound_payments Read

Fetches an outbound_payment by ID Official GoCardless endpoint: GET /outbound_payments/{outbound_payment_id}.

Lua path: app.integrations.gocardless.get_outbound_payments
Full name: gocardless.gocardless_get_outbound_payments

Parameter	Type	Required	Description
`outbound_payment_id`	string	yes	The outbound payment id

update_outbound_payments Write

Updates an outbound payment object. This accepts only the metadata parameter. Official GoCardless endpoint: PUT /outbound_payments/{outbound_payment_id}.

Lua path: app.integrations.gocardless.update_outbound_payments
Full name: gocardless.gocardless_update_outbound_payments

Parameter	Type	Required	Description
`outbound_payment_id`	string	yes	The outbound payment id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_outbound_payments_stats Read

Retrieve aggregate statistics on outbound payments. Official GoCardless endpoint: GET /outbound_payments/stats.

Lua path: app.integrations.gocardless.list_outbound_payments_stats
Full name: gocardless.gocardless_list_outbound_payments_stats

Parameter	Type	Required	Description
No parameters.

create_outbound_payment_import Write

Create an outbound payment import Official GoCardless endpoint: POST /outbound_payment_imports.

Lua path: app.integrations.gocardless.create_outbound_payment_import
Full name: gocardless.gocardless_create_outbound_payment_import

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_outbound_payment_import Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your outbound payment imports. Official GoCardless endpoint: GET /outbound_payment_imports.

Lua path: app.integrations.gocardless.list_outbound_payment_import
Full name: gocardless.gocardless_list_outbound_payment_import

Parameter	Type	Required	Description
No parameters.

get_outbound_payment_imports Read

Returns a single outbound payment import. Official GoCardless endpoint: GET /outbound_payment_imports/{outbound_payment_import_id}.

Lua path: app.integrations.gocardless.get_outbound_payment_imports
Full name: gocardless.gocardless_get_outbound_payment_imports

Parameter	Type	Required	Description
`outbound_payment_import_id`	string	yes	The outbound payment import id

list_outbound_payment_import_entry Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of the entries for a given outbound payment import. Official GoCardless endpoint: GET /outbound_payment_import_entries.

Lua path: app.integrations.gocardless.list_outbound_payment_import_entry
Full name: gocardless.gocardless_list_outbound_payment_import_entry

Parameter	Type	Required	Description
No parameters.

get_payer_authorisations Read

Retrieves the details of a single existing Payer Authorisation. It can be used for polling the status of a Payer Authorisation. **Deprecated:** Payer Authorisation is legacy API and cannot be used by new integrators. The [Billing Request](#billing-requests) API should be used for any new integrations. Official GoCardless endpoint: GET /payer_authorisations/{payer_authorisation_id}.

Lua path: app.integrations.gocardless.get_payer_authorisations
Full name: gocardless.gocardless_get_payer_authorisations

Parameter	Type	Required	Description
`payer_authorisation_id`	string	yes	The payer authorisation id

update_payer_authorisations Write

Update a Payer Authorisation Official GoCardless endpoint: PUT /payer_authorisations/{payer_authorisation_id}.

Lua path: app.integrations.gocardless.update_payer_authorisations
Full name: gocardless.gocardless_update_payer_authorisations

Parameter	Type	Required	Description
`payer_authorisation_id`	string	yes	The payer authorisation id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_payer_authorisation Write

Create a Payer Authorisation Official GoCardless endpoint: POST /payer_authorisations.

Lua path: app.integrations.gocardless.create_payer_authorisation
Full name: gocardless.gocardless_create_payer_authorisation

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

submit_payer_authorisation Write

Submit a Payer Authorisation Official GoCardless endpoint: POST /payer_authorisations/{payer_authorisation_id}/actions/submit.

Lua path: app.integrations.gocardless.submit_payer_authorisation
Full name: gocardless.gocardless_submit_payer_authorisation

Parameter	Type	Required	Description
`payer_authorisation_id`	string	yes	The payer authorisation id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

confirm_payer_authorisation Read

Confirm a Payer Authorisation Official GoCardless endpoint: POST /payer_authorisations/{payer_authorisation_id}/actions/confirm.

Lua path: app.integrations.gocardless.confirm_payer_authorisation
Full name: gocardless.gocardless_confirm_payer_authorisation

Parameter	Type	Required	Description
`payer_authorisation_id`	string	yes	The payer authorisation id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

payer_themes_branding Read

Creates a new payer theme associated with a creditor. If a creditor already has payer themes, this will update the existing payer theme linked to the creditor. Official GoCardless endpoint: POST /branding/payer_themes.

Lua path: app.integrations.gocardless.payer_themes_branding
Full name: gocardless.gocardless_payer_themes_branding

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_payment Write

<a name="mandate_is_inactive"></a>Creates a new payment object. This fails with a `mandate_is_inactive` error if the linked [mandate](#core-endpoints-mandates) is cancelled or has failed. Payments can be created against mandates with status of: `pending_customer_approval`, `pending_submission`, `submitted`, and `active`. Official GoCardless endpoint: POST /payments.

Lua path: app.integrations.gocardless.create_payment
Full name: gocardless.gocardless_create_payment

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_payment Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your payments. Official GoCardless endpoint: GET /payments.

Lua path: app.integrations.gocardless.list_payment
Full name: gocardless.gocardless_list_payment

Parameter	Type	Required	Description
No parameters.

get_payments Read

Retrieves the details of a single existing payment. Official GoCardless endpoint: GET /payments/{payment_id}.

Lua path: app.integrations.gocardless.get_payments
Full name: gocardless.gocardless_get_payments

Parameter	Type	Required	Description
`payment_id`	string	yes	The payment id

update_payments Write

Updates a payment object. This accepts only the metadata parameter. Official GoCardless endpoint: PUT /payments/{payment_id}.

Lua path: app.integrations.gocardless.update_payments
Full name: gocardless.gocardless_update_payments

Parameter	Type	Required	Description
`payment_id`	string	yes	The payment id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

cancel_payment Write

Cancels the payment if it has not already been submitted to the banks. Any metadata supplied to this endpoint will be stored on the payment cancellation event it causes. This will fail with a `cancellation_failed` error unless the payment's status is `pending_submission`. Official GoCardless endpoint: POST /payments/{payment_id}/actions/cancel.

Lua path: app.integrations.gocardless.cancel_payment
Full name: gocardless.gocardless_cancel_payment

Parameter	Type	Required	Description
`payment_id`	string	yes	The payment id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

retry_payment Read

Retry a payment Official GoCardless endpoint: POST /payments/{payment_id}/actions/retry.

Lua path: app.integrations.gocardless.retry_payment
Full name: gocardless.gocardless_retry_payment

Parameter	Type	Required	Description
`payment_id`	string	yes	The payment id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

get_payment_accounts Read

Retrieves the details of an existing payment account. Official GoCardless endpoint: GET /payment_accounts/{payment_account_id}.

Lua path: app.integrations.gocardless.get_payment_accounts
Full name: gocardless.gocardless_get_payment_accounts

Parameter	Type	Required	Description
`payment_account_id`	string	yes	The payment account id

list_payment_account Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your payment accounts. Official GoCardless endpoint: GET /payment_accounts.

Lua path: app.integrations.gocardless.list_payment_account
Full name: gocardless.gocardless_list_payment_account

Parameter	Type	Required	Description
No parameters.

get_payment_account_transactions Read

Retrieves the details of an existing payment account transaction. Official GoCardless endpoint: GET /payment_account_transactions/{payment_account_transaction_id}.

Lua path: app.integrations.gocardless.get_payment_account_transactions
Full name: gocardless.gocardless_get_payment_account_transactions

Parameter	Type	Required	Description
`payment_account_transaction_id`	string	yes	The payment account transaction id

get_transactions_from_payment_account_transaction Read

List transactions for a given payment account. Official GoCardless endpoint: GET /payment_accounts/{payment_account_transaction_id}/transactions.

Lua path: app.integrations.gocardless.get_transactions_from_payment_account_transaction
Full name: gocardless.gocardless_get_transactions_from_payment_account_transaction

Parameter	Type	Required	Description
`payment_account_transaction_id`	string	yes	The payment account transaction id

list_payout Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your payouts. Official GoCardless endpoint: GET /payouts.

Lua path: app.integrations.gocardless.list_payout
Full name: gocardless.gocardless_list_payout

Parameter	Type	Required	Description
No parameters.

get_payouts Read

Retrieves the details of a single payout. For an example of how to reconcile the transactions in a payout, see [this guide](#events-reconciling-payouts-with-events). Official GoCardless endpoint: GET /payouts/{payout_id}.

Lua path: app.integrations.gocardless.get_payouts
Full name: gocardless.gocardless_get_payouts

Parameter	Type	Required	Description
`payout_id`	string	yes	The payout id

update_payouts Write

Updates a payout object. This accepts only the metadata parameter. Official GoCardless endpoint: PUT /payouts/{payout_id}.

Lua path: app.integrations.gocardless.update_payouts
Full name: gocardless.gocardless_update_payouts

Parameter	Type	Required	Description
`payout_id`	string	yes	The payout id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_payout_item Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of items in the payout. This endpoint only serves requests for payouts created in the last 6 months. Requests for older payouts will return an HTTP status <code>410 Gone</code>. Official GoCardless endpoint: GET /payout_items.

Lua path: app.integrations.gocardless.list_payout_item
Full name: gocardless.gocardless_list_payout_item

Parameter	Type	Required	Description
No parameters.

create_redirect_flow Write

Creates a redirect flow object which can then be used to redirect your customer to the GoCardless hosted payment pages. **Deprecated:** Redirect Flows are legacy APIs and cannot be used by new integrators. The [Billing Request flow](#billing-requests) API should be used for your payment flows. Official GoCardless endpoint: POST /redirect_flows.

Lua path: app.integrations.gocardless.create_redirect_flow
Full name: gocardless.gocardless_create_redirect_flow

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

get_redirect_flows Read

Returns all details about a single redirect flow **Deprecated:** Redirect Flows are legacy APIs and cannot be used by new integrators. The [Billing Request flow](#billing-requests) API should be used for your payment flows. Official GoCardless endpoint: GET /redirect_flows/{redirect_flow_id}.

Lua path: app.integrations.gocardless.get_redirect_flows
Full name: gocardless.gocardless_get_redirect_flows

Parameter	Type	Required	Description
`redirect_flow_id`	string	yes	The redirect flow id

complete_redirect_flow Read

Complete a redirect flow Official GoCardless endpoint: POST /redirect_flows/{redirect_flow_id}/actions/complete.

Lua path: app.integrations.gocardless.complete_redirect_flow
Full name: gocardless.gocardless_complete_redirect_flow

Parameter	Type	Required	Description
`redirect_flow_id`	string	yes	The redirect flow id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_refund Write

Create a refund Official GoCardless endpoint: POST /refunds.

Lua path: app.integrations.gocardless.create_refund
Full name: gocardless.gocardless_create_refund

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_refund Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your refunds. Official GoCardless endpoint: GET /refunds.

Lua path: app.integrations.gocardless.list_refund
Full name: gocardless.gocardless_list_refund

Parameter	Type	Required	Description
No parameters.

get_refunds Read

Retrieves all details for a single refund Official GoCardless endpoint: GET /refunds/{refund_id}.

Lua path: app.integrations.gocardless.get_refunds
Full name: gocardless.gocardless_get_refunds

Parameter	Type	Required	Description
`refund_id`	string	yes	The refund id

update_refunds Write

Updates a refund object. Official GoCardless endpoint: PUT /refunds/{refund_id}.

Lua path: app.integrations.gocardless.update_refunds
Full name: gocardless.gocardless_update_refunds

Parameter	Type	Required	Description
`refund_id`	string	yes	The refund id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

run_scenario_simulator Write

Runs the specific scenario simulator against the specific resource Official GoCardless endpoint: POST /scenario_simulators/{scenario_simulator_id}/actions/run.

Lua path: app.integrations.gocardless.run_scenario_simulator
Full name: gocardless.gocardless_run_scenario_simulator

Parameter	Type	Required	Description
`scenario_simulator_id`	string	yes	The scenario simulator id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

create_scheme_identifier Write

Create a scheme identifier Official GoCardless endpoint: POST /scheme_identifiers.

Lua path: app.integrations.gocardless.create_scheme_identifier
Full name: gocardless.gocardless_create_scheme_identifier

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_scheme_identifier Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your scheme identifiers. Official GoCardless endpoint: GET /scheme_identifiers.

Lua path: app.integrations.gocardless.list_scheme_identifier
Full name: gocardless.gocardless_list_scheme_identifier

Parameter	Type	Required	Description
No parameters.

get_scheme_identifiers Read

Retrieves the details of an existing scheme identifier. Official GoCardless endpoint: GET /scheme_identifiers/{scheme_identifier_id}.

Lua path: app.integrations.gocardless.get_scheme_identifiers
Full name: gocardless.gocardless_get_scheme_identifiers

Parameter	Type	Required	Description
`scheme_identifier_id`	string	yes	The scheme identifier id

create_subscription Write

Creates a new subscription object Official GoCardless endpoint: POST /subscriptions.

Lua path: app.integrations.gocardless.create_subscription
Full name: gocardless.gocardless_create_subscription

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_subscription Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your subscriptions. Please note if the subscriptions are related to customers who have been removed, they will not be shown in the response. Official GoCardless endpoint: GET /subscriptions.

Lua path: app.integrations.gocardless.list_subscription
Full name: gocardless.gocardless_list_subscription

Parameter	Type	Required	Description
No parameters.

get_subscriptions Read

Retrieves the details of a single subscription. Official GoCardless endpoint: GET /subscriptions/{subscription_id}.

Lua path: app.integrations.gocardless.get_subscriptions
Full name: gocardless.gocardless_get_subscriptions

Parameter	Type	Required	Description
`subscription_id`	string	yes	The subscription id

update_subscriptions Write

Update a subscription Official GoCardless endpoint: PUT /subscriptions/{subscription_id}.

Lua path: app.integrations.gocardless.update_subscriptions
Full name: gocardless.gocardless_update_subscriptions

Parameter	Type	Required	Description
`subscription_id`	string	yes	The subscription id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

pause_subscription Write

Pause a subscription Official GoCardless endpoint: POST /subscriptions/{subscription_id}/actions/pause.

Lua path: app.integrations.gocardless.pause_subscription
Full name: gocardless.gocardless_pause_subscription

Parameter	Type	Required	Description
`subscription_id`	string	yes	The subscription id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

resume_subscription Write

Resume a subscription Official GoCardless endpoint: POST /subscriptions/{subscription_id}/actions/resume.

Lua path: app.integrations.gocardless.resume_subscription
Full name: gocardless.gocardless_resume_subscription

Parameter	Type	Required	Description
`subscription_id`	string	yes	The subscription id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

cancel_subscription Write

Immediately cancels a subscription; no more payments will be created under it. Any metadata supplied to this endpoint will be stored on the payment cancellation event it causes. This will fail with a cancellation_failed error if the subscription is already cancelled or finished. Official GoCardless endpoint: POST /subscriptions/{subscription_id}/actions/cancel.

Lua path: app.integrations.gocardless.cancel_subscription
Full name: gocardless.gocardless_cancel_subscription

Parameter	Type	Required	Description
`subscription_id`	string	yes	The subscription id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_tax_rate Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of all tax rates. Official GoCardless endpoint: GET /tax_rates.

Lua path: app.integrations.gocardless.list_tax_rate
Full name: gocardless.gocardless_list_tax_rate

Parameter	Type	Required	Description
No parameters.

get_tax_rates Read

Retrieves the details of a tax rate. Official GoCardless endpoint: GET /tax_rates/{tax_rate_id}.

Lua path: app.integrations.gocardless.get_tax_rates
Full name: gocardless.gocardless_get_tax_rates

Parameter	Type	Required	Description
`tax_rate_id`	string	yes	The tax rate id

get_transferred_mandates Read

Returns new customer bank details for a mandate that's been recently transferred Official GoCardless endpoint: GET /transferred_mandates/{mandate_id}.

Lua path: app.integrations.gocardless.get_transferred_mandates
Full name: gocardless.gocardless_get_transferred_mandates

Parameter	Type	Required	Description
`mandate_id`	string	yes	The mandate id

create_verification_detail Write

Creates a new verification detail Official GoCardless endpoint: POST /verification_details.

Lua path: app.integrations.gocardless.create_verification_detail
Full name: gocardless.gocardless_create_verification_detail

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.

list_verification_detail Read

Returns a list of verification details belonging to a creditor. Official GoCardless endpoint: GET /verification_details.

Lua path: app.integrations.gocardless.list_verification_detail
Full name: gocardless.gocardless_list_verification_detail

Parameter	Type	Required	Description
No parameters.

list_webhook Read

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your webhooks. Official GoCardless endpoint: GET /webhooks.

Lua path: app.integrations.gocardless.list_webhook
Full name: gocardless.gocardless_list_webhook

Parameter	Type	Required	Description
No parameters.

get_webhooks Read

Retrieves the details of an existing webhook. Official GoCardless endpoint: GET /webhooks/{webhook_id}.

Lua path: app.integrations.gocardless.get_webhooks
Full name: gocardless.gocardless_get_webhooks

Parameter	Type	Required	Description
`webhook_id`	string	yes	The webhook id

retry_webhook Read

Requests for a previous webhook to be sent again Official GoCardless endpoint: POST /webhooks/{webhook_id}/actions/retry.

Lua path: app.integrations.gocardless.retry_webhook
Full name: gocardless.gocardless_retry_webhook

Parameter	Type	Required	Description
`webhook_id`	string	yes	The webhook id
`body`	object	no	Request body matching the official GoCardless OpenAPI schema.
`idempotency_key`	string	no	Optional GoCardless Idempotency-Key header for safely retrying write operations.