List transfers

Retrieves a list of transfers.

Authorizations

Authorization

string

header

required

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

Query Parameters

created_at.after

string

Return transfers created after this ISO 8601 timestamp.

created_at.before

string

Return transfers created before this ISO 8601 timestamp.

cursor

string

The cursor for the next page of results to fetch

Example:

"vjl8vk3l4o8dhsjlzh=="

date.after

string

Return transfers made on or after the specified date

date.before

string

Return transfers made on or before the specified date

Response

200

application/json

Successful operation

data

object[]

required

Show child attributes

data.id

string

required

The unique identifier assigned by Push, prefix is "transfer_"

data.amount

integer

required

Amount of the transfer

data.currency

enum<string>

required

Currency associated with the amount

Available options:

USD

data.direction

enum<string>

required

The direction of the transfer, as indicated by the sign of the amount

• a credit represents a payout to your operational account
• a debit represents a withdrawal from your operational account

Available options:

credit,

debit

data.created_at

string

required

When the transfer was created (ISO 8061 date string)

data.date

string

required

Date of the transfer

data.transactions

object[]

required

Show child attributes

data.transactions.id

string

required

The unique identifier assigned by Push

data.transactions.amount

integer

required

Amount of the transaction (signed)

data.transactions.currency

enum<string>

required

Currency associated with the amount

Available options:

USD

data.transactions.created_at

string

required

When the transaction was created (ISO 8061 date string)

data.transactions.date

string

required

The settlement date of the transaction

data.transactions.batch

string | null

required

The batch for the transaction

data.transactions.account_id

string

required

The account associated with the transaction

data.transactions.type

enum<string>

required

The type of transaction

Available options:

intent,

transfer,

unreconciled

data.transactions.source_id

string | null

required

The ID of the intent, dispute, or transfer associated with the transaction. If the transaction is unreconciled, this field will be null

data.transactions.status

enum<string>

required

The transaction's settlement status

Available options:

settled,

pending

data.transactions.direction

enum<string>

The direction of the transaction, as indicated by the sign of the amount

Available options:

credit,

debit

data.account

object

required

Show child attributes

data.account.id

string

required

The unique identifier assigned by Push

data.account.type

enum<string>

required

The type of account

Available options:

settlement,

dispute

data.account.name

string

required

The name of the account

data.account.created_at

string

required

When the account was created (ISO 8061 date string)

data.account.balance

integer

The balance of the account.

Example:

{
  "id": "account_WsELzpJOvU6fNafvzWbF6K",
  "type": "settlement",
  "name": "Settlement Account",
  "balance": 1000000,
  "created_at": "2023-05-24T20:15:18.158Z"
}

next_cursor

string | null

required

Use cursor for paginating list endpoints in conjunction with the cursor request parameter.

In a response, the value is null if there are no more results to fetch.

Example:

"vjl8vk3l4o8dhsjlzh=="