KosmoKrator

data

GoCardless MCP, CLI, and Lua Integration for AI Agents

GoCardless integration docs for AI agents: MCP gateway setup, GoCardless CLI commands, Lua API reference, credentials, and function schemas.

GoCardless for agents

Credentials can be configured manually in web or CLI hosts.

Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.

Agent Surfaces

GoCardless CLIHeadless setup, JSON output, direct function calls. GoCardless MCPExpose selected tools to local MCP clients. GoCardless LuaAgent-facing namespace and Lua reference. FeedbackReport missing tools, auth issues, or bad metadata.

Machine-Readable Metadata

integration_slug
gocardless
route_slug
gocardless
package
gocardless
auth_strategy
bearer_token
cli_setup_supported
true
cli_runtime_supported
true
mcp_gateway_supported
true
lua_supported
true

Function Catalog

FunctionTypeParametersDescription
gocardless.gocardless_list_balance Read read 0 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.
gocardless.gocardless_get_bank_account_details Read read 2 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}.
gocardless.gocardless_create_bank_account_holder_verification Write write 2 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.
gocardless.gocardless_get_bank_account_holder_verifications Read read 1 Fetches a bank account holder verification by ID. Official GoCardless endpoint: GET /bank_account_holder_verifications/{bank_account_holder_verification_id}.
gocardless.gocardless_create_bank_authorisation Write write 2 Create a Bank Authorisation. Official GoCardless endpoint: POST /bank_authorisations.
gocardless.gocardless_get_bank_authorisations Read read 1 Get a single bank authorisation. Official GoCardless endpoint: GET /bank_authorisations/{bank_authorisation_id}.
gocardless.gocardless_create_bank_details_lookup Write write 2 Perform a bank details lookup Official GoCardless endpoint: POST /bank_details_lookups.
gocardless.gocardless_create_billing_request Write write 2 <p class="notice"><strong>Important</strong>: All properties associated with `subscription_request` and `instalment_schedule_request` are only supported for ACH and PAD schemes.</p> Official GoCardless endpoint: POST /billing_requests.
gocardless.gocardless_list_billing_request Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your billing requests. Official GoCardless endpoint: GET /billing_requests.
gocardless.gocardless_collect_customer_details_billing_request Read read 3 Collect customer details Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/collect_customer_details.
gocardless.gocardless_collect_bank_account_billing_request Read read 3 Collect bank account details Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/collect_bank_account.
gocardless.gocardless_confirm_payer_details_billing_request Read read 3 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.
gocardless.gocardless_fulfil_billing_request Read read 3 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.
gocardless.gocardless_cancel_billing_request Write write 3 Immediately cancels a billing request, causing all billing request flows to expire. Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/cancel.
gocardless.gocardless_get_billing_requests Read read 1 Fetches a billing request Official GoCardless endpoint: GET /billing_requests/{billing_request_id}.
gocardless.gocardless_notify_billing_request Read read 3 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.
gocardless.gocardless_fallback_billing_request Read read 3 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.
gocardless.gocardless_choose_currency_billing_request Read read 3 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.
gocardless.gocardless_select_institution_billing_request Read read 3 Creates an Institution object and attaches it to the Billing Request Official GoCardless endpoint: POST /billing_requests/{billing_request_id}/actions/select_institution.
gocardless.gocardless_create_billing_request_flow Write write 2 Creates a new billing request flow. Official GoCardless endpoint: POST /billing_request_flows.
gocardless.gocardless_initialise_billing_request_flow Read read 3 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.
gocardless.gocardless_list_billing_request_template Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your Billing Request Templates. Official GoCardless endpoint: GET /billing_request_templates.
gocardless.gocardless_create_billing_request_template Write write 2 Create a Billing Request Template Official GoCardless endpoint: POST /billing_request_templates.
gocardless.gocardless_get_billing_request_templates Read read 1 Fetches a Billing Request Template Official GoCardless endpoint: GET /billing_request_templates/{billing_request_template_id}.
gocardless.gocardless_update_billing_request_templates Write write 3 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}.
gocardless.gocardless_create_with_actions_billing_requests Write write 2 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.
gocardless.gocardless_create_block Write write 2 Creates a new Block of a given type. By default it will be active. Official GoCardless endpoint: POST /blocks.
gocardless.gocardless_list_block Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your blocks. Official GoCardless endpoint: GET /blocks.
gocardless.gocardless_get_blocks Read read 1 Retrieves the details of an existing block. Official GoCardless endpoint: GET /blocks/{block_id}.
gocardless.gocardless_disable_block Write write 3 Disables a block so that it no longer will prevent mandate creation. Official GoCardless endpoint: POST /blocks/{block_id}/actions/disable.
gocardless.gocardless_enable_block Write write 3 Enables a previously disabled block so that it will prevent mandate creation Official GoCardless endpoint: POST /blocks/{block_id}/actions/enable.
gocardless.gocardless_block_by_ref_blocks Read read 2 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.
gocardless.gocardless_create_creditor Write write 2 Creates a new creditor. Official GoCardless endpoint: POST /creditors.
gocardless.gocardless_list_creditor Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your creditors. Official GoCardless endpoint: GET /creditors.
gocardless.gocardless_get_creditors Read read 1 Retrieves the details of an existing creditor. Official GoCardless endpoint: GET /creditors/{creditor_id}.
gocardless.gocardless_update_creditors Write write 3 Updates a creditor object. Supports all of the fields supported when creating a creditor. Official GoCardless endpoint: PUT /creditors/{creditor_id}.
gocardless.gocardless_create_creditor_bank_account Write write 2 Creates a new creditor bank account object. Official GoCardless endpoint: POST /creditor_bank_accounts.
gocardless.gocardless_list_creditor_bank_account Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your creditor bank accounts. Official GoCardless endpoint: GET /creditor_bank_accounts.
gocardless.gocardless_get_creditor_bank_accounts Read read 1 Retrieves the details of an existing creditor bank account. Official GoCardless endpoint: GET /creditor_bank_accounts/{creditor_bank_account_id}.
gocardless.gocardless_disable_creditor_bank_account Write write 3 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.
gocardless.gocardless_list_currency_exchange_rate Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of all exchange rates. Official GoCardless endpoint: GET /currency_exchange_rates.
gocardless.gocardless_create_customer Write write 2 Creates a new customer object. Official GoCardless endpoint: POST /customers.
gocardless.gocardless_list_customer Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your customers. Official GoCardless endpoint: GET /customers.
gocardless.gocardless_get_customers Read read 1 Retrieves the details of an existing customer. Official GoCardless endpoint: GET /customers/{customer_id}.
gocardless.gocardless_update_customers Write write 3 Updates a customer object. Supports all of the fields supported when creating a customer. Official GoCardless endpoint: PUT /customers/{customer_id}.
gocardless.gocardless_delete_customers Write write 2 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. <p class="restricted-notice"><strong>The action of removing a customer cannot be reversed, so please use with care.</strong></p> Official GoCardless endpoint: DELETE /customers/{customer_id}.
gocardless.gocardless_create_customer_bank_account Write write 2 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.
gocardless.gocardless_list_customer_bank_account Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your bank accounts. Official GoCardless endpoint: GET /customer_bank_accounts.
gocardless.gocardless_get_customer_bank_accounts Read read 1 Retrieves the details of an existing bank account. Official GoCardless endpoint: GET /customer_bank_accounts/{customer_bank_account_id}.
gocardless.gocardless_update_customer_bank_accounts Write write 3 Updates a customer bank account object. Only the metadata parameter is allowed. Official GoCardless endpoint: PUT /customer_bank_accounts/{customer_bank_account_id}.
gocardless.gocardless_disable_customer_bank_account Write write 3 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.
gocardless.gocardless_handle_customer_notification Read read 3 "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.
gocardless.gocardless_list_event Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your events. Official GoCardless endpoint: GET /events.
gocardless.gocardless_get_events Read read 1 Retrieves the details of a single event. Official GoCardless endpoint: GET /events/{event_id}.
gocardless.gocardless_get_exports Read read 1 Returns a single export. Official GoCardless endpoint: GET /exports/{export_id}.
gocardless.gocardless_list_export Read read 0 Returns a list of exports which are available for download. Official GoCardless endpoint: GET /exports.
gocardless.gocardless_get_funds_availability Read read 1 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}.
gocardless.gocardless_create_instalment_schedule Write write 2 Create (with schedule) Official GoCardless endpoint: POST /instalment_schedules.
gocardless.gocardless_list_instalment_schedule Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your instalment schedules. Official GoCardless endpoint: GET /instalment_schedules.
gocardless.gocardless_get_instalment_schedules Read read 1 Retrieves the details of an existing instalment schedule. Official GoCardless endpoint: GET /instalment_schedules/{instalment_schedule_id}.
gocardless.gocardless_update_instalment_schedules Write write 3 Updates an instalment schedule. This accepts only the metadata parameter. Official GoCardless endpoint: PUT /instalment_schedules/{instalment_schedule_id}.
gocardless.gocardless_cancel_instalment_schedule Write write 3 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.
gocardless.gocardless_list_institution Read read 0 Returns a list of supported institutions. Official GoCardless endpoint: GET /institutions.
gocardless.gocardless_get_institutions_from_institution Read read 1 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.
gocardless.gocardless_logos_branding Read read 2 Create a logo associated with a creditor Official GoCardless endpoint: POST /branding/logos.
gocardless.gocardless_create_mandate Write write 2 Creates a new mandate object. Official GoCardless endpoint: POST /mandates.
gocardless.gocardless_list_mandate Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your mandates. Official GoCardless endpoint: GET /mandates.
gocardless.gocardless_get_mandates Read read 1 Retrieves the details of an existing mandate. Official GoCardless endpoint: GET /mandates/{mandate_id}.
gocardless.gocardless_update_mandates Write write 3 Updates a mandate object. This accepts only the metadata parameter. Official GoCardless endpoint: PUT /mandates/{mandate_id}.
gocardless.gocardless_cancel_mandate Write write 3 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.
gocardless.gocardless_reinstate_mandate Read read 3 Reinstate a mandate Official GoCardless endpoint: POST /mandates/{mandate_id}/actions/reinstate.
gocardless.gocardless_create_mandate_import Write write 2 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.
gocardless.gocardless_get_mandate_imports Read read 1 Returns a single mandate import. Official GoCardless endpoint: GET /mandate_imports/{mandate_import_id}.
gocardless.gocardless_submit_mandate_import Write write 3 Submit a mandate import Official GoCardless endpoint: POST /mandate_imports/{mandate_import_id}/actions/submit.
gocardless.gocardless_cancel_mandate_import Write write 3 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.
gocardless.gocardless_create_mandate_import_entry Write write 2 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.
gocardless.gocardless_list_mandate_import_entry Read read 0 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.
gocardless.gocardless_create_mandate_pdf Write write 2 Create a mandate PDF Official GoCardless endpoint: POST /mandate_pdfs.
gocardless.gocardless_list_negative_balance_limit Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of negative balance limits. Official GoCardless endpoint: GET /negative_balance_limits.
gocardless.gocardless_create_outbound_payment Write write 2 Create an outbound payment Official GoCardless endpoint: POST /outbound_payments.
gocardless.gocardless_list_outbound_payment Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of outbound payments. Official GoCardless endpoint: GET /outbound_payments.
gocardless.gocardless_withdrawal_outbound_payments Read read 2 Creates an outbound payment to your verified business bank account as the recipient. Official GoCardless endpoint: POST /outbound_payments/withdrawal.
gocardless.gocardless_cancel_outbound_payment Write write 3 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.
gocardless.gocardless_approve_outbound_payment Read read 3 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.
gocardless.gocardless_get_outbound_payments Read read 1 Fetches an outbound_payment by ID Official GoCardless endpoint: GET /outbound_payments/{outbound_payment_id}.
gocardless.gocardless_update_outbound_payments Write write 3 Updates an outbound payment object. This accepts only the metadata parameter. Official GoCardless endpoint: PUT /outbound_payments/{outbound_payment_id}.
gocardless.gocardless_list_outbound_payments_stats Read read 0 Retrieve aggregate statistics on outbound payments. Official GoCardless endpoint: GET /outbound_payments/stats.
gocardless.gocardless_create_outbound_payment_import Write write 2 Create an outbound payment import Official GoCardless endpoint: POST /outbound_payment_imports.
gocardless.gocardless_list_outbound_payment_import Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your outbound payment imports. Official GoCardless endpoint: GET /outbound_payment_imports.
gocardless.gocardless_get_outbound_payment_imports Read read 1 Returns a single outbound payment import. Official GoCardless endpoint: GET /outbound_payment_imports/{outbound_payment_import_id}.
gocardless.gocardless_list_outbound_payment_import_entry Read read 0 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.
gocardless.gocardless_get_payer_authorisations Read read 1 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}.
gocardless.gocardless_update_payer_authorisations Write write 3 Update a Payer Authorisation Official GoCardless endpoint: PUT /payer_authorisations/{payer_authorisation_id}.
gocardless.gocardless_create_payer_authorisation Write write 2 Create a Payer Authorisation Official GoCardless endpoint: POST /payer_authorisations.
gocardless.gocardless_submit_payer_authorisation Write write 3 Submit a Payer Authorisation Official GoCardless endpoint: POST /payer_authorisations/{payer_authorisation_id}/actions/submit.
gocardless.gocardless_confirm_payer_authorisation Read read 3 Confirm a Payer Authorisation Official GoCardless endpoint: POST /payer_authorisations/{payer_authorisation_id}/actions/confirm.
gocardless.gocardless_payer_themes_branding Read read 2 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.
gocardless.gocardless_create_payment Write write 2 <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.
gocardless.gocardless_list_payment Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your payments. Official GoCardless endpoint: GET /payments.
gocardless.gocardless_get_payments Read read 1 Retrieves the details of a single existing payment. Official GoCardless endpoint: GET /payments/{payment_id}.
gocardless.gocardless_update_payments Write write 3 Updates a payment object. This accepts only the metadata parameter. Official GoCardless endpoint: PUT /payments/{payment_id}.
gocardless.gocardless_cancel_payment Write write 3 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.
gocardless.gocardless_retry_payment Read read 3 Retry a payment Official GoCardless endpoint: POST /payments/{payment_id}/actions/retry.
gocardless.gocardless_get_payment_accounts Read read 1 Retrieves the details of an existing payment account. Official GoCardless endpoint: GET /payment_accounts/{payment_account_id}.
gocardless.gocardless_list_payment_account Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your payment accounts. Official GoCardless endpoint: GET /payment_accounts.
gocardless.gocardless_get_payment_account_transactions Read read 1 Retrieves the details of an existing payment account transaction. Official GoCardless endpoint: GET /payment_account_transactions/{payment_account_transaction_id}.
gocardless.gocardless_get_transactions_from_payment_account_transaction Read read 1 List transactions for a given payment account. Official GoCardless endpoint: GET /payment_accounts/{payment_account_transaction_id}/transactions.
gocardless.gocardless_list_payout Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your payouts. Official GoCardless endpoint: GET /payouts.
gocardless.gocardless_get_payouts Read read 1 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}.
gocardless.gocardless_update_payouts Write write 3 Updates a payout object. This accepts only the metadata parameter. Official GoCardless endpoint: PUT /payouts/{payout_id}.
gocardless.gocardless_list_payout_item Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of items in the payout. <strong>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>.</strong> Official GoCardless endpoint: GET /payout_items.
gocardless.gocardless_create_redirect_flow Write write 2 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.
gocardless.gocardless_get_redirect_flows Read read 1 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}.
gocardless.gocardless_complete_redirect_flow Read read 3 Complete a redirect flow Official GoCardless endpoint: POST /redirect_flows/{redirect_flow_id}/actions/complete.
gocardless.gocardless_create_refund Write write 2 Create a refund Official GoCardless endpoint: POST /refunds.
gocardless.gocardless_list_refund Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your refunds. Official GoCardless endpoint: GET /refunds.
gocardless.gocardless_get_refunds Read read 1 Retrieves all details for a single refund Official GoCardless endpoint: GET /refunds/{refund_id}.
gocardless.gocardless_update_refunds Write write 3 Updates a refund object. Official GoCardless endpoint: PUT /refunds/{refund_id}.
gocardless.gocardless_run_scenario_simulator Write write 3 Runs the specific scenario simulator against the specific resource Official GoCardless endpoint: POST /scenario_simulators/{scenario_simulator_id}/actions/run.
gocardless.gocardless_create_scheme_identifier Write write 2 Create a scheme identifier Official GoCardless endpoint: POST /scheme_identifiers.
gocardless.gocardless_list_scheme_identifier Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your scheme identifiers. Official GoCardless endpoint: GET /scheme_identifiers.
gocardless.gocardless_get_scheme_identifiers Read read 1 Retrieves the details of an existing scheme identifier. Official GoCardless endpoint: GET /scheme_identifiers/{scheme_identifier_id}.
gocardless.gocardless_create_subscription Write write 2 Creates a new subscription object Official GoCardless endpoint: POST /subscriptions.
gocardless.gocardless_list_subscription Read read 0 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.
gocardless.gocardless_get_subscriptions Read read 1 Retrieves the details of a single subscription. Official GoCardless endpoint: GET /subscriptions/{subscription_id}.
gocardless.gocardless_update_subscriptions Write write 3 Update a subscription Official GoCardless endpoint: PUT /subscriptions/{subscription_id}.
gocardless.gocardless_pause_subscription Write write 3 Pause a subscription Official GoCardless endpoint: POST /subscriptions/{subscription_id}/actions/pause.
gocardless.gocardless_resume_subscription Write write 3 Resume a subscription Official GoCardless endpoint: POST /subscriptions/{subscription_id}/actions/resume.
gocardless.gocardless_cancel_subscription Write write 3 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.
gocardless.gocardless_list_tax_rate Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of all tax rates. Official GoCardless endpoint: GET /tax_rates.
gocardless.gocardless_get_tax_rates Read read 1 Retrieves the details of a tax rate. Official GoCardless endpoint: GET /tax_rates/{tax_rate_id}.
gocardless.gocardless_get_transferred_mandates Read read 1 Returns new customer bank details for a mandate that's been recently transferred Official GoCardless endpoint: GET /transferred_mandates/{mandate_id}.
gocardless.gocardless_create_verification_detail Write write 2 Creates a new verification detail Official GoCardless endpoint: POST /verification_details.
gocardless.gocardless_list_verification_detail Read read 0 Returns a list of verification details belonging to a creditor. Official GoCardless endpoint: GET /verification_details.
gocardless.gocardless_list_webhook Read read 0 Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your webhooks. Official GoCardless endpoint: GET /webhooks.
gocardless.gocardless_get_webhooks Read read 1 Retrieves the details of an existing webhook. Official GoCardless endpoint: GET /webhooks/{webhook_id}.
gocardless.gocardless_retry_webhook Read read 3 Requests for a previous webhook to be sent again Official GoCardless endpoint: POST /webhooks/{webhook_id}/actions/retry.