v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

[Sandbox] Update status of mock regular payout

[Available in Sandbox environment only] Update status of created regular payout from pending to either completed or failed

put/sandbox/payouts/{contract_id}

Path parameters

contract_idstring required

Contract ID is retrieved from the response of Create a Third Party Payout API

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.

Request body

Response

200

Example response

{
  "data": {
    "id": "contract_12e289c80603432591b4b77fc6ca2a8d",
    "type": "bankTransferTransaction",
    "attributes": {
      "amount": "1.0",
      "createdAt": "2024-08-19T16:49:20.650+08:00",
      "description": "trxn description",
      "disbursementMethod": {
        "accountNo": "0000001",
        "bankAbbrev": "DBS",
        "currency": "xsgd",
        "type": "Withdrawal on behalf",
        "walletName": "Digital Goods"
      },
      "externalReference": "trxn reference",
      "fees": "0.0",
      "idempotencyId": "trxn_idempotency_id",
      "status": "completed",
      "updatedAt": "2024-08-19T16:49:30.743+08:00"
    }
  }
}