v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a list of first party bank transfer payouts

[Available in Production/Sandbox environment] Retrieve bank transfer payouts for a customer profile

get/{customer_profile_id}/withdrawals

Path parameters

customer_profile_idstring required

Customer Profile ID is retrieved from the response of Create Customer Profile API Regex: /^\s*.{1,191}\s*$/

Query parameters

page[size]integer

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

page[number]integer

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

sortstring

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

filter[created_after]string

ISO8601 format 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 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. 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.

Response

200

idstring

Payout 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.

bank_account_holder_namestring

Beneficiary bank account holder name.

swift_bicstring

Beneficiary bank SWIFT/BIC code.

beneficiary_addressstring

Beneficiary address.

descriptionstring

Description of this transaction (contract) according to merchant.

Example response

[
  {
    "id": "contract_698af23ca3294cf5b48fd8eb6842967a",
    "type": "Withdrawal on behalf",
    "idempotency_id": "testing",
    "amount": "100.0",
    "fees": "40.0",
    "status": "pending",
    "account_no": "08987877868",
    "bank_abbrev": "DBS",
    "currency": "usdc",
    "express": "FAST",
    "payout_invoice_id": "testing",
    "wallet_name": "Digital Goods",
    "created_at": "2024-03-04T09:34:43.455Z",
    "bank_account_holder_name": "Chee Jia Le",
    "swift_bic": "DBSSSGSGXXX",
    "beneficiary_address": "123 Street ABC, SG, SG, SG, 123456",
    "description": "testingnbfi"
  }
]