Update mandate

Developing

PATCH

/customers/v1/transaction-mandates/{id}

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.

Pause, resume or re-label a mandate. Requires the client/write or administrator/write OAuth scope.

Send both status and metadata on every call, even when changing only one: both are currently validated as required. metadata REPLACES the stored metadata (it is not merged), so resend any keys you want to keep. When status equals the current status only metadata is updated.

Setting INACTIVE stops further debits: a new AUD_DD_1 transaction on the mandate fails with Mandate is not active. A debit already submitted is not recalled. Setting ACTIVE again resumes the mandate.

Request

Path Params

Header Params

Body Params application/json

Example

{
    "status": "INACTIVE",
    "metadata": {
        "payer_reference": "MEMBER-20931",
        "paused_reason": "payer request"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/customers/v1/transaction-mandates/' \
--header 'Idempotency-Key: {{idempotency-key}}' \
--header 'x-client-id;' \
--header 'Content-Type: application/json' \
--data '{
    "status": "INACTIVE",
    "metadata": {
        "payer_reference": "MEMBER-20931",
        "paused_reason": "payer request"
    }
}'

Responses

🟢200OK

application/json

Mandate updated.

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-12T04:02:55.730Z",
    "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": "INACTIVE",
    "metadata": {
        "payer_reference": "MEMBER-20931",
        "paused_reason": "payer request"
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2026-10-15 05:41:15

Get mandate by ID

CardWidgetSessionTokenResponse