POST
/
simulate
/
transfer
curl --request POST \
  --url https://api.pushcash.com/simulate/transfer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "from": "account_28CJjV7P4Go5PNJvfzghiD",
  "amount": 30000
}'
{
  "id": "transfer_xle830ef8djeoiu",
  "amount": 700284,
  "currency": "USD",
  "direction": "credit",
  "created_at": "2023-05-24T20:15:18.158Z",
  "date": "2023-05-24",
  "transactions": [
    {
      "id": "txn_230vjroij4985uefjoiu9",
      "amount": -700284,
      "currency": "USD",
      "created_at": "2023-05-24T20:15:18.158Z",
      "date": "2023-05-24",
      "batch": null,
      "account_id": "account_WsELzpJOvU6fNafvzWbF6K",
      "type": "transfer",
      "source_id": "transfer_xle830ef8djeoiu",
      "status": "settled"
    }
  ],
  "account": {
    "id": "account_WsELzpJOvU6fNafvzWbF6K",
    "type": "settlement",
    "name": "Settlement Account",
    "created_at": "2023-05-24T20:15:18.158Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer 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

Example:

"account_28CJjV7P4Go5PNJvfzghiD"

​
to
string

The account to which funds are transferred

Example:

"account_WsELzpJOvU6fNafvzWbF6K"

​
amount
integer
Required range: x > 0

Response

200
application/json
Successful operation
​
id
string
required

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

​
amount
integer
required

Amount of the transfer

​
currency
enum<string>
required

Currency associated with the amount

Available options:
USD
​
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
​
created_at
string
required

When the transfer was created (ISO 8061 date string)

​
date
string
required

Date of the transfer

​
transactions
object[]
required
​
account
object
required
Example:
{
  "id": "account_WsELzpJOvU6fNafvzWbF6K",
  "type": "settlement",
  "name": "Settlement Account",
  "balance": 1000000,
  "created_at": "2023-05-24T20:15:18.158Z"
}