Create a transfer

post

https://example.com/api/v1/transfers

This API will create a new transfer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Optionally include the fxQuoteId field in the request body to apply a previously created FX quote to the transfer. If fxQuoteId is not provided, a new FX quote is generated automatically when the transfer is initiated.
Optionally include the senderToken field in the request body to associate an existing sender with the transfer. Alternatively, you can provide a sender object when creating the transfer.

Body Params

Transfer API Request Model

merchantTransactionId

string

required

length ≤ 50

A unique identifier for the transaction.

beneficiaryToken

string

required

length ≤ 36

The Beneficiary's Token

destinationToken

string | null

The destination token for the transfer.

autoApprove

boolean

required

Whether the transfer should be automatically approved.

comments

string | null

Comments for the transfer.

dateExpire

date-time

required

The expiration date of the transfer. ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and milliseconds. YYYY -MM-DD

sourceAmount

double | null

The amount of money to be transferred from the source.

sourceCurrency

string

required

length ≤ 3

The currency of the source amount.

destinationAmount

double | null

The amount of money to be transferred to the destination. If null, it will be calculated based on the source amount and the exchange rate.

destinationCurrency

string

required

length ≤ 3

The currency of the destination amount.

destinationType

string

required

Destination Type - Available options are Bank, Wire, CreditCard, Check, Crypto, Interac, RegularACH,
SameDayACH, RealtimeACH

purposeOfPayment

string | null

Purpose of Payment

wireProfile

object

View model for create/edit wire profile

bankAccount

object

Bank Account View model for Add/Edit bank account

sender

object

Request model for creating new sender

senderToken

string | null

The Sender's Token

crypto

object

fxQuoteId

string | null

Id of the relevant Fx Quote

paymentDescription

string | null

Message to send receiver

Responses

Language

Credentials

Loading…

Response

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

application/json

200Success

400Bad Request

500Server Error