Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a list of outbound transfers

[Available in Production/Sandbox environment] Retrieve withdrawal transaction records

get/customer_profile/withdrawals

Query parameters

page[size]integer

Number of transactions per page(Must be an integer greater than 0)<br>Regex: /^0*[1-9][0-9]*$/

page[number]integer

Page number(Must be an integer greater than 0)<br>Regex: /^0*[1-9][0-9]*$/

sortstring

Must be either created_at or amount <br> <b>Creation Date:</b> Ascending (created_at) / Descending (-created_at) <br><b>Amount:</b>Ascending (amount) / Descending (-amount)

filter[created_after]string

ISO8601 format<br>Regex: /^(\d{4})(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\d|3[01])(T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(\.\d+)?(Z|([+-]([01]\d|2[0-3]):([0-5]\d)))?)?)?)?$/i

filter[created_before]string

ISO8601 format<br>Regex: /^(\d{4})(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\d|3[01])(T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(\.\d+)?(Z|([+-]([01]\d|2[0-3]):([0-5]\d)))?)?)?)?$/i

filter[currency]string

XSGD, XUSD, USDC or USDT

filter[status]string

failed, completed or pending

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

idstring

Outbound transfer (withdrawal) contract ID.

typestring

Request type.

idempotency_idstring

Idempotency ID for the transaction.

amountstring

Transaction amount.

feesstring

Fees charged for the transaction.

statusstring

Transaction status.

account_nostring

Bank account number.

bank_abbrevstring

Bank abbreviation.

failure_reasonstring

Reason for failure (if applicable).

arrivalstring

Estimated arrival time of the transaction.

currencystring

Transaction currency.

expressstring

Transfer method (e.g. FAST).

payout_invoice_idstring

Associated payout invoice ID.

wallet_namestring

Wallet from which funds are deducted.

created_atstring

Timestamp when the transaction was created.

external_referencestring

External transaction reference which will be seen by the recipient.

Example response

[
  {
    "id": "contract_08fe1cb9fa554a61qw23456d7adadea2",
    "type": "Withdrawal on behalf",
    "idempotency_id": "withdrawal_unique_id_test_callback_2",
    "amount": "0.1",
    "fees": "0.01",
    "status": "completed",
    "account_no": "123456789",
    "bank_abbrev": "DBS",
    "arrival": "13 Jun 2025 - 12:24 PM",
    "currency": "xsgd",
    "express": "FAST",
    "payout_invoice_id": "withdrawal_unique_id_test_callback_2",
    "wallet_name": "Digital Goods",
    "created_at": "2025-06-13T04:24:39.062Z",
    "external_reference": "sample external ref"
  }
]