simulate
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.
POST
/
simulate
/
transfer
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
from
string
The account from which to transfer funds
to
string
The account to which funds are transferred
amount
integer
Required range:
x > 0
Response
200 - application/json
id
string
requiredThe unique identifier assigned by Push, prefix is "transfer_"
amount
integer
requiredAmount of the transfer
currency
enum<string>
requiredCurrency associated with the amount
Available options:
USD
date
string
requiredDate of the transfer
transactions
object[]
required