Developer Docs

Guides

Bank Payments

Setting up mandates

Direct Debit Mandates Verified Mandates PayTo Agreements and Payments Build a client to create mandates offline Supporting mandates set up outside of your product Importing Mandates Blocking mandates

One-off payments

Taking an Instant Bank Payment Taking a one off payment

Recurring payments

Taking Subscription payments Taking Instalment payments Variable Recurring Payments

Combining one-off and recurring payments

Take a first Instant Payment with mandate  set up

Responding to events

Responding to Mandate Events Responding to Billing Requests Events

FX Payments Reconciling Payouts ACH and PAD Consent Types VRP Commercial Payment Purpose Codes Billing Request Purpose Codes

Send money

Introduction to Outbound Payments Payment Account API request signing

Send an outbound payment

Adding a new recipient Initiate an outbound payment Approve an outbound payment Cancel an outbound payment

Tracking outbound payments Bank Account Holder Verification Strong Customer Authentication

Optimise and increase revenue

Prevent fraud with Protect+ Retain customers with fallbacks Reduced failed payments with Success+

Prefill customer details

New customer record Existing customer record Populate Billing Request Flow

Tutorials

Taking Direct Debit payments using Billing Requests and Custom Payment Pages Handling tax Handling Customer Notifications

GoCardless Embed

Introduction Creating a creditor Adding a creditor bank account Optional Setting a scheme identifer Optional

Setting up mandates / collecting payments

Billing Request with Actions: Setting up a Direct Debit mandate Collecting a Direct Debit payment Billing Request with Actions: Taking an Instant Bank Payment Billing Request with Actions Dual Flow: Taking an Instant Bank Payment and setting up a Direct Debit mandate

Handling webhooks

Reconciling payouts

Payout Items API Automated Payout Reporting Optional

Setting Up Branding Optional API request signing Optional Bank Details Access Optional

Bank Account Data

Overview Quickstart Guide Endpoints Bank Selection UI Sandbox Statuses and Error code Output: Account Details Output: Balances Output: Transaction Details Postman Collection FAQs

GoCardless Embed

Creating a creditor

In this step of the GoCardless Embed guide you will create a creditor to represent one of your merchants.

By having a creditor for each merchant you will be able to pay out separately for each creditor, customise the beneficiary name the payer sees, and perform reconciliation on a per-merchant basis.

POST /creditors

You can create a creditor by performing a POST request to the /creditors endpoint. The required parameters are:

Parameter	Description
name	The trading name of the creditor.
creditor_type	The type of business of the creditor. One of: `individual`, `company`, `charity`, `partnership`, and `trust`.
country_code	The country that the creditor is registered in, as a ISO 3166-1 alpha-2 code.

Examples of how to make this request using the GoCardless client libraries:

POST https://api.gocardless.com/creditors HTTP/1.1
Content-Type: application/json
{
  "creditors": {
    "name": "Example Ltd",
    "country_code": "GB",
    "creditor_type": "company"
  }
}

HTTP/1.1 201 Created
Location: /creditors/CR123
Content-Type: application/json
{
  "creditors": {
    "id": "CR123",
    "created_at": "2017-02-16T12:34:56.000Z",
    "name": "Example Ltd",
    "creditor_type": "company",
    "country_code": "GB",
    ...
  }
}

The API will respond with a creditor object containing a creditor ID starting with 'CR'. This ID will be used in subsequent steps.

For more details, see the API reference docs for this endpoint.

What's next?

Adding a creditor bank account

Connect as a partner