Single Transfer

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

Sends money from one of your wallets to a bank account.

When the request succeeds, the wallet is debited for amount plus any fee. The transfer is created as pending and a payout_received webhook is sent. Track the result with webhooks or Get Transfer.

📘

Validate first

Call Validate Account before sending, and use the accountName it returns as destinationAccountName.

Your reference must be unique across Vendy. See References.

Errors

CodeMessageWhen
204Input is invalidA required field is missing or malformed
221Wallet not foundsourceWallet does not exist or belongs to another business
252Your balance is insufficientThe wallet can't cover the amount plus fees
325Business not activeYour business is not active
338Your business is currently under review / Please complete KYCYour business has not finished verification
342You do not have permission to take that actionMissing the transfer or payout permissions
349Bank account does not have bank code associated with itdestinationBankCode is not a supported bank
439A transfer with this reference already existsreference has been used before
328Error occurred while creating payoutUnexpected failure; the wallet was not debited
Path Params
integer
required

Your business ID

Body Params
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