Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a list of regular payouts

[Available in Production/Sandbox environment] Retrieve a list of regular payouts

get/payouts

Query parameters

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><b>Amount:</b>Ascending (amount) / Descending (-amount)

filter[to]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[from]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[disbursementMethodType]string

bankTransfer or paynow, swift

filter[currency]string

Accepts xsgd, xusd, sgd or usd

filter[status]string

Accepts only failed, completed or pending

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_266fd6d1c428424798fca26f6552ba25",
      "type": "bankTransferTransaction",
      "attributes": {
        "amount": "0.01",
        "createdAt": "2024-08-19T16:39:37.485+08:00",
        "description": "trxn description",
        "disbursementMethod": {
          "accountNo": "0000001",
          "bankAbbrev": "DBS",
          "currency": "xsgd",
          "type": "Withdrawal on behalf",
          "walletName": "Digital Goods"
        },
        "externalReference": "trxn reference",
        "fees": "0.01",
        "idempotencyId": "trxn_idempotency_id_123",
        "status": "completed",
        "updatedAt": "2024-08-19T16:39:40.356+08:00"
      }
    }
  ],
  "meta": {
    "total": 2,
    "pages": 1
  },
  "links": {
    "self": "https://api.straitsx.com/v1/payouts?page[size]=10"
  }
}