Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a user withdrawal

[Available in Production/Sandbox environment] Get a withdrawal from the user's StraitsX account

get/withdrawals/{withdrawal_id}

Path parameters

withdrawal_idstring required

Withdrawal ID is retrieved from the response of Create a User Withdrawal API

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools.<br><br><strong>Note:</strong> The X-XFERS-APP-API-KEY is a mandatory header for all authentication methods, including standard API key usage and HTTP Request Signing mode.

X-PUBLIC-KEY-IDstring

The Key ID, can be retrieved from your StraitsX Dashboard.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-TIMESTAMPstring

Current Unix epoch time in seconds. Must be within ±300 seconds of server time.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-NONCEstring

A unique UUID string per request, used for replay protection. Must not be reused within the timestamp window.<br>Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-SIGNATUREstring

Base64-encoded digital signature of the canonical request string.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

Response

200

Example response

{
  "data": {
    "id": "contract_365361c704fb4fa59d42f2f2a3512345",
    "type": "withdrawal",
    "attributes": {
      "amount": "100.0",
      "fees": "0.0",
      "transactionRemarks": "Payment for invoice #1234",
      "idempotencyId": "trxn_idempotency_id_0000001",
      "currency": "xusd",
      "bankAccount": {
        "account_no": "0123456789",
        "account_holder_name": "JOHN DOE",
        "bank": "SCB",
        "swift_bic": "SCBLSG22XXX"
      },
      "status": "completed",
      "netAmount": "100.0",
      "createdAt": "2025-04-11T10:49:38.938+08:00",
      "updatedAt": "2025-04-11T10:50:34.647+08:00"
    }
  }
}