Mandate

Create a mandate

Creates a new mandate object.

<p class="restricted-notice"><strong>Restricted</strong>: this endpoint requires approved [custom payment pages](https://support.gocardless.com/hc/en-gb/articles/115004521925-Custom-Payment-Pages).</p> <p class="notice"><strong>Note</strong>: this endpoint is a legacy API endpoint and does not support GoCardless' newest features. We recommend using the [Billing Requests API](https://docs.gocardless.com/docs/collect-payments/setting-up-mandates) instead.</p> <p class="notice--warning"><strong>Warning</strong>: by default, the ability to provide a custom mandate reference is switched off. The banking system rules for valid references are quite complex, and we recommend allowing GoCardless to generate it. If you would like to provide custom references, please contact support.</p>
post/mandates

Request

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

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "mandates": {
    "reference": "REF-123",
    "scheme": "bacs",
    "payer_ip_address": "127.0.0.1",
    "links": {
      "customer_bank_account": "BA123",
      "creditor": "CR123"
    }
  }
}

Response

Resource created successfully

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"
    }
  }
}

Changes

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