GoCardless

Create a billing request — the modern flow to collect a mandate and/or an instant payment (POST /billing_requests). Body wrapped as { "billing_requests": { ... } }.

List billing requests (GET /billing_requests). Cursor pagination; filter by customer, status, created_at.

Get a billing request by id (GET /billing_requests/{id}).

Collect customer details on a billing request (POST /billing_requests/{id}/actions/collect_customer_details).

Collect bank account details on a billing request (POST /billing_requests/{id}/actions/collect_bank_account).

Confirm the payer's details on a billing request (POST /billing_requests/{id}/actions/confirm_payer_details).

Fulfil a billing request that is ready, creating the mandate and/or payment (POST /billing_requests/{id}/actions/fulfil).

Cancel a billing request (POST /billing_requests/{id}/actions/cancel).

Create a mandate against a customer bank account (POST /mandates). Body wrapped as { "mandates": { ... } }.

List mandates (GET /mandates). Cursor pagination; filter by customer, creditor, status, reference, created_at.

Get a mandate by id (GET /mandates/{id}).

Update a mandate's metadata (PUT /mandates/{id}). Body wrapped as { "mandates": { ... } }.

Cancel a mandate so no further payments can be collected against it (POST /mandates/{id}/actions/cancel).

Reinstate a cancelled mandate (POST /mandates/{id}/actions/reinstate). Only permitted where the scheme allows it.

Create a payment against an active mandate (POST /payments). Body wrapped as { "payments": { ... } }.

List payments (GET /payments). Cursor pagination; filter by mandate, customer, creditor, subscription, status, charge_date, created_at.

Get a payment by id (GET /payments/{id}).

Update a payment's metadata (PUT /payments/{id}). Body wrapped as { "payments": { ... } }.

Cancel a payment before it is submitted to the banks (POST /payments/{id}/actions/cancel).

Retry a failed payment (POST /payments/{id}/actions/retry). Only permitted for payments in a retriable state.

Create a customer bank account (POST /customer_bank_accounts). Body wrapped as { "customer_bank_accounts": { ... } }.

List customer bank accounts (GET /customer_bank_accounts). Cursor pagination.

Get a customer bank account by id (GET /customer_bank_accounts/{id}).

Update a customer bank account's metadata (PUT /customer_bank_accounts/{id}). Body wrapped as { "customer_bank_accounts": { ... } }.

Disable a customer bank account (POST /customer_bank_accounts/{id}/actions/disable).

Create a subscription (recurring payments) against a mandate (POST /subscriptions). Body wrapped as { "subscriptions": { ... } }.

List subscriptions (GET /subscriptions). Cursor pagination; filter by customer, mandate, status, created_at.

Get a subscription by id (GET /subscriptions/{id}).

Update a subscription (PUT /subscriptions/{id}). Body wrapped as { "subscriptions": { ... } }.

Cancel a subscription so no further payments are created (POST /subscriptions/{id}/actions/cancel).

Create a creditor bank account for payouts (POST /creditor_bank_accounts). Body wrapped as { "creditor_bank_accounts": { ... } }.

List creditor bank accounts (GET /creditor_bank_accounts). Cursor pagination.

Get a creditor bank account by id (GET /creditor_bank_accounts/{id}).

Disable a creditor bank account (POST /creditor_bank_accounts/{id}/actions/disable).

Create a customer (POST /customers). Body wrapped as { "customers": { ... } }.

List customers (GET /customers). Cursor pagination; created_at filters supported.

Get a customer by id (GET /customers/{id}).

Update a customer (PUT /customers/{id}). Body wrapped as { "customers": { ... } }.

Begin a bulk mandate import (POST /mandate_imports). Body wrapped as { "mandate_imports": { ... } }.

Get a mandate import by id (GET /mandate_imports/{id}).

Submit a mandate import for processing once all entries are added (POST /mandate_imports/{id}/actions/submit).

Cancel a mandate import that has not yet been submitted (POST /mandate_imports/{id}/actions/cancel).

Refund a confirmed payment (POST /refunds). Body wrapped as { "refunds": { ... } }.

List refunds (GET /refunds). Cursor pagination; filter by payment, mandate, refund_type, created_at.

Get a refund by id (GET /refunds/{id}).

Update a refund's metadata (PUT /refunds/{id}). Body wrapped as { "refunds": { ... } }.

List creditors linked to the access token (GET /creditors). Safe read used as the identity + connectivity probe.

Get a single creditor by id (GET /creditors/{id}).

Update a creditor (PUT /creditors/{id}). Body must be wrapped as { "creditors": { ... } }.

Create a redirect flow — the legacy hosted mandate setup flow (POST /redirect_flows). Body wrapped as { "redirect_flows": { ... } }.

Get a redirect flow by id (GET /redirect_flows/{id}).

Complete a redirect flow after the payer returns, creating the customer, bank account and mandate (POST /redirect_flows/{id}/actions/complete).

Get a bank authorisation by id (GET /bank_authorisations/{id}).

Create a bank authorisation for an open-banking flow (POST /bank_authorisations). Body wrapped as { "bank_authorisations": { ... } }.

Create a hosted flow for a billing request that the payer can complete (POST /billing_request_flows). Body wrapped as { "billing_request_flows": { ... } }.

Initialise a billing request flow to obtain the authorisation URL (POST /billing_request_flows/{id}/actions/initialise).

List events — the audit stream of everything that happens on your account (GET /events). Cursor pagination; filter by resource_type, action, mandate, payment, subscription, payout, refund, created_at. This is the polling source for change notifications.

Get a single event by id (GET /events/{id}).

Add an entry (a customer + bank account + mandate) to a mandate import (POST /mandate_import_entries). Body wrapped as { "mandate_import_entries": { ... } }.

List the entries within a mandate import (GET /mandate_import_entries). The mandate_import query parameter is required.

List payouts sent to your creditor bank accounts (GET /payouts). Cursor pagination; filter by creditor, status, payout_type, created_at.

Get a payout by id (GET /payouts/{id}).

List available tax rates (GET /tax_rates). Cursor pagination; filter by jurisdiction.

Get a tax rate by id (GET /tax_rates/{id}).

List the banks (institutions) available for open-banking flows (GET /institutions). Filter by country_code.

List the individual items (payments, refunds, fees) that make up a payout (GET /payout_items). The payout query parameter is required.

Run a sandbox scenario simulator to advance a resource through its lifecycle (POST /scenario_simulators/{id}/actions/run). Sandbox only.