Create mandate

In development. Direct debit is available in sandbox for integration testing and is not yet available in production. Request and response formats are stable; wallet balance handling for direct debits is being finalised in sandbox.

Create a direct debit mandate: the limits within which you may debit one payer. Requires the client/write or administrator/write OAuth scope.

You must hold the payer's Direct Debit Request authority before debiting them. The mandate records the limits only and is not tied to a payer bank account, so create one mandate per payer agreement and always debit that payer's beneficiary with it.

The mandate is created ACTIVE, in AUD, with last_iteration 0. Unknown body properties are rejected with 400.

Schedule. For NON_RECURRING the debit is due from starts_at. For every other frequency the first debit is due one period AFTER starts_at, and each later debit one period after the previous debit's date. Example: a MONTHLY mandate starting 1 March allows its first debit from 1 April. Set starts_at one period before the first collection date. NON_RECURRING does not itself cap the count; set max_iterations to 1 for a one-off debit.

See the Direct debit guide for the end-to-end flow.

{ "starts_at": "2026-10-12", "expires_at": "2027-10-12", "frequency": "MONTHLY", "max_amount": 100, "max_iterations": 12, "metadata": { "payer_reference": "MEMBER-20931" } }

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Mandate created, ACTIVE.

Bodyapplication/json

Example

{
    "id": "5d1c9a7e-2b4f-4e8a-9c3d-7f6a1b2e8d40",
    "owner": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "created_at": "2026-10-12T02:41:07.512Z",
    "updated_at": "2026-10-12T02:41:07.512Z",
    "starts_at": "2026-10-12T00:00:00.000Z",
    "expires_at": "2027-10-12T00:00:00.000Z",
    "frequency": "MONTHLY",
    "max_amount": 100,
    "max_iterations": 12,
    "last_transaction_id": null,
    "last_transaction_date": null,
    "last_transaction_status": null,
    "last_transaction_amount": 0,
    "last_iteration": 0,
    "asset_class": "CURRENCY",
    "asset": "AUD",
    "status": "ACTIVE",
    "metadata": {
        "payer_reference": "MEMBER-20931"
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden