GOgocardless
Mandate

List mandates

Returns a cursor-paginated list of your mandates.

get/mandates

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Query parameters

beforestring nullable

Cursor pointing to the end of the desired set.

afterstring nullable

Cursor pointing to the start of the desired set.

integer
OR
string

Number of records to return.

gtstring date-time

Limit to records created after the specified date-time.

ltstring date-time

Limit to records created before the specified date-time.

gtestring date-time

Limit to records created on or after the specified date-time.

ltestring date-time

Limit to records created on or before the specified date-time.

customerstring
Example:CU123

ID of a customer. If specified, this endpoint will return all mandates for the given customer. Cannot be used in conjunction with customer_bank_account or creditor

creditorstring
Example:CR123

ID of a creditor. If specified, this endpoint will return all mandates for the given creditor. Cannot be used in conjunction with customer or customer_bank_account

customer_bank_accountstring
Example:BA123

ID of a customer bank account. If specified, this endpoint will return all mandates for the given bank account. Cannot be used in conjunction with customer or creditor

statusstring

One or more valid statuses

schemestring
Example:bacs

Scheme you'd like to retrieve mandates for

mandate_type'bank_debit' | 'instant' | 'recurring' | 'vrp_commercial' | 'vrp_sweeping' nullable
Example:bank_debit

Mandate type

referencestring nullable

Unique reference. Different schemes have different length and character set requirements. GoCardless will generate a unique reference satisfying the different scheme requirements if this field is left blank.

Example:REF-123
includestring

Includes linked resources in the response. Use customer to embed customer details, or bank_account to embed bank account details.

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "mandates": [
    {
      "id": "MD123",
      "created_at": "2014-01-01T12:00:00.000Z",
      "reference": "REF-123",
      "status": "pending_submission",
      "scheme": "bacs",
      "mandate_type": "bank_debit",
      "next_possible_charge_date": "2014-10-27",
      "next_possible_standard_ach_charge_date": "2014-10-27",
      "verified_at": "2021-01-01T12:00:00.000Z",
      "links": {
        "customer_bank_account": "BA123",
        "creditor": "CR123",
        "new_mandate": "MD123",
        "customer": "CU123"
      }
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.