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 CLI for AI Agents

Use the GoCardless CLI from KosmoKrator to call GoCardless tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

GoCardless CLI Setup

GoCardless can be configured headlessly with `kosmokrator integrations:configure gocardless`.

Install, configure, and verify

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure gocardless --set api_key="$GOCARDLESS_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor gocardless --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

Key	Env var	Type	Required	Label
`api_key`	`GOCARDLESS_API_KEY`	Secret `secret`	yes	Access Token
`url`	`GOCARDLESS_URL`	URL `url`	no	API Base URL
`api_version`	`GOCARDLESS_API_VERSION`	Text `text`	no	API Version

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call

kosmo integrations:call gocardless.gocardless_list_balance '{}' --json

Provider shortcut

kosmo integrations:gocardless gocardless_list_balance '{}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands

kosmo integrations:docs gocardless --json
kosmo integrations:docs gocardless.gocardless_list_balance --json
kosmo integrations:schema gocardless.gocardless_list_balance --json
kosmo integrations:search "GoCardless" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`gocardless.gocardless_list_balance`

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.

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_balance '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_balance '{}' --json

`gocardless.gocardless_get_bank_account_details`

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}.

Read read

Parameters: customer_bank_account_id, gc_key_id

Generic call

kosmo integrations:call gocardless.gocardless_get_bank_account_details '{"customer_bank_account_id":"example_customer_bank_account_id","gc_key_id":"example_gc_key_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_bank_account_details '{"customer_bank_account_id":"example_customer_bank_account_id","gc_key_id":"example_gc_key_id"}' --json

`gocardless.gocardless_create_bank_account_holder_verification`

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.

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_bank_account_holder_verification '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_bank_account_holder_verification '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_get_bank_account_holder_verifications`

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

Read read

Parameters: bank_account_holder_verification_id

Generic call

kosmo integrations:call gocardless.gocardless_get_bank_account_holder_verifications '{"bank_account_holder_verification_id":"example_bank_account_holder_verification_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_bank_account_holder_verifications '{"bank_account_holder_verification_id":"example_bank_account_holder_verification_id"}' --json

`gocardless.gocardless_create_bank_authorisation`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_bank_authorisation '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_bank_authorisation '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_get_bank_authorisations`

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

Read read

Parameters: bank_authorisation_id

Generic call

kosmo integrations:call gocardless.gocardless_get_bank_authorisations '{"bank_authorisation_id":"example_bank_authorisation_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_bank_authorisations '{"bank_authorisation_id":"example_bank_authorisation_id"}' --json

`gocardless.gocardless_create_bank_details_lookup`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_bank_details_lookup '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_bank_details_lookup '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_billing_request`

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.

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_billing_request '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_billing_request '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_billing_request`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_billing_request '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_billing_request '{}' --json

`gocardless.gocardless_collect_customer_details_billing_request`

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

Read read

Parameters: billing_request_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_collect_customer_details_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_collect_customer_details_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_collect_bank_account_billing_request`

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

Read read

Parameters: billing_request_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_collect_bank_account_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_collect_bank_account_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_confirm_payer_details_billing_request`

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.

Read read

Parameters: billing_request_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_confirm_payer_details_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_confirm_payer_details_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_fulfil_billing_request`

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.

Read read

Parameters: billing_request_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_fulfil_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_fulfil_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_cancel_billing_request`

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

Write write

Parameters: billing_request_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_cancel_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_cancel_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_get_billing_requests`

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

Read read

Parameters: billing_request_id

Generic call

kosmo integrations:call gocardless.gocardless_get_billing_requests '{"billing_request_id":"example_billing_request_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_billing_requests '{"billing_request_id":"example_billing_request_id"}' --json

`gocardless.gocardless_notify_billing_request`

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.

Read read

Parameters: billing_request_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_notify_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_notify_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_fallback_billing_request`

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.

Read read

Parameters: billing_request_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_fallback_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_fallback_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_choose_currency_billing_request`

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.

Read read

Parameters: billing_request_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_choose_currency_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_choose_currency_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_select_institution_billing_request`

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

Read read

Parameters: billing_request_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_select_institution_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_select_institution_billing_request '{"billing_request_id":"example_billing_request_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_billing_request_flow`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_billing_request_flow '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_billing_request_flow '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_initialise_billing_request_flow`

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.

Read read

Parameters: billing_request_flow_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_initialise_billing_request_flow '{"billing_request_flow_id":"example_billing_request_flow_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_initialise_billing_request_flow '{"billing_request_flow_id":"example_billing_request_flow_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_billing_request_template`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_billing_request_template '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_billing_request_template '{}' --json

`gocardless.gocardless_create_billing_request_template`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_billing_request_template '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_billing_request_template '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_get_billing_request_templates`

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

Read read

Parameters: billing_request_template_id

Generic call

kosmo integrations:call gocardless.gocardless_get_billing_request_templates '{"billing_request_template_id":"example_billing_request_template_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_billing_request_templates '{"billing_request_template_id":"example_billing_request_template_id"}' --json

`gocardless.gocardless_update_billing_request_templates`

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}.

Write write

Parameters: billing_request_template_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_update_billing_request_templates '{"billing_request_template_id":"example_billing_request_template_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_update_billing_request_templates '{"billing_request_template_id":"example_billing_request_template_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_with_actions_billing_requests`

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.

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_with_actions_billing_requests '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_with_actions_billing_requests '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_block`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_block '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_block '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_block`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_block '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_block '{}' --json

`gocardless.gocardless_get_blocks`

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

Read read

Parameters: block_id

Generic call

kosmo integrations:call gocardless.gocardless_get_blocks '{"block_id":"example_block_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_blocks '{"block_id":"example_block_id"}' --json

`gocardless.gocardless_disable_block`

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

Write write

Parameters: block_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_disable_block '{"block_id":"example_block_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_disable_block '{"block_id":"example_block_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_enable_block`

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

Write write

Parameters: block_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_enable_block '{"block_id":"example_block_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_enable_block '{"block_id":"example_block_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_block_by_ref_blocks`

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.

Read read

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_block_by_ref_blocks '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_block_by_ref_blocks '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_creditor`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_creditor '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_creditor '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_creditor`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_creditor '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_creditor '{}' --json

`gocardless.gocardless_get_creditors`

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

Read read

Parameters: creditor_id

Generic call

kosmo integrations:call gocardless.gocardless_get_creditors '{"creditor_id":"example_creditor_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_creditors '{"creditor_id":"example_creditor_id"}' --json

`gocardless.gocardless_update_creditors`

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

Write write

Parameters: creditor_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_update_creditors '{"creditor_id":"example_creditor_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_update_creditors '{"creditor_id":"example_creditor_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_creditor_bank_account`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_creditor_bank_account '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_creditor_bank_account '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_creditor_bank_account`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_creditor_bank_account '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_creditor_bank_account '{}' --json

`gocardless.gocardless_get_creditor_bank_accounts`

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

Read read

Parameters: creditor_bank_account_id

Generic call

kosmo integrations:call gocardless.gocardless_get_creditor_bank_accounts '{"creditor_bank_account_id":"example_creditor_bank_account_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_creditor_bank_accounts '{"creditor_bank_account_id":"example_creditor_bank_account_id"}' --json

`gocardless.gocardless_disable_creditor_bank_account`

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.

Write write

Parameters: creditor_bank_account_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_disable_creditor_bank_account '{"creditor_bank_account_id":"example_creditor_bank_account_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_disable_creditor_bank_account '{"creditor_bank_account_id":"example_creditor_bank_account_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_currency_exchange_rate`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_currency_exchange_rate '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_currency_exchange_rate '{}' --json

`gocardless.gocardless_create_customer`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_customer '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_customer '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_customer`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_customer '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_customer '{}' --json

`gocardless.gocardless_get_customers`

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

Read read

Parameters: customer_id

Generic call

kosmo integrations:call gocardless.gocardless_get_customers '{"customer_id":"example_customer_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_customers '{"customer_id":"example_customer_id"}' --json

`gocardless.gocardless_update_customers`

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

Write write

Parameters: customer_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_update_customers '{"customer_id":"example_customer_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_update_customers '{"customer_id":"example_customer_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_delete_customers`

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}.

Write write

Parameters: customer_id, body

Generic call

kosmo integrations:call gocardless.gocardless_delete_customers '{"customer_id":"example_customer_id","body":"example_body"}' --json

Shortcut

kosmo integrations:gocardless gocardless_delete_customers '{"customer_id":"example_customer_id","body":"example_body"}' --json

`gocardless.gocardless_create_customer_bank_account`

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.

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_customer_bank_account '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_customer_bank_account '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_customer_bank_account`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_customer_bank_account '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_customer_bank_account '{}' --json

`gocardless.gocardless_get_customer_bank_accounts`

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

Read read

Parameters: customer_bank_account_id

Generic call

kosmo integrations:call gocardless.gocardless_get_customer_bank_accounts '{"customer_bank_account_id":"example_customer_bank_account_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_customer_bank_accounts '{"customer_bank_account_id":"example_customer_bank_account_id"}' --json

`gocardless.gocardless_update_customer_bank_accounts`

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

Write write

Parameters: customer_bank_account_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_update_customer_bank_accounts '{"customer_bank_account_id":"example_customer_bank_account_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_update_customer_bank_accounts '{"customer_bank_account_id":"example_customer_bank_account_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_disable_customer_bank_account`

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.

Write write

Parameters: customer_bank_account_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_disable_customer_bank_account '{"customer_bank_account_id":"example_customer_bank_account_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_disable_customer_bank_account '{"customer_bank_account_id":"example_customer_bank_account_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_handle_customer_notification`

"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.

Read read

Parameters: customer_notification_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_handle_customer_notification '{"customer_notification_id":"example_customer_notification_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_handle_customer_notification '{"customer_notification_id":"example_customer_notification_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_event`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_event '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_event '{}' --json

`gocardless.gocardless_get_events`

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

Read read

Parameters: event_id

Generic call

kosmo integrations:call gocardless.gocardless_get_events '{"event_id":"example_event_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_events '{"event_id":"example_event_id"}' --json

`gocardless.gocardless_get_exports`

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

Read read

Parameters: export_id

Generic call

kosmo integrations:call gocardless.gocardless_get_exports '{"export_id":"example_export_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_exports '{"export_id":"example_export_id"}' --json

`gocardless.gocardless_list_export`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_export '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_export '{}' --json

`gocardless.gocardless_get_funds_availability`

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}.

Read read

Parameters: mandate_id

Generic call

kosmo integrations:call gocardless.gocardless_get_funds_availability '{"mandate_id":"example_mandate_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_funds_availability '{"mandate_id":"example_mandate_id"}' --json

`gocardless.gocardless_create_instalment_schedule`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_instalment_schedule '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_instalment_schedule '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_instalment_schedule`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_instalment_schedule '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_instalment_schedule '{}' --json

`gocardless.gocardless_get_instalment_schedules`

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

Read read

Parameters: instalment_schedule_id

Generic call

kosmo integrations:call gocardless.gocardless_get_instalment_schedules '{"instalment_schedule_id":"example_instalment_schedule_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_instalment_schedules '{"instalment_schedule_id":"example_instalment_schedule_id"}' --json

`gocardless.gocardless_update_instalment_schedules`

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

Write write

Parameters: instalment_schedule_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_update_instalment_schedules '{"instalment_schedule_id":"example_instalment_schedule_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_update_instalment_schedules '{"instalment_schedule_id":"example_instalment_schedule_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_cancel_instalment_schedule`

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.

Write write

Parameters: instalment_schedule_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_cancel_instalment_schedule '{"instalment_schedule_id":"example_instalment_schedule_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_cancel_instalment_schedule '{"instalment_schedule_id":"example_instalment_schedule_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_institution`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_institution '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_institution '{}' --json

`gocardless.gocardless_get_institutions_from_institution`

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.

Read read

Parameters: billing_request_id

Generic call

kosmo integrations:call gocardless.gocardless_get_institutions_from_institution '{"billing_request_id":"example_billing_request_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_institutions_from_institution '{"billing_request_id":"example_billing_request_id"}' --json

`gocardless.gocardless_logos_branding`

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

Read read

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_logos_branding '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_logos_branding '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_mandate`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_mandate '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_mandate '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_mandate`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_mandate '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_mandate '{}' --json

`gocardless.gocardless_get_mandates`

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

Read read

Parameters: mandate_id

Generic call

kosmo integrations:call gocardless.gocardless_get_mandates '{"mandate_id":"example_mandate_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_mandates '{"mandate_id":"example_mandate_id"}' --json

`gocardless.gocardless_update_mandates`

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

Write write

Parameters: mandate_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_update_mandates '{"mandate_id":"example_mandate_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_update_mandates '{"mandate_id":"example_mandate_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_cancel_mandate`

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.

Write write

Parameters: mandate_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_cancel_mandate '{"mandate_id":"example_mandate_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_cancel_mandate '{"mandate_id":"example_mandate_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_reinstate_mandate`

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

Read read

Parameters: mandate_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_reinstate_mandate '{"mandate_id":"example_mandate_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_reinstate_mandate '{"mandate_id":"example_mandate_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_mandate_import`

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.

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_mandate_import '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_mandate_import '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_get_mandate_imports`

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

Read read

Parameters: mandate_import_id

Generic call

kosmo integrations:call gocardless.gocardless_get_mandate_imports '{"mandate_import_id":"example_mandate_import_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_mandate_imports '{"mandate_import_id":"example_mandate_import_id"}' --json

`gocardless.gocardless_submit_mandate_import`

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

Write write

Parameters: mandate_import_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_submit_mandate_import '{"mandate_import_id":"example_mandate_import_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_submit_mandate_import '{"mandate_import_id":"example_mandate_import_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_cancel_mandate_import`

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.

Write write

Parameters: mandate_import_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_cancel_mandate_import '{"mandate_import_id":"example_mandate_import_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_cancel_mandate_import '{"mandate_import_id":"example_mandate_import_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_mandate_import_entry`

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.

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_mandate_import_entry '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_mandate_import_entry '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_mandate_import_entry`

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.

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_mandate_import_entry '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_mandate_import_entry '{}' --json

`gocardless.gocardless_create_mandate_pdf`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_mandate_pdf '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_mandate_pdf '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_negative_balance_limit`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_negative_balance_limit '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_negative_balance_limit '{}' --json

`gocardless.gocardless_create_outbound_payment`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_outbound_payment '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_outbound_payment '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_outbound_payment`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_outbound_payment '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_outbound_payment '{}' --json

`gocardless.gocardless_withdrawal_outbound_payments`

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

Read read

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_withdrawal_outbound_payments '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_withdrawal_outbound_payments '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_cancel_outbound_payment`

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.

Write write

Parameters: outbound_payment_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_cancel_outbound_payment '{"outbound_payment_id":"example_outbound_payment_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_cancel_outbound_payment '{"outbound_payment_id":"example_outbound_payment_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_approve_outbound_payment`

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.

Read read

Parameters: outbound_payment_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_approve_outbound_payment '{"outbound_payment_id":"example_outbound_payment_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_approve_outbound_payment '{"outbound_payment_id":"example_outbound_payment_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_get_outbound_payments`

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

Read read

Parameters: outbound_payment_id

Generic call

kosmo integrations:call gocardless.gocardless_get_outbound_payments '{"outbound_payment_id":"example_outbound_payment_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_outbound_payments '{"outbound_payment_id":"example_outbound_payment_id"}' --json

`gocardless.gocardless_update_outbound_payments`

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

Write write

Parameters: outbound_payment_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_update_outbound_payments '{"outbound_payment_id":"example_outbound_payment_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_update_outbound_payments '{"outbound_payment_id":"example_outbound_payment_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_outbound_payments_stats`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_outbound_payments_stats '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_outbound_payments_stats '{}' --json

`gocardless.gocardless_create_outbound_payment_import`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_outbound_payment_import '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_outbound_payment_import '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_outbound_payment_import`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_outbound_payment_import '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_outbound_payment_import '{}' --json

`gocardless.gocardless_get_outbound_payment_imports`

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

Read read

Parameters: outbound_payment_import_id

Generic call

kosmo integrations:call gocardless.gocardless_get_outbound_payment_imports '{"outbound_payment_import_id":"example_outbound_payment_import_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_outbound_payment_imports '{"outbound_payment_import_id":"example_outbound_payment_import_id"}' --json

`gocardless.gocardless_list_outbound_payment_import_entry`

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.

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_outbound_payment_import_entry '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_outbound_payment_import_entry '{}' --json

`gocardless.gocardless_get_payer_authorisations`

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}.

Read read

Parameters: payer_authorisation_id

Generic call

kosmo integrations:call gocardless.gocardless_get_payer_authorisations '{"payer_authorisation_id":"example_payer_authorisation_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_payer_authorisations '{"payer_authorisation_id":"example_payer_authorisation_id"}' --json

`gocardless.gocardless_update_payer_authorisations`

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

Write write

Parameters: payer_authorisation_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_update_payer_authorisations '{"payer_authorisation_id":"example_payer_authorisation_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_update_payer_authorisations '{"payer_authorisation_id":"example_payer_authorisation_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_payer_authorisation`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_payer_authorisation '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_payer_authorisation '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_submit_payer_authorisation`

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

Write write

Parameters: payer_authorisation_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_submit_payer_authorisation '{"payer_authorisation_id":"example_payer_authorisation_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_submit_payer_authorisation '{"payer_authorisation_id":"example_payer_authorisation_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_confirm_payer_authorisation`

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

Read read

Parameters: payer_authorisation_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_confirm_payer_authorisation '{"payer_authorisation_id":"example_payer_authorisation_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_confirm_payer_authorisation '{"payer_authorisation_id":"example_payer_authorisation_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_payer_themes_branding`

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.

Read read

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_payer_themes_branding '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_payer_themes_branding '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_payment`

<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.

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_payment '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_payment '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_payment`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_payment '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_payment '{}' --json

`gocardless.gocardless_get_payments`

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

Read read

Parameters: payment_id

Generic call

kosmo integrations:call gocardless.gocardless_get_payments '{"payment_id":"example_payment_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_payments '{"payment_id":"example_payment_id"}' --json

`gocardless.gocardless_update_payments`

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

Write write

Parameters: payment_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_update_payments '{"payment_id":"example_payment_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_update_payments '{"payment_id":"example_payment_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_cancel_payment`

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.

Write write

Parameters: payment_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_cancel_payment '{"payment_id":"example_payment_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_cancel_payment '{"payment_id":"example_payment_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_retry_payment`

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

Read read

Parameters: payment_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_retry_payment '{"payment_id":"example_payment_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_retry_payment '{"payment_id":"example_payment_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_get_payment_accounts`

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

Read read

Parameters: payment_account_id

Generic call

kosmo integrations:call gocardless.gocardless_get_payment_accounts '{"payment_account_id":"example_payment_account_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_payment_accounts '{"payment_account_id":"example_payment_account_id"}' --json

`gocardless.gocardless_list_payment_account`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_payment_account '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_payment_account '{}' --json

`gocardless.gocardless_get_payment_account_transactions`

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

Read read

Parameters: payment_account_transaction_id

Generic call

kosmo integrations:call gocardless.gocardless_get_payment_account_transactions '{"payment_account_transaction_id":"example_payment_account_transaction_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_payment_account_transactions '{"payment_account_transaction_id":"example_payment_account_transaction_id"}' --json

`gocardless.gocardless_get_transactions_from_payment_account_transaction`

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

Read read

Parameters: payment_account_transaction_id

Generic call

kosmo integrations:call gocardless.gocardless_get_transactions_from_payment_account_transaction '{"payment_account_transaction_id":"example_payment_account_transaction_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_transactions_from_payment_account_transaction '{"payment_account_transaction_id":"example_payment_account_transaction_id"}' --json

`gocardless.gocardless_list_payout`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_payout '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_payout '{}' --json

`gocardless.gocardless_get_payouts`

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}.

Read read

Parameters: payout_id

Generic call

kosmo integrations:call gocardless.gocardless_get_payouts '{"payout_id":"example_payout_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_payouts '{"payout_id":"example_payout_id"}' --json

`gocardless.gocardless_update_payouts`

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

Write write

Parameters: payout_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_update_payouts '{"payout_id":"example_payout_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_update_payouts '{"payout_id":"example_payout_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_payout_item`

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.

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_payout_item '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_payout_item '{}' --json

`gocardless.gocardless_create_redirect_flow`

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.

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_redirect_flow '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_redirect_flow '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_get_redirect_flows`

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}.

Read read

Parameters: redirect_flow_id

Generic call

kosmo integrations:call gocardless.gocardless_get_redirect_flows '{"redirect_flow_id":"example_redirect_flow_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_redirect_flows '{"redirect_flow_id":"example_redirect_flow_id"}' --json

`gocardless.gocardless_complete_redirect_flow`

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

Read read

Parameters: redirect_flow_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_complete_redirect_flow '{"redirect_flow_id":"example_redirect_flow_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_complete_redirect_flow '{"redirect_flow_id":"example_redirect_flow_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_refund`

Create a refund Official GoCardless endpoint: POST /refunds.

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_refund '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_refund '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_refund`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_refund '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_refund '{}' --json

`gocardless.gocardless_get_refunds`

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

Read read

Parameters: refund_id

Generic call

kosmo integrations:call gocardless.gocardless_get_refunds '{"refund_id":"example_refund_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_refunds '{"refund_id":"example_refund_id"}' --json

`gocardless.gocardless_update_refunds`

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

Write write

Parameters: refund_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_update_refunds '{"refund_id":"example_refund_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_update_refunds '{"refund_id":"example_refund_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_run_scenario_simulator`

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

Write write

Parameters: scenario_simulator_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_run_scenario_simulator '{"scenario_simulator_id":"example_scenario_simulator_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_run_scenario_simulator '{"scenario_simulator_id":"example_scenario_simulator_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_create_scheme_identifier`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_scheme_identifier '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_scheme_identifier '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_scheme_identifier`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_scheme_identifier '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_scheme_identifier '{}' --json

`gocardless.gocardless_get_scheme_identifiers`

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

Read read

Parameters: scheme_identifier_id

Generic call

kosmo integrations:call gocardless.gocardless_get_scheme_identifiers '{"scheme_identifier_id":"example_scheme_identifier_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_scheme_identifiers '{"scheme_identifier_id":"example_scheme_identifier_id"}' --json

`gocardless.gocardless_create_subscription`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_subscription '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_subscription '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_subscription`

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.

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_subscription '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_subscription '{}' --json

`gocardless.gocardless_get_subscriptions`

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

Read read

Parameters: subscription_id

Generic call

kosmo integrations:call gocardless.gocardless_get_subscriptions '{"subscription_id":"example_subscription_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_subscriptions '{"subscription_id":"example_subscription_id"}' --json

`gocardless.gocardless_update_subscriptions`

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

Write write

Parameters: subscription_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_update_subscriptions '{"subscription_id":"example_subscription_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_update_subscriptions '{"subscription_id":"example_subscription_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_pause_subscription`

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

Write write

Parameters: subscription_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_pause_subscription '{"subscription_id":"example_subscription_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_pause_subscription '{"subscription_id":"example_subscription_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_resume_subscription`

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

Write write

Parameters: subscription_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_resume_subscription '{"subscription_id":"example_subscription_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_resume_subscription '{"subscription_id":"example_subscription_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_cancel_subscription`

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.

Write write

Parameters: subscription_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_cancel_subscription '{"subscription_id":"example_subscription_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_cancel_subscription '{"subscription_id":"example_subscription_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_tax_rate`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_tax_rate '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_tax_rate '{}' --json

`gocardless.gocardless_get_tax_rates`

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

Read read

Parameters: tax_rate_id

Generic call

kosmo integrations:call gocardless.gocardless_get_tax_rates '{"tax_rate_id":"example_tax_rate_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_tax_rates '{"tax_rate_id":"example_tax_rate_id"}' --json

`gocardless.gocardless_get_transferred_mandates`

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

Read read

Parameters: mandate_id

Generic call

kosmo integrations:call gocardless.gocardless_get_transferred_mandates '{"mandate_id":"example_mandate_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_transferred_mandates '{"mandate_id":"example_mandate_id"}' --json

`gocardless.gocardless_create_verification_detail`

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

Write write

Parameters: body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_create_verification_detail '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_create_verification_detail '{"body":"example_body","idempotency_key":"example_idempotency_key"}' --json

`gocardless.gocardless_list_verification_detail`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_verification_detail '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_verification_detail '{}' --json

`gocardless.gocardless_list_webhook`

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

Read read

Parameters: none

Generic call

kosmo integrations:call gocardless.gocardless_list_webhook '{}' --json

Shortcut

kosmo integrations:gocardless gocardless_list_webhook '{}' --json

`gocardless.gocardless_get_webhooks`

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

Read read

Parameters: webhook_id

Generic call

kosmo integrations:call gocardless.gocardless_get_webhooks '{"webhook_id":"example_webhook_id"}' --json

Shortcut

kosmo integrations:gocardless gocardless_get_webhooks '{"webhook_id":"example_webhook_id"}' --json

`gocardless.gocardless_retry_webhook`

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

Read read

Parameters: webhook_id, body, idempotency_key

Generic call

kosmo integrations:call gocardless.gocardless_retry_webhook '{"webhook_id":"example_webhook_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Shortcut

kosmo integrations:gocardless gocardless_retry_webhook '{"webhook_id":"example_webhook_id","body":"example_body","idempotency_key":"example_idempotency_key"}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

gocardless.gocardless_list_balance 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_balance --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_bank_account_details 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_bank_account_details --json

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.

gocardless.gocardless_create_bank_account_holder_verification 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_bank_account_holder_verification --json

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.

gocardless.gocardless_get_bank_account_holder_verifications 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_bank_account_holder_verifications --json

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

gocardless.gocardless_create_bank_authorisation 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_bank_authorisation --json

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.

gocardless.gocardless_get_bank_authorisations 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_bank_authorisations --json

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

gocardless.gocardless_create_bank_details_lookup 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_bank_details_lookup --json

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.

gocardless.gocardless_create_billing_request 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_billing_request --json

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.

gocardless.gocardless_list_billing_request 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_billing_request --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_collect_customer_details_billing_request 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_collect_customer_details_billing_request --json

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.

gocardless.gocardless_collect_bank_account_billing_request 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_collect_bank_account_billing_request --json

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.

gocardless.gocardless_confirm_payer_details_billing_request 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_confirm_payer_details_billing_request --json

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.

gocardless.gocardless_fulfil_billing_request 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_fulfil_billing_request --json

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.

gocardless.gocardless_cancel_billing_request 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_cancel_billing_request --json

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.

gocardless.gocardless_get_billing_requests 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_billing_requests --json

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

gocardless.gocardless_notify_billing_request 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_notify_billing_request --json

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.

gocardless.gocardless_fallback_billing_request 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_fallback_billing_request --json

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.

gocardless.gocardless_choose_currency_billing_request 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_choose_currency_billing_request --json

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.

gocardless.gocardless_select_institution_billing_request 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_select_institution_billing_request --json

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.

gocardless.gocardless_create_billing_request_flow 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_billing_request_flow --json

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.

gocardless.gocardless_initialise_billing_request_flow 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_initialise_billing_request_flow --json

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.

gocardless.gocardless_list_billing_request_template 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_billing_request_template --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_create_billing_request_template 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_billing_request_template --json

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.

gocardless.gocardless_get_billing_request_templates 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_billing_request_templates --json

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

gocardless.gocardless_update_billing_request_templates 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_update_billing_request_templates --json

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.

gocardless.gocardless_create_with_actions_billing_requests 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_with_actions_billing_requests --json

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.

gocardless.gocardless_create_block 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_block --json

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.

gocardless.gocardless_list_block 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_block --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_blocks 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_blocks --json

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

gocardless.gocardless_disable_block 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_disable_block --json

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.

gocardless.gocardless_enable_block 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_enable_block --json

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.

gocardless.gocardless_block_by_ref_blocks 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_block_by_ref_blocks --json

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.

gocardless.gocardless_create_creditor 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_creditor --json

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.

gocardless.gocardless_list_creditor 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_creditor --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_creditors 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_creditors --json

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

gocardless.gocardless_update_creditors 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_update_creditors --json

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.

gocardless.gocardless_create_creditor_bank_account 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_creditor_bank_account --json

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.

gocardless.gocardless_list_creditor_bank_account 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_creditor_bank_account --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_creditor_bank_accounts 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_creditor_bank_accounts --json

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

gocardless.gocardless_disable_creditor_bank_account 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_disable_creditor_bank_account --json

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.

gocardless.gocardless_list_currency_exchange_rate 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_currency_exchange_rate --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_create_customer 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_customer --json

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.

gocardless.gocardless_list_customer 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_customer --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_customers 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_customers --json

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

gocardless.gocardless_update_customers 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_update_customers --json

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.

gocardless.gocardless_delete_customers 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_delete_customers --json

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

gocardless.gocardless_create_customer_bank_account 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_customer_bank_account --json

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.

gocardless.gocardless_list_customer_bank_account 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_customer_bank_account --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_customer_bank_accounts 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_customer_bank_accounts --json

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

gocardless.gocardless_update_customer_bank_accounts 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_update_customer_bank_accounts --json

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.

gocardless.gocardless_disable_customer_bank_account 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_disable_customer_bank_account --json

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.

gocardless.gocardless_handle_customer_notification 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_handle_customer_notification --json

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.

gocardless.gocardless_list_event 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_event --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_events 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_events --json

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

gocardless.gocardless_get_exports 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_exports --json

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

gocardless.gocardless_list_export 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_export --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_funds_availability 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_funds_availability --json

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

gocardless.gocardless_create_instalment_schedule 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_instalment_schedule --json

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.

gocardless.gocardless_list_instalment_schedule 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_instalment_schedule --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_instalment_schedules 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_instalment_schedules --json

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

gocardless.gocardless_update_instalment_schedules 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_update_instalment_schedules --json

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.

gocardless.gocardless_cancel_instalment_schedule 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_cancel_instalment_schedule --json

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.

gocardless.gocardless_list_institution 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_institution --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_institutions_from_institution 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_institutions_from_institution --json

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

gocardless.gocardless_logos_branding 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_logos_branding --json

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.

gocardless.gocardless_create_mandate 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_mandate --json

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.

gocardless.gocardless_list_mandate 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_mandate --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_mandates 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_mandates --json

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

gocardless.gocardless_update_mandates 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_update_mandates --json

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.

gocardless.gocardless_cancel_mandate 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_cancel_mandate --json

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.

gocardless.gocardless_reinstate_mandate 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_reinstate_mandate --json

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.

gocardless.gocardless_create_mandate_import 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_mandate_import --json

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.

gocardless.gocardless_get_mandate_imports 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_mandate_imports --json

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

gocardless.gocardless_submit_mandate_import 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_submit_mandate_import --json

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.

gocardless.gocardless_cancel_mandate_import 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_cancel_mandate_import --json

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.

gocardless.gocardless_create_mandate_import_entry 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_mandate_import_entry --json

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.

gocardless.gocardless_list_mandate_import_entry 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_mandate_import_entry --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_create_mandate_pdf 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_mandate_pdf --json

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.

gocardless.gocardless_list_negative_balance_limit 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_negative_balance_limit --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_create_outbound_payment 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_outbound_payment --json

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.

gocardless.gocardless_list_outbound_payment 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_outbound_payment --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_withdrawal_outbound_payments 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_withdrawal_outbound_payments --json

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.

gocardless.gocardless_cancel_outbound_payment 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_cancel_outbound_payment --json

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.

gocardless.gocardless_approve_outbound_payment 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_approve_outbound_payment --json

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.

gocardless.gocardless_get_outbound_payments 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_outbound_payments --json

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

gocardless.gocardless_update_outbound_payments 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_update_outbound_payments --json

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.

gocardless.gocardless_list_outbound_payments_stats 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_outbound_payments_stats --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_create_outbound_payment_import 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_outbound_payment_import --json

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.

gocardless.gocardless_list_outbound_payment_import 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_outbound_payment_import --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_outbound_payment_imports 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_outbound_payment_imports --json

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

gocardless.gocardless_list_outbound_payment_import_entry 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_outbound_payment_import_entry --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_payer_authorisations 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_payer_authorisations --json

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

gocardless.gocardless_update_payer_authorisations 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_update_payer_authorisations --json

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.

gocardless.gocardless_create_payer_authorisation 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_payer_authorisation --json

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.

gocardless.gocardless_submit_payer_authorisation 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_submit_payer_authorisation --json

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.

gocardless.gocardless_confirm_payer_authorisation 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_confirm_payer_authorisation --json

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.

gocardless.gocardless_payer_themes_branding 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_payer_themes_branding --json

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.

gocardless.gocardless_create_payment 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_payment --json

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.

gocardless.gocardless_list_payment 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_payment --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_payments 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_payments --json

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

gocardless.gocardless_update_payments 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_update_payments --json

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.

gocardless.gocardless_cancel_payment 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_cancel_payment --json

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.

gocardless.gocardless_retry_payment 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_retry_payment --json

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.

gocardless.gocardless_get_payment_accounts 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_payment_accounts --json

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

gocardless.gocardless_list_payment_account 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_payment_account --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_payment_account_transactions 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_payment_account_transactions --json

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

gocardless.gocardless_get_transactions_from_payment_account_transaction 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_transactions_from_payment_account_transaction --json

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

gocardless.gocardless_list_payout 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_payout --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_payouts 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_payouts --json

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

gocardless.gocardless_update_payouts 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_update_payouts --json

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.

gocardless.gocardless_list_payout_item 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_payout_item --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_create_redirect_flow 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_redirect_flow --json

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.

gocardless.gocardless_get_redirect_flows 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_redirect_flows --json

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

gocardless.gocardless_complete_redirect_flow 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_complete_redirect_flow --json

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.

gocardless.gocardless_create_refund 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_refund --json

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.

gocardless.gocardless_list_refund 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_refund --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_refunds 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_refunds --json

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

gocardless.gocardless_update_refunds 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_update_refunds --json

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.

gocardless.gocardless_run_scenario_simulator 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_run_scenario_simulator --json

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.

gocardless.gocardless_create_scheme_identifier 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_scheme_identifier --json

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.

gocardless.gocardless_list_scheme_identifier 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_scheme_identifier --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_scheme_identifiers 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_scheme_identifiers --json

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

gocardless.gocardless_create_subscription 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_subscription --json

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.

gocardless.gocardless_list_subscription 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_subscription --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_subscriptions 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_subscriptions --json

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

gocardless.gocardless_update_subscriptions 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_update_subscriptions --json

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.

gocardless.gocardless_pause_subscription 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_pause_subscription --json

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.

gocardless.gocardless_resume_subscription 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_resume_subscription --json

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.

gocardless.gocardless_cancel_subscription 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_cancel_subscription --json

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.

gocardless.gocardless_list_tax_rate 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_tax_rate --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_tax_rates 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_tax_rates --json

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

gocardless.gocardless_get_transferred_mandates 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_transferred_mandates --json

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

gocardless.gocardless_create_verification_detail 2 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_create_verification_detail --json

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.

gocardless.gocardless_list_verification_detail 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_verification_detail --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_list_webhook 0 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_list_webhook --json

Parameter	Type	Required	Description
No parameters.

gocardless.gocardless_get_webhooks 1 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_get_webhooks --json

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

gocardless.gocardless_retry_webhook 3 parameters

Schema command

kosmo integrations:schema gocardless.gocardless_retry_webhook --json

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.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.