Skip to main content
POST
/
deposit-addresses
/
{depositAddressId}
/
simulate
Simulate inbound transfer on a Deposit Address
curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}/simulate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": {
    "value": "<string>"
  }
}
'
import requests

url = "https://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}/simulate"

payload = { "amount": { "value": "<string>" } }
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({amount: {value: '<string>'}})
};

fetch('https://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}/simulate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}/simulate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => [
'value' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}/simulate"

payload := strings.NewReader("{\n \"amount\": {\n \"value\": \"<string>\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}/simulate")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": {\n \"value\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}/simulate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": {\n \"value\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "amount": {
    "value": "<string>"
  },
  "depositAddressId": "<string>",
  "status": "submitted",
  "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.