Contents:
Overview
Transfers represent the building blocks of our API. Our Transfer API is an incredibly versatile way of moving and converting funds within platform connected accounts and wallets.
You can specify differing source and destination currencies and the funds will automatically exchanged into the appropriate currency in our backend. The destination of funds is established by defining the SRN of a beneficiary account, wallet, paymentmethod, bitcoin or ethereum address.
Anytime you want to move funds around on the Wyre platform you will create a Transfer. The Transfer will go through a number of states as funds are moved to the destination of your choice.
{
"id": "TF-4F3HRUYPNFY",
"sourceAmount": 200,
"sourceCurrency": "USD",
"destAmount": 1370,
"destCurrency": "CNY",
"status": "COMPLETED",
"message": "",
"customId": null,
"exchangeRate": 7.0000000028,
"createdAt": 1541552388000,
"fees": {
"USD": 4.29,
"CNY": 0
},
"totalFees": 4.29,
"completedAt": 1541552388000,
"cancelledAt": null,
"failureReason": null,
"expiresAt": 1541553288000,
"reversingSubStatus": null,
"reversalReason": null,
"pendingSubStatus": null,
"dest": "paymentmethod:PA-2NEWWDDVLFJ",
"blockchainTx": null,
"statusHistories": [
{
"id": "N88AFATLRZY",
"transferId": "TF-4F3HRUYPNFY",
"createdAt": 1541552388000,
"type": "OUTGOING",
"statusOrder": 0,
"statusDetail": "Initiating Transfer",
"state": "INITIATED",
"failedState": null
},
{
"id": "PED3FNLNUV7",
"transferId": "TF-4F3HRUYPNFY",
"createdAt": 1541552388000,
"type": "OUTGOING",
"statusOrder": 200,
"statusDetail": "Processing Exchange",
"state": "PENDING",
"failedState": null
}
],
"owner": "account:AC-WYUR7ZZ6UMU",
"source": "account:AC-WYUR7ZZ6UMU"
}
Transfer Lifecycle
As funds are transferred from the source Wyre account to the destination, the Transfer will go through a series of different states, represented through their status. Below is an outline of the different statuses and what they mean:
PREVIEW - a preview Transfer. These Transfers cannot be confirmed and funds will never move on them. They're created by specifying the 'preview=true' parameter at time of Transfer creation.
UNCONFIRMED - a Transfer with a valid quote. This is the default state for newly created Transfers. These Transfers must be confirmed before they're executed. Transfers will wait UNCONFIRMED for some about of time, after which if they are sill UNCONFIRMED they will transition to EXPIRED.
PENDING - a Transfer in the pending state means we're working on moving the money to its destination. (It does not require any further action from your side).
COMPLETED - once a Transfer is fully executed and the funds have been confirmed at the destination its status will change to COMPLETED
EXPIRED - any UNCONFIRMED Transfer that is not confirmed inside their 30 second confirmation window will transition to EXPIRED
FAILED - if a Transfer cannot be completed for any reason its status will change to FAILED. If there's anything we can do to make sure the Transfer goes through we will reach out via support channels before failing a transfer.
REVERSED - if a Transfer is reversed at a later time for any reason its status will change to REVERSED. This happens with ACH Payouts, for example, where Wyre's banking partner may notify Wyre at a later time.
See the below diagram for the state diagram of the different Transfer statuses.
State diagram of Transfer statuses
In a normal situation the lifecycle of a Transfer looks like this:
- Creating a Transfer and getting an exchange rate quote
- Confirming a quote
- Transfer transitions from
PENDINGtoCOMPLETEDafter funds are deposited (See Getting Transfer status updates)
Blockchain Specific Transfer Cases
Stellar
Doing a stellar transfer from an external address to a Wyre address requires the User ID in the Memo. Transferring from a Wyre address requires the memo attached to the end of the address.
Example: stellar:GD7WXI7AOAK2CIPZVBEFYLS2NQZI2J4WN4HFYQQ4A2OMFVWGWAL3IW7K:LEMNM383ACX