Guides

Collecting your client’s payment authorisation via an online form isn’t always possible or doesn’t match how you would normally interact with your customers.

To help with this, we also offer paper and phone authorisation collection options (subject to regional availability).

Collect paper or telephonic authorisation from your customers

This page details the steps required for you to collect authorisation this way. Please ensure that you read it and are comfortable with the compliance requirements.

If you are interested in using one or both of these methods but haven’t yet had this feature enabled on your account, please see here for more information on how to get this set up.

Build a client to create mandates offline

There are two approaches you may take based on your current integration and future plans.

Core Endpoints: This API supports bank debit features. Use it if you are already integrated with it and don’t intend to implement Instant Bank Pay.
Billing Requests API: This is our newest API, which supports both bank debit and open banking use cases. Use it if you intend to build open banking functionality in future.

Before you create a mandate using the core endpoints, you will need to create a customer and create a bank account for that customer. We will start by creating a customer.

Use the Create a customer endpoint.

$client = new \GoCardlessPro\Client(array(
  'access_token' => 'your_access_token_here',
  'environment'  => \GoCardlessPro\Environment::SANDBOX
));

$client->customers()->create([
  "params" => ["email" => "user@example.com",
               "given_name" => "Frank",
               "family_name" => "Osborne",
               "address_line1" => "27 Acer Road",
               "address_link2" => "Apt 2",
               "city" => "Los Angeles",
               "postal_code" => "90213",
               "country_code" => "US",
               "region" => "CA"]
]);

This returns a customer that will look something like this:

{
    "customers": {
        "id": "CU0000QGB3Q04D",
        "created_at": "2022-12-14T10:44:07.558Z",
        "email": "user@example.com",
        "given_name": "Frank",
        "family_name": "Osborne",
        "company_name": null,
        "address_line1": "27 Acer Road",
        "address_line2": "Apt 2",
        "address_line3": null,
        "city": "Los Angeles",
        "region": "CA",
        "postal_code": "90213",
        "country_code": "US",
        "language": "en",
        "swedish_identity_number": null,
        "danish_identity_number": null,
        "phone_number": null,
        "metadata": {}
    }
}

We will be using the id of the customer in the next step to create the customer bank account.

Create a new customer bank account, linking the customer id from the previous step.

Use the Create a customer bank account endpoint.

$client = new \GoCardlessPro\Client(array(
  'access_token' => 'your_access_token_here',
  'environment'  => \GoCardlessPro\Environment::SANDBOX
));

$client->customerBankAccounts()->create([
  "params" => ["account_number" => "2715500356",
               "branch_code" => "026073150",
               "account_holder_name" => "Frank Osborne",
               "currency" => "USD",
               "country_code" => "US",
               "account_type" => "checking",
               "links" => ["customer" => "CU123"]]
]);

This will return a customer bank account that will look like this:

{
    "customer_bank_accounts": {
        "id": "BA123",
        "created_at": "2014-05-08T17:01:06.000Z",
        "account_number_ending": "56",
        "account_holder_name": "FRANK OSBORNE",
        "account_type": "checking",
        "bank_name": "Community Federal Savings Bank",
        "currency": "USD",
        "country_code": "US",
        "metadata": {},
        "enabled": true,
        "links": {
            "customer": "CU123"
        }
    }
}

We will be using the id of the customer_bank_account in the next step to create a mandate.

Create a Mandate request linking the customer_bank_account in the request.

For ACH specific mandates, you can provide the authorisation_source field to create an offline mandate. The authorisation_source field specifies the way in which the payer gave authorisation to the merchant. This is sometimes referred to as SEC code. This field takes values of either telephone, paper or web.

Use the Create a mandate endpoint:

$client = new \GoCardlessPro\Client(array(
  'access_token' => 'your_access_token_here',
  'environment'  => \GoCardlessPro\Environment::SANDBOX
));

$client->mandates()->create([
  "params" => ["scheme" => "ach",
							 "authorisation_source" => "telephone",
               "links" => ["customer_bank_account" => "BA123","creditor" => "CR123"]]
]);

You’ll receive a full Mandate resource back.

It will look like this, some detail omitted:

{
  "mandates": {
    "id": "MD123",
    "created_at": "2014-05-08T17:01:06.000Z",
    "reference": "REF-123",
    "status": "pending_submission",
    "scheme": "ach",
    "next_possible_charge_date": "2014-11-10",
    "metadata": {
      "contract": "ABCD1234"
    },
    "links": {
      "customer_bank_account": "BA123",
      "creditor": "CR123",
      "customer": "CU123"
    },
    "authorisation_source": "telephone"
  }
}

You can now take payments from this mandate using the Create a payment API.

Need help?

Connect as a partner

Guides

Build a client to create mandates offline

Build a client to create mandates offline

Create a customer

Create a customer bank account

Create an offline mandate via Mandate API