Sign in

v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Simulate Incoming Payment Detail

post/simulations/incoming_payment_details/create_async

Request body

typestring required

See possible types at Incoming Payment Details

subtypestring

when type=stablecoin, this can be solana, ethereum or base

directionstring required

One of credit, debit

amountinteger required
datastring json

Defaults to a generated representation of a possible payment pre-notification from a bank.

currencystring

Defaults to the currency of the originating account

internal_account_idstring required

The ID of one of your internal accounts

virtual_account_idstring

An optional parameter to associate the incoming payment detail to a virtual account

as_of_datestring date

Defaults to today

descriptionstring

Defaults to a random description string

Response

202

objectstring
idstring

Example response

{
  "object": "incoming_payment_detail",
  "id": "c5f4009c-bdd6-4cc1-84b2-17974ac9e77a"
}