List mandates

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.

Retrieve all of your direct debit mandates, each with the transactions made against it. Returns an ARRAY with no pagination or filters. Requires the client/read, client/write, administrator/read or administrator/write scope.

A mandate is the limits envelope for one payer agreement: maximum amount per debit, number of debits, frequency and validity window. Debits are created with POST /customers/v1/transactions and payment_type AUD_DD_1. See the Direct debit guide.

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "id": "5d1c9a7e-2b4f-4e8a-9c3d-7f6a1b2e8d40",
    "owner": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "created_at": "2026-09-01T03:20:11.904Z",
    "updated_at": "2026-10-01T01:15:42.301Z",
    "starts_at": "2026-09-01T00:00:00.000Z",
    "expires_at": "2027-09-01T00:00:00.000Z",
    "frequency": "MONTHLY",
    "max_amount": 100,
    "max_iterations": 12,
    "last_transaction_id": "c3a7e9d1-4f2b-4b8e-a6c5-9d0e1f2a3b75",
    "last_transaction_date": "2026-10-01T01:15:42.118Z",
    "last_transaction_status": "ACCEPTED",
    "last_transaction_amount": 49.95,
    "last_iteration": 1,
    "asset_class": "CURRENCY",
    "asset": "AUD",
    "status": "ACTIVE",
    "metadata": {
        "payer_reference": "MEMBER-20931"
    },
    "transactions": [
        {
            "id": "c3a7e9d1-4f2b-4b8e-a6c5-9d0e1f2a3b75",
            "amount": 49.95,
            "asset": "AUD",
            "asset_class": "CURRENCY",
            "created_at": "2026-10-01T01:15:42.118Z",
            "external_id": null,
            "from": "4b353200-a204-e345-ddf5-0b0c7f011c9a",
            "payment_type": "AUD_DD_1",
            "reference": "GYM MEMBERSHIP OCT",
            "status": "ACCEPTED",
            "to": "8e2f4c1a-6b3d-4a9e-b7c5-2d1f0e9a3b64",
            "type": "RECEIVE",
            "updated_at": "2026-10-02T22:04:10.507Z",
            "metadata": {
                "invoice": "INV-1042"
            },
            "info": {
                "receiver": {
                    "name": "Jane Citizen"
                }
            },
            "reason": null,
            "reason_code": null,
            "program_id": null,
            "owner": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "mandate_id": "5d1c9a7e-2b4f-4e8a-9c3d-7f6a1b2e8d40"
        }
    ]
}

🟠401Unauthorized

🟠403Forbidden

Request

Request Code Samples

Responses