ONonlink
Partner API

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

Request

  • Base URL
    https://sandbox.onlink.africa
  • Auth
    API key in header X-OnLink-Key

Path parameters

idstring required

Request body

amountstring

The USDT amount the simulated deposit carries, as a decimal string with at most six decimal places. Omit it to deposit exactly what the order expects. A different amount sends the order to review, which is the way to see what an amount mismatch looks like.

Example request

{
  "amount": "10.000000"
}

Response

The deposit was recorded. receipt.outcome says what the order did with it.

orderIdstring required
orderStatusstring required

The order status read back after the deposit was processed.

walletFundedboolean required

Always true: if the deposit cannot be funded, the request fails with 503 SIMULATION_UPSTREAM_UNAVAILABLE.

messagestring required

A sentence saying what happened.

Example response

{
  "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}."
}

Changes

No recorded changes to this operation across all 1 revision of this API.