Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a list of customer profile payout recipients

get/customer_profile/{customer_profile_id}/payout-recipients

Path parameters

customer_profile_idstring required

Customer Profile ID is retrieved from the response id of Create Customer Profile API

Query parameters

filter[disbursementMethod]string

bankTransfer, paynow, or swift

filter[bankShortCode]string

Bank account abbreviation (abbreviation) can be retrieved from Get a list of supported banks API

filter[bankAccountNo]string

Recipient's bank account number<br>Regex: /^[a-zA-Z0-9\-]{5,34}$/

filter[proxyType]string

Type of PayNow proxy: mobile_number, nric, uen, vpa

filter[proxyValue]string

Value of the PayNow proxy. Note that you would need to replace the + sign in the proxyValue with %2B<br>Regex: /^\s*.{1,255}\s*$/

page[number]integer

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

page[size]integer

Number of transactions per page(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>

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": "payout_recipient_f4eb25bb-fd9b-4846-8097-24a4f9a31ba3",
      "type": "payoutRecipient",
      "attributes": {
        "recipientCountry": "SG",
        "recipientInformation": {
          "entityType": "individual",
          "currency": "SGD",
          "disbursementMethod": "paynow",
          "recipientName": "John Doe 2",
          "proxyType": "mobile_number",
          "proxyValue": "+6588889999"
        },
        "createdAt": "2024-08-19T15:50:35.972+08:00",
        "updatedAt": "2024-08-19T15:50:35.972+08:00"
      }
    }
  ],
  "meta": {
    "total": 3,
    "pages": 1
  },
  "links": {
    "self": "https://api.straitsx.com/v1/payout-recipients?page[size]=10"
  }
}