Create a blockchain withdrawal

post

https://api-sandbox.straitsx.com/v1/blockchain_transfer/withdrawals

[Available in Production environment] Send funds to your verified blockchain addresses with your StraitsX Business Account

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
When the status of the blockchain withdrawal is updated, a callback will be sent to the URL you configured in your business dashboard. Learn more about how to configure your callback

Sample Callback Payload for Blockchain Withdrawal

{
  "data": {
    "attributes": {
      "amount": 2.0,
      "blockchain": "XSGD_MATIC",
      "created_at": "2024-06-11T04:48:39.912Z",
      "idempotency_id": "testing",
      "network": "Polygon",
      "network_fees": 0.02,
      "status": "completed",
      "token": "xsgd",
      "total_amount": 2.02,
      "transaction_hash": "0x658043f80b1684cce02a0f4c0ed5449589eef495492bae5a849e47e80c46dd4d",
      "transaction_source": "0x4fd0f684dcf7c6c862114db8cebfe8bf6bb175c3"
    },
    "id": "contract_7afa75105cad43579f9589ebe30b6784",
    "type": "stablecoin_withdraw_contract"
  }
}

Parameter	Description	Sample Value
`amount`	Amount transferred	2.0
`blockchain`	Blockchain (combination of token & network)	XSGD_MATIC
`created_at`	Datetime of creation	2024-06-11T04%3A48%3A39.912Z
`idempotency_id`	Unique idempotency id provided when triggering the withdrawal	testing
`network`	Network of the blockchain withdrawal	Polygon
`network_fees`	Network fees incurred	0.02
`status`	Transaction status: `completed/pending/cancelled`	completed
`token`	Token of the blockchain withdrawal	xsgd
`total_amount`	Total amount of the transaction	2.02
`transaction_hash`	Transaction hash	0x658043f80b1684cce02a0f4c0ed5449589eef495492bae5a849e47e80c46dd4d
`transaction_source`	Receiving blockchain address	0x4fd0f684dcf7c6c862114db8cebfe8bf6bb175c3
`id`	Contract ID of the transaction	contract_7afa75105cad43579f9589ebe30b6784
`type`	Transaction type	stablecoin_withdraw_contract

Body Params

address_id

string

required

Address ID is retrieved from the response of Get a list of blockchain addresses API
Regex: /^(?!\s*$).+$/

amount

float

required

Transaction amount (Must be a positive float up to 2 d.p.)
Regex: /^(?!0(\.0+)?$)([1-9]\d*(\.\d+)?|0\.\d*[1-9]\d*)$/

idempotency_id

string

required

Unique reference number provided by you to prevent double transaction, this cannot be repeated.
Regex: /^\s*.{1,191}\s*$/

wallet_source

string

enum

Which source of funds the deduction will be made from. If no value is specified for this field, XSGD and XUSD withdrawals will, by default, be deducted from the XSGD and XUSD balances respectively.

Allowed:

Headers

X-XFERS-APP-API-KEY

string

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-ID

string

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-TIMESTAMP

string

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-NONCE

string

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-SIGNATURE

string

Base64-encoded digital signature of the canonical request string.

Note: This header attribute is required when HTTP Request Signing is enabled for your account.

Responses

200200

400400