Loading...
Mandates APIbetaMandate management

Get mandate details

GET
/mandates/{id}
AuthorizationBearer <token>

Bearer token using a JWT.

In: header

Path Parameters

id*string

Identifier of the mandate.

Formatuuid

Header Parameters

X-Volt-Api-Version*integer

Version of the API used. Currently, version 1 is the only version.

Value in1

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://gateway.sandbox.volt.io/mandates/82f82950-8ece-4ae2-ac9d-46bffd1bedfb" \  -H "X-Volt-Api-Version: 1"
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "currency": "AUD",
  "system": "PAY_TO",
  "mode": "RECURRING",
  "purpose": "OTHER",
  "internalReference": "H35X48Y4FWOD6G3S",
  "payer": {
    "reference": "JDOE-101",
    "firstName": null,
    "lastName": null,
    "email": null,
    "accountIdentifiers": {
      "accountName": "John Doe",
      "payId": "john@doe.com",
      "payIdType": "EMAIL"
    }
  },
  "beneficiary": {
    "name": "Jane Doe"
  },
  "validity": {
    "from": "2026-03-01 00:00:00",
    "to": null
  },
  "payTo": {
    "accountIdentifiers": {
      "accountName": "John Doe",
      "payId": "john@doe.com",
      "payIdType": "EMAIL"
    },
    "limits": {
      "periodic": {
        "period": "MONTH",
        "maxPaymentsCount": 3
      },
      "payment": {
        "maxAmount": 70000
      }
    },
    "description": "Coffee subscription #123123"
  },
  "device": {
    "ip": "192.168.0.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0",
    "fingerprint": "2aae6c35c94fcfb415dbe95f408b9ce91ee846ed"
  },
  "status": {
    "status": "AWAITING_AUTHORISATION",
    "details": null
  },
  "mandateSetupFlow": {
    "status": "PROCESSING"
  }
}