Mandates APIbetaMandate management
Create mandate
Authorization
Bearer AuthorizationBearer <token>
Bearer token using a JWT.
In: header
Header Parameters
Idempotency-Key*string
It helps preventing duplicates in your POST requests.
It is recommend using a UUID for the key, however you may use any other unique identifier you choose.
Length
length <= 64X-Volt-Initiation-Channel*"hosted"
Channel used for setup/processing flow.
Value in
- "hosted"
X-Volt-Api-Version*1
Version of the API used. Currently, version 1 is the only version.
Value in
- 1
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
PayTo mandate creation request body.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/mandates" \ -H "Idempotency-Key: string" \ -H "X-Volt-Initiation-Channel: hosted" \ -H "X-Volt-Api-Version: 1" \ -H "Content-Type: application/json" \ -d '{ "currency": "AUD", "system": "PAY_TO", "mode": "RECURRING", "purpose": "OTHER", "internalReference": "H35X48Y4FWOD6G3S", "payer": { "reference": "JDOE-101" }, "validity": { "from": "2026-03-01 00:00:00" }, "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" }, "communication": { "notifications": { "url": "https://example.com/notifications" }, "return": { "urls": { "unified": { "url": "https://example.com/process" } } } } }'{ "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" }}{ "code": "BAD_REQUEST", "message": "string"}{ "code": "UNAUTHORISED", "message": "string"}{ "code": "ACCESS_DENIED", "message": "string"}{ "code": "CONFLICT", "message": "string"}{ "code": "VALIDATION_FAILURE", "message": "string", "errors": [ { "type": "string", "propertyPath": "string", "message": "string" } ]}{ "code": "INTERNAL_SERVER_ERROR", "message": "string"}