v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Create a user withdrawal

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

post/withdrawals

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools. Note: 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. Note: 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. Note: 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. Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i Note: 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. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

Request body

Response

201

Example response

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