Create a transfer

post

https://api.aidev.payouts.com/api/v1/wire-transfers/create

Create a new wire transfer. The transfer can be to a bank account or digital wallet, depending on the transfer method. Always validate the transfer first using the /validate endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

beneficiary

object

required

beneficiaryId

string

ID of a previously saved beneficiary (alternative to beneficiary object)

payer

object

required

payerId

string

ID of a previously saved payer (alternative to payer object)

sourceCurrency

string

required

^[A-Z]{3}$

Currency the payer uses to fund the transfer (3-letter ISO 4217)

sourceAmount

number

Amount in source currency (either this or transferAmount required)

transferAmount

number

Amount in transfer currency (either this or sourceAmount required)

transferCurrency

string

required

^[A-Z]{3}$

Currency the beneficiary receives (3-letter ISO 4217)

transferMethod

string

enum

required

Transfer method

Allowed:

transferDate

date

Date when transfer should be made (ISO 8601 format)

reason

string

enum

required

Reason for the transfer

reference

string

required

length between 1 and 140

Reference shown on beneficiary's bank statement (1-140 characters)

remarks

string

length ≤ 200

Internal remarks (not shown to beneficiary, 1-200 characters)

requestId

string

required

length between 10 and 50

Unique idempotency key (10-50 characters)

feePaidBy

string

enum

Who pays the transfer fee

Allowed:

swiftChargeOption

string

enum

SWIFT charge option (for SWIFT transfers only)

Allowed:

metadata

object

Custom metadata (key-value pairs)

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Transfer created successfully

400Invalid request or validation failed

401Unauthorized

409Duplicate request_id