Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get recipient requirements

get/payout-recipients/requirements

Query parameters

filter[recipientCountry]string required

Accepts alpha-2 country code e.g. SG

filter[currency]string required

SGD or USD

filter[disbursementMethod]string required

bankTransfer or paynow or swift

filter[proxyType]string

mobile_number, nric, uen or vpa - only applicable when disbursementMethod = paynow

filter[entityType]string required

individual or business

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": "recipientRequirement_5b1ab16b-2ffe-447e-a89c-378acd2e3bb7",
    "type": "recipientRequirement",
    "attributes": {
      "recipientCountry": "SG",
      "recipientInformation": {
        "disbursementMethod": "paynow",
        "currency": "SGD",
        "entityType": "individual",
        "recipientName": "^\\s*.{1,255}\\s*$",
        "proxyType": "^(mobile_number|nric|vpa)$",
        "proxyValue": "^(\\+65(6|8|9)\\d{7,15}|[STFG]\\d{7}[A-Z]|UEN((S|T)(\\d{2})([A-Z]{2})(\\d{4})([A-Z])([a-zA-Z0-9]{0,3})|(\\d{8,12})([A-Z])([a-zA-Z0-9]{0,3})))#[A-Z]{4})$"
      },
      "requiredFields": [
        "recipientCountry"
      ]
    }
  }
}