Skip to main content
GET
/
api
/
status
/
:id
Check Transfer Status
curl --request GET \
  --url https://api.example.com/api/status/:id \
  --header 'API-KEY: <api-key>'
{
  "status": {
    "result": {
      "server_time": null,
      "code": 0,
      "substate": 0,
      "id": "123456789",
      "state": 40,
      "attribute": [],
      "trans": null,
      "sum_prov": null,
      "final": 0
    }
  }
}

​
Overview

Check the current status of a money transfer using its transfer ID. This endpoint provides detailed information about the transfer state, including whether it’s completed, in progress, or encountered an error.

​
Endpoint

GET /api/status/:id

​
Path Parameters

​
id
string
required
The unique money transfer ID returned when the transfer was created

​
Authentication

​
API-KEY
string
required
Your CashQ API Key for authentication

​
Request Example

curl -X GET 'https://api.cashqbot.com/api/status/123456789' \
  -H 'API-KEY: your_api_key_here'

​
Response

​
status
object
Status information for the transfer

​
Response Examples

{
  "status": {
    "result": {
      "server_time": null,
      "code": 0,
      "substate": 0,
      "id": "123456789",
      "state": 40,
      "attribute": [],
      "trans": null,
      "sum_prov": null,
      "final": 0
    }
  }
}

​
Understanding Transfer States

​
Key Status Codes

StateSubstateFinalDescription
00-2NoNew transfer
401-3NoProcessing
60-YesSuccess (completed)
80-YesError (failed)
-20YesTransfer not found
See the complete Status Codes Reference for all possible states and substates.

​
Final Status

The final field indicates whether the transfer has reached a terminal state:
  • final: 0 - Transfer is still in progress, status may change
  • final: 1 - Transfer is complete (success or failure), status won’t change

​
Polling Best Practices

Start with short intervals (1 second) and gradually increase to avoid excessive API calls.
const delay = Math.min(1000 * Math.pow(1.5, attempt), 10000);
Stop polling when final: 1 to avoid unnecessary requests.
Don’t poll indefinitely. Set a reasonable maximum number of attempts or time limit.
Account for success (state 60), failure (state 80), and not found (state -2).

​
Error Responses

Error CodeDescriptionSolution
authentication_errorInvalid or missing API keyVerify your API key
transfer_not_foundTransfer ID doesn’t existCheck the transfer ID is correct
internal_server_errorServer error occurredRetry the request

Money Transfer

Create a transfer and get the ID for status checking

Status Codes

Complete reference of all status codes