Bulk Transfer

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sends several transfers in one request. Each item in requests has the same fields as a Single Transfer.

Transfers are processed one at a time, in the order you send them. If one fails, the rest still go ahead. The response always returns 200 with one result per reference, so check status on each item.

🚧

Duplicate references reject the whole batch

If the same reference appears more than once in requests, the whole request is rejected with 204 and nothing is sent. A reference that was already used by an earlier transfer only fails that item, with 439.

Because items run in order against the same wallet balance, later items can fail with 252 if earlier ones used up the balance.

Errors

Errors for the whole request:

CodeMessageWhen
204Input is invalidrequests is empty, an item is missing a field, or a reference repeats within the batch
342You do not have permission to take that actionMissing transfers:create_bulk or transfers:manage

Errors for single items appear in that item's error and use the Single Transfer codes.

Path Params
integer
required

Your business ID

Body Params
requests
array of objects
required
length ≥ 1

The transfers to send, at least one. Each reference must be unique within the batch.

requests*
string
required
length ≤ 50
^[A-Za-z0-9_.-]+$

Your unique reference for this transfer. Used as the transfer's refid. Must be unique across Vendy; letters, numbers, -, _ and . only, up to 50 characters.

number
required

Amount to send, in the wallet's currency. Fees are charged on top.

string
required

Description of the transfer, stored on the payout

integer
required

ID of the wallet to debit. Must belong to the business in the path.

string
required

Beneficiary bank code from List Banks

string
required

Beneficiary account number

string
required

Beneficiary account name, as returned by Validate Account

Responses

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