Simulate transfer

Use this endpoint to simulate a transfer to or from an account. Provide one of either from or to to indicate which account should receive or send the funds. The amount of the transfer is optional in the case you are simulating a transfer of all available funds from the balance.

Authorizations

Authorization

string

header

required

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

Body

application/json

amount

integer

Required range: x > 0

from

string

The account from which to transfer funds

to

string

The account to which funds are transferred

Response

200 - application/json

amount

integer

required

Amount of the transfer

currency

enum<string>

required

Currency associated with the amount

Available options:

USD

date

string

required

Date of the transfer

id

string

required

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

transactions

object[]

required

Show child attributes

transactions.account_id

string

required

The account associated with the transaction

transactions.amount

integer

required

Amount of the transaction (signed)

transactions.batch

string | null

required

The batch for the transaction

transactions.created_at

string

required

When the transaction was created (ISO 8061 date string)

transactions.currency

enum<string>

required

Currency associated with the amount

Available options:

USD

transactions.date

string

required

The settlement date of the transaction

transactions.id

string

required

The unique identifier assigned by Push

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

transactions.status

enum<string>

required

The transaction's settlement status

Available options:

settled,

pending

transactions.type

enum<string>

required

The type of transaction

Available options:

intent,

transfer,

unreconciled

transactions.direction

enum<string>

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

Available options:

credit,

debit