Skip to main content
GET
Get transfer by ID

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Path Parameters

transferId
string
required

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.

id
string
required

Transfer ID (trf_ prefix).

Pattern: ^[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})$
transactionId
string
required

The transaction the transfer belongs to (txn_ prefix).

Pattern: ^[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})$
role
enum<string>
required

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.

Available options:
deposit,
payout,
refund
rail
enum<string>
required

How a transfer's money moved.

Available options:
ach,
achSameDay,
wire,
internationalWire,
rtp,
bookTransfer,
blockchain,
card,
cash
attempt
integer<int32>
required

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.

status
enum<string>
required

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.

Available options:
initiated,
pending,
settled,
failed,
returned
amount
object
required

The amount a transfer moves.

from
OMS wallet · object
required

Where the money moved from.

to
OMS wallet · object
required

Where the money moved to.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
secCode
enum<string>

ACH SEC code the payout was sent with; ach and achSameDay only.

Available options:
ccd,
ppd,
web
companyDiscretionaryData
string

ACH company discretionary data the payout was sent with; ach and achSameDay only.

originatorName
string

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.

tracking
object

Left out until OMS holds a reference.

failure
object

Why the transfer failed. Present only when status is failed.

return
object

Why a bank sent the money back, with its own code in bankCode when it gave one. Present only when status is returned.

settledAt
string<date-time>

When the transfer settled.