Simulate settlement

Use this endpoint to simulate receiving the funds from an approved intent, creating a new transaction and updating the balance in the settlement account associated with the intent.

Authorizations

Authorization

string

headerrequired

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

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