Get transfer by ID
Retrieves one transfer of a transaction by ID.
Authorizations
Token from POST /auth/token
Path Parameters
Transfer ID (trf_ prefix).
Response
The request has succeeded.
One movement of money of a transaction, on one rail. A payout sent again after a confirmed failure is a new transfer; the failed one stays failed.
Transfer ID (trf_ prefix).
^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$The transaction the transfer belongs to (txn_ prefix).
^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$What a transfer does in its transaction. deposit brings money in, payout sends it out and refund sends it back to the sender. A bank return is the transfer's returned status, not a role.
deposit, payout, refund How a transfer's money moved.
ach, achSameDay, wire, internationalWire, rtp, bookTransfer, blockchain, card, cash 1 for the first send; a payout sent again after a confirmed failure is a new transfer with attempt + 1. These stay the same transfer: a re-send of a payout whose outcome is unknown, a failed refund sent again, and a fiat wallet payout sent again.
Where a transfer is. An outgoing transfer (a payout or a refund) goes initiated, pending, settled; a deposit goes pending, settled. Any can end failed. A payout the receiving bank sends back, or a virtual account deposit the sending bank takes back, ends returned after settled.
initiated, pending, settled, failed, returned The amount a transfer moves.
Where the money moved from.
- OMS wallet
- External wallet
- Fiat wallet
- US bank account
- IBAN bank account
- Canadian bank account
- Card
- Cash
- Deposit address
- Virtual account
Where the money moved to.
- OMS wallet
- External wallet
- Fiat wallet
- US bank account
- IBAN bank account
- Canadian bank account
- Card
- Cash
- Deposit address
- Virtual account
ACH SEC code the payout was sent with; ach and achSameDay only.
ccd, ppd, web ACH company discretionary data the payout was sent with; ach and achSameDay only.
The name the payout comes from, as the receiving bank sees it: the payment provider's, or the customer's when the customer or the partner holds the payout origin. Bank and card payouts only; left out when the customer's name cannot be read at that moment.
Left out until OMS holds a reference.
Why the transfer failed. Present only when status is failed.
Why a bank sent the money back, with its own code in bankCode when it gave one. Present only when status is returned.
When the transfer settled.