Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a list of blockchain withdrawals

[Available in Production/Sandbox environment] Get a list of blockchain withdrawals.

get/blockchain_transfer/withdrawals

Query parameters

filter[blockchain]string

Supported blockchain e.g. XSGD_MATIC, XSGD_ERC20

filter[transactionSource]string

The withdrawal's target wallet address<br>Regex: /^(?!\s*$).+$/

filter[status]string

Transaction status: completed, pending, failed

filter[createdAfter]string

ISO8601 format in UTC e.g. 2024-03-27T10:59:53Z<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[createdBefore]string

ISO8601 format in UTC e.g. 2024-03-27T10:59:53Z<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

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

Sorted by <br> <b>Creation Date:</b> Ascending (createdAt) / Descending (-createdAt) <br>

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_1cb1ef8385b4407b9151326e13be508e",
      "type": "stablecoin_withdraw_contract",
      "attributes": {
        "transaction_hash": "0x047520e0e75d6136514ad96a2d56b3747ba9b0703f1bf690e1a35ffc2e9b9046",
        "amount": "$5.00",
        "network_fees": "$7.71",
        "total_amount": "$12.71",
        "transaction_source": "0x63da4d8b7eccec1593381f1369179e609ecae6a8",
        "status": "completed",
        "network": "Ethereum",
        "token": "xsgd",
        "blockchain": "XSGD_ERC20",
        "created_at": "2024-03-27T09:42:43.874Z"
      }
    }
  ],
  "meta": {
    "total": 2,
    "pages": 1
  },
  "links": {
    "self": "https://xfers.io/api/v3/blockchain_transfer/withdrawals"
  }
}