Create recurring payment

Initiate payment based on an existing ACTIVE mandate.

Authorization

Bearer

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

currency*string

Payment currency. ISO 4217 format (3 uppercase letters).

Length3 <= length <= 3

amount*integer

Payment amount in minor units (e.g. cents).

Range0 < value

paymentReference?string

Unique payment reference provided by the partner. Used for reconciliation.

Reference must contain only alphanumeric characters.

If value is not provided, it will be generated by Volt.

Lengthlength <= 18

internalReference?string

Your internal identifier for this transaction.

Lengthlength <= 100

communication?

Partner communication settings.

Response Body

`application/json`

curl -X POST "https://gateway.sandbox.volt.io/mandates/82f82950-8ece-4ae2-ac9d-46bffd1bedfb/payments" \  -H "X-Volt-Api-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "currency": "AUD",    "amount": 10000  }'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "currency": "AUD",
  "amount": 10000,
  "paymentReference": "T1Qwerty",
  "internalReference": "H35X48Y4FWOD6G3S",
  "paymentSystem": "NPP_PAY_TO_AU",
  "nppPayToAU": {
    "type": "OTHER",
    "validityPeriod": 30,
    "additionalDescription": null,
    "accountIdentifiers": {
      "payId": "john@doe.com",
      "payIdType": "EMAIL"
    },
    "ultimateBeneficiary": null
  },
  "payer": {
    "reference": "JDOE-101",
    "firstName": null,
    "lastName": null,
    "organisationName": null,
    "email": null,
    "accountIdentifiers": {
      "payId": "john@doe.com",
      "payIdType": "EMAIL"
    }
  },
  "sender": {
    "name": "John Doe",
    "accountIdentifiers": {
      "payId": "john@doe.com",
      "payIdType": "EMAIL"
    }
  },
  "beneficiary": {
    "name": "Jane Doe",
    "accountIdentifiers": {
      "payId": "jane@doe.com",
      "payIdType": "EMAIL"
    }
  },
  "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": "AUTHORISED_BY_USER",
  "transferType": null,
  "displayInfo": null,
  "mandateId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdAt": "2026-03-15T15:52:01+00:00",
  "updatedAt": "2026-03-15T15:52:01+00:00",
  "paymentInitiationFlow": {
    "status": "PROCESSING"
  }
}

{
  "code": "MISSING_HTTP_HEADER",
  "message": "Missing \"X-Volt-Initiation-Channel\" HTTP header."
}

{
  "code": "UNAUTHORISED",
  "message": "Unauthorised."
}

{
  "code": "ACCESS_DENIED",
  "message": "Access denied."
}

{
  "code": "RESOURCE_NOT_FOUND",
  "message": "Not found."
}

{
  "code": "IDEMPOTENCY_CONFLICT",
  "message": "Idempontency key already used."
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Something went wrong. Please, contact support. TraceId: b8cfd344-093c-4b8c-8fd4-f0e406060c3c. Timestamp: 1723193467."
}

Create recurring payment

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`