Skip to main content
POST
/
deposit-addresses
/
{depositAddressId}
/
simulate
Simulate inbound transfer on a Deposit Address
curl --request POST \
  --url https://api.polygon.technology/v0.9/deposit-addresses/{depositAddressId}/simulate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": {
    "value": "<string>"
  }
}
'
{
  "amount": {
    "value": "<string>"
  },
  "depositAddressId": "<string>",
  "submittedAt": "2023-11-07T05:31:56Z",
  "transactionHash": "<string>"
}

Authorizations

​
Authorization
string
header
required

Token from POST /auth/token

Headers

​
Idempotency-Key
string
required

Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.

Path Parameters

​
depositAddressId
string
required

Body

application/json

Request body for POST /deposit-addresses/{id}/simulate.

​
amount
object
required

Stablecoin amount carried in the deposit-address simulation request: value only. The currency is resolved server-side from the DA's source_asset.

Response

200 - application/json

The request has succeeded.

Response for POST /deposit-addresses/{id}/simulate. No rail - the route implies blockchain_in.

​
amount
object
required

Stablecoin amount echoed back in the deposit-address simulation response: value + currency.

​
depositAddressId
string
required
​
network
enum<string>
required

Blockchain network for inbound blockchain transfers.

Available options:
BASE,
ETHEREUM,
INK,
SOLANA,
SUI
​
status
enum<string>
required
Available options:
submitted
​
submittedAt
string<date-time>
required
​
transactionHash
string
required

Synthetic on-chain transaction hash for webhook correlation.