Skip to main content
POST
/
sandbox
/
accounts
/
{id}
/
simulate
Simulate account activity
curl --request POST \
  --url https://api.platform.dakota.xyz/sandbox/accounts/{id}/simulate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": "100.00",
  "currency": "USD",
  "reference": "Test transaction",
  "target_state": "payment_processed"
}
'
{
  "message": "Account activity simulation initiated",
  "webhook_id": "<string>",
  "transaction_type": "onramp"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Account ID

Body

application/json
​
amount
string
required

Amount of funds to simulate

Example:

"100.00"

​
currency
string
required

Currency code (must match account's input_asset)

Example:

"USD"

​
reference
string

Optional reference for the transaction

Example:

"Test transaction"

​
target_state
enum<string>

Target state for simulation. Defaults to the final state which simulates the full flow.

  • For onramps: funds_received, payment_submitted, or payment_processed
  • For offramps: created, pending, or completed
Available options:
funds_received,
payment_submitted,
payment_processed,
created,
pending,
completed
Example:

"payment_processed"

Response

Account activity simulation initiated

​
message
string
Example:

"Account activity simulation initiated"

​
webhook_id
string

ID of the created webhook

​
transaction_type
enum<string>

Type of transaction.

Available options:
onramp,
offramp,
swap
Example:

"onramp"