Request Payment

We now require supplying an Idempotency-Key header when performing this request to ensure you can safely retry the action in case of an issue. If the header value is different to one provided previously, we will be treating a request as a new operation which may lead to a duplicate funds collection. To understand more on how to make idempotent requests, please refer to our Idempotent requests guide.
Body Params
string
required

Description visible to the initiator (payee). The first 9 characters supplied will be visible to the authoriser (payer)

date-time
required

Date & time in UTC ISO8601 that the Payment will be processed if the request is approved. (If the request is approved after this point in time, it will be processed straight away)

integer
required
1 to 99999999999

Amount in cents to pay the initiator (Min: 1 - Max: 99999999999)

string
required

The Contact the payment will be requested from (Contact.data.id)

uuid

Specify where we should settle the funds for this transaction. If omitted, your primary bank account will be used.

metadata
object

Use for your custom data and certain Zepto customisations. Stored against generated transactions and included in associated webhook payloads.

Headers
string
required

Idempotency key to support safe retries for 24h

string
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses

Language
Credentials
OAuth2
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json