POST
/
simulate
/
settlement
curl --request POST \
  --url https://api.pushcash.com/simulate/settlement \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "intent_id": "intent_sandbox_dMggQ93ZYH6DH9LBhVeijE"
}'
{
  "id": "txn_CpiSd1bptYB5P55ysTDHg",
  "amount": 11000,
  "direction": "credit",
  "currency": "USD",
  "created_at": "2023-05-24T20:15:18.158Z",
  "date": "2023-05-24",
  "batch": "39408",
  "account_id": "account_WsELzpJOvU6fNafvzWbF6K",
  "type": "intent",
  "source_id": "intent_sandbox_dMggQ93ZYH6DH9LBhVeijE"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
intent_id
string
required

Response

200
application/json
Successful operation
​
id
string
required

The unique identifier assigned by Push

​
amount
integer
required

Amount of the transaction (signed)

​
currency
enum<string>
required

Currency associated with the amount

Available options:
USD
​
created_at
string
required

When the transaction was created (ISO 8061 date string)

​
date
string
required

The settlement date of the transaction

​
batch
string | null
required

The batch for the transaction

​
account_id
string
required

The account associated with the transaction

​
type
enum<string>
required

The type of transaction

Available options:
intent,
transfer,
unreconciled
​
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

​
status
enum<string>
required

The transaction's settlement status

Available options:
settled,
pending
​
direction
enum<string>

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

Available options:
credit,
debit