Recurring payments
Execute payment
POST
/paymentsExecutes a payment against an active recurring consent. Returns 201 on first execution, 200 if the idempotency key has been seen before.
Authorization
bearer AuthorizationBearer <token>
Your Volley API key as a bearer token
In: header
Request Body
application/json
Payload for executing a payment against a recurring consent
Response Body
application/json
application/json
application/json
application/json
const body = JSON.stringify({ "token": "tok_abc123", "idempotency_key": "inv_12345_2025_02", "amount": "10.00 NZD"})fetch("https://example.com/payments", { method: "POST", headers: { "Content-Type": "application/json" }, body}){ "payment": { "id": "payment_Bzv6djpVl07tmMx2Tuode", "request_id": "request_8GbnJK6WrxGvPobCylFDO", "amount": { "value": "10.00 NZD", "formatted": "$10.00" }, "status": "pending", "url": "https://app.volley.nz/pay/8GbnJK6WrxGvPobCylFDO/Bzv6djpVl07tmMx2Tuode", "qr_data": "data:image/svg;...", "merchant_identifier": "merchant_abc123", "cust_info": { "id": "custinfo_OJKskG1WEa70sQG8NV468", "payment_id": "payment_Bzv6djpVl07tmMx2Tuode", "email": "customer@example.com", "phone": "+1234567890", "first_name": "John", "last_name": "Doe", "address1": "Building", "address2": "123 Main Street", "address3": "Te Aro", "address4": "", "city": "Wellington", "postcode": "6011", "marketing_opt_in": false, "created_at": "2025-01-15T10:30:00Z", "updated_at": "2025-01-15T10:30:00Z" }, "provider": "anz", "is_test_mode": false, "created_at": "2025-02-12T08:30:00Z", "updated_at": "2025-02-12T08:30:00Z", "completed_at": null }}{ "payment": { "id": "payment_Bzv6djpVl07tmMx2Tuode", "request_id": "request_8GbnJK6WrxGvPobCylFDO", "amount": { "value": "10.00 NZD", "formatted": "$10.00" }, "status": "pending", "url": "https://app.volley.nz/pay/8GbnJK6WrxGvPobCylFDO/Bzv6djpVl07tmMx2Tuode", "qr_data": "data:image/svg;...", "merchant_identifier": "merchant_abc123", "cust_info": { "id": "custinfo_OJKskG1WEa70sQG8NV468", "payment_id": "payment_Bzv6djpVl07tmMx2Tuode", "email": "customer@example.com", "phone": "+1234567890", "first_name": "John", "last_name": "Doe", "address1": "Building", "address2": "123 Main Street", "address3": "Te Aro", "address4": "", "city": "Wellington", "postcode": "6011", "marketing_opt_in": false, "created_at": "2025-01-15T10:30:00Z", "updated_at": "2025-01-15T10:30:00Z" }, "provider": "anz", "is_test_mode": false, "created_at": "2025-02-12T08:30:00Z", "updated_at": "2025-02-12T08:30:00Z", "completed_at": null }}{ "code": "bad_request.invalid_param.amount", "message": "Invalid format for amount (valid: '10.00 NZD')", "params": {}}{ "code": "bad_request.invalid_param.amount", "message": "Invalid format for amount (valid: '10.00 NZD')", "params": {}}