OnLink
API reference

Simulate a USDT deposit for a sell order (sandbox only)

Sandbox only. Behaves as if the USDT for this sell order arrived on chain, so you can test your integration end to end without sending any. Attach the transaction hash to the order first with PATCH /v1/orders/{id}. The body may be empty: the order's own amount is used. A different amount sends the order to review. Not available in production: the route answers 404 there.

POST
/v1/simulations/orders/{id}/usdt-receipt

Authorization

partner-key
X-OnLink-Key<token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/simulations/orders/string/usdt-receipt" \  -H "Content-Type: application/json" \  -d '{}'
{  "orderId": "a1b2c3d4-0000-4000-8000-000000000002",  "receipt": {    "amount": "10.000000",    "txHash": "9f2b6c1d0a7e4f3b8c5d2e1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c",    "outcome": "matched"  },  "orderStatus": "awaiting_approval",  "walletFunded": true,  "message": "Receipt matched. The order has moved on from awaiting_usdt; poll GET /v1/orders/{id}."}