Sign in

v1

latestOpenAPI 3.1.02026-07-2469193340.0 KB
Transfers

Add a Transfer

Use this endpoint when you want to create a Transfer between any 2 of your float/bank accounts.

<aside class="notice">We now require supplying an <code>Idempotency-Key</code> 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 duplicate payments. To understand more on how to make idempotent requests, please refer to our <a href="https://docs.zeptopayments.com/v20260101/reference/idempotent-requests">Idempotent requests guide</a>.</aside>
post/transfers

Headers

Idempotency-Keystring required

Idempotency key to support safe retries for 24h

Request body

from_bank_account_idstring required

The source float/bank account (UUID)

to_bank_account_idstring required

The destination float/bank account (UUID)

amountinteger required

Amount in cents (Min: 1 - Max: 99999999999)

descriptionstring required

Description for the Transfer. ASCII-printable characters and unicode emojis are accepted.

matures_atstring date-time required

Date & time in UTC ISO8601 the Transfer should be processed. (Can not be earlier than the start of current day in Sydney AEST/AEDT)

Example request

{
  "from_bank_account_id": "a79423b2-3827-4cf5-9eda-dc02a298d005",
  "to_bank_account_id": "0921a719-c79d-4ffb-91b6-1b30ab77d14d",
  "amount": 100000,
  "description": "Float account balance adjustment",
  "matures_at": "2021-06-06T00:00:00Z"
}

Response

Created

Example response

{
  "data": {
    "ref": "T.11ub",
    "from_bank_account_id": "a79423b2-3827-4cf5-9eda-dc02a298d005",
    "to_bank_account_id": "0921a719-c79d-4ffb-91b6-1b30ab77d14d",
    "amount": 100000,
    "description": "Float account balance adjustment",
    "matures_at": "2021-06-06T00:00:00Z"
  }
}