Skip to main content
GET
Retrieve a transfer

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The ID of the transfer to retrieve.

Response

Successful operation

id
string
required

The unique identifier assigned by Push, prefixed with "transfer_".

amount
integer
required

Net amount of the transfer in the smallest currency unit (for USD, integer cents). Equal to the net of its constituent transactions. Use direction to determine whether the funds moved to or from your operational account.

Required range: x >= 0
currency
enum<string>
required

Currency associated with the amount

Available options:
USD
direction
enum<string>
required

The direction of the net movement of funds between Push and your operational account.

  • disbursement: a net payout to your operational account (occurs when cash_in exceeds cash_out)
  • collection: a net withdrawal from your operational account (occurs when cash_out exceeds cash_in)
Available options:
disbursement,
collection
created_at
string<date-time>
required

When the transfer was created (ISO 8601 timestamp).

date
string<date>
required

The settlement date of the transfer.

transactions
object[]
required

The exact set of transactions settled by this transfer. Their amounts net to the transfer amount — each settled transaction belongs to exactly one transfer.

account
object
required
Example: