Status

Get transaction status

get

Retrieve the current status and details of a transaction using its reference identifier.

Authorizations

ServiceKey

X-Service-KeystringRequired

Your Switch API service key. Contact us at [e-mail] to obtain your service key.

Query parameters

referencestring · uuidRequired

The unique transaction reference identifier

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Successfully retrieved transaction status

application/json

400

Bad request - validation error or invalid parameters

application/json

get

/status

HTTPcURLJavaScriptPython

GET /status?reference=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.onswitch.xyz
X-Service-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "status": 200,
  "message": "Payment status fetched successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": {
    "id": "507f1f77bcf86cd799439011",
    "status": "PENDING",
    "type": "OFFRAMP",
    "reference": "550e8400-e29b-41d4-a716-446655440000",
    "source": {
      "amount": 100,
      "currency": "USDC"
    },
    "destination": {
      "amount": 150050,
      "currency": "NGN"
    },
    "deposit": {
      "bank_name": "Example Bank",
      "bank_code": "058",
      "account_name": "John Doe",
      "account_number": "0123456789"
    },
    "payload": null,
    "confirmed": false,
    "finalized": false,
    "hash": null,
    "explorer_url": null,
    "meta": null,
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}