Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Create a third party payout

[Available in Production/Sandbox environment] Create a third party payout for a customer profile

post/{customer_profile_id}/payouts

Path parameters

customer_profile_idstring required

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

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.

Request body

Response

201

OR

Example response

{
  "data": {
    "id": "contract_bd0b8014d2d54a7db753d1ca2376fc0c",
    "type": "bankTransferTransaction",
    "attributes": {
      "amount": "10.0",
      "createdAt": "2024-08-19T16:52:18.255+08:00",
      "description": "trxn description",
      "disbursementMethod": {
        "accountNo": "0000001",
        "bankAbbrev": "DBS",
        "currency": "xsgd",
        "type": "Withdrawal on behalf",
        "walletName": "Digital Goods"
      },
      "externalReference": "trxn reference",
      "fees": "0.04",
      "idempotencyId": "trxn_idempotency_id_000",
      "status": "pending",
      "updatedAt": "2024-08-19T16:52:19.318+08:00"
    }
  }
}