Skip to main content

Deposit Check

Check whether a deposit submitted by a user under your IB has been executed, and retrieve it's amount and execution time.

Endpoint

GET https://base-url/api/ib/deposit-check

Authentication

Requires Authorization: Bearer <YOUR_API_KEY> — see Authentication.


Request

Query parameters

ParameterTypeRequiredDescription
reference_idstring (UUID)✅ YesThe reference ID of the child user's deposit

This is the same value shown in the Reference ID (Лавлах дугаар) column of the deposit list under the user's Finances > Deposit page.

Example request

GET /api/ib/deposit-check?reference_id=a1b2c3d4-0000-0000-0000-000000000000
Authorization: Bearer YOUR_API_KEY

Response

200 — Deposit found and executed

{
"status": "EXECUTED",
"amountInUsd": 250.00,
"executedAt": 1750000000000
}

Response fields

FieldTypeDescription
statusstringAlways "EXECUTED" on a 200 response
amountInUsdnumberDeposit amount, converted to USD
executedAtnumberUnix timestamp (milliseconds) of when the deposit was executed

Errors

StatusBodyCause
400 Bad Request{"error":"Invalid reference_id format"}reference_id is missing or not a valid UUID
401 Unauthorized{"error":"UNAUTHORIZED"}API key is missing, invalid, or non-Partner
404 Not Found{"error":"Deposit not found"}No deposit exists for that reference ID, it belongs to a user outside your IB, or it hasn't reached EXECUTED status yet
429 Too Many Requests{"error":"TOO_MANY_REQUESTS"}Rate limit exceeded

See the Error Codes reference for full details.


Notes

  • reference_id belongs to the child user's deposit, not something you generate — it matches the Reference ID / Лавлах дугаар column on the user's Finances > Deposit list.
  • A 404 is returned for deposits that exist but are still pending or have failed. Poll this endpoint until you receive a 200, or treat 404 as "not yet executed."
  • This endpoint is scoped solely to deposits made by users under your IB, it cannot look up deposits belonging to other partners or users.