v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get payout recipient requirements

Retrieve the required fields and validation rules for creating a payout recipient.

get/fx/payout-recipients/requirements

Query parameters

filter[recipientCountry]string required

ISO 3166 alpha-2 country code (e.g. ID).

filter[currency]string required

Target currency. Currently only IDR.

filter[disbursementMethod]string required

Currently only bankTransfer.

filter[entityType]string required

One of: individual, business.

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.

Response

200

Example response

{
  "data": {
    "recipient_country": "ID",
    "recipient_information": {
      "disbursement_method": "bankTransfer",
      "currency": "IDR",
      "entity_type": "individual",
      "recipient_name": "^\\s*.{1,255}\\s*$",
      "swift_bic": "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$",
      "bank_account_no": "^[a-zA-Z0-9\\-]{5,34}$",
      "bank_account_proof_url": "^(https?://)?(([0-9]{1,3}(\\.[0-9]{1,3}){3,5})|(([-\\p{L}_0-9]{1,256}\\.)+[-\\p{L}_]{2,63}))(:[0-9]+)?([/?].*)?$"
    },
    "required_fields": [
      "recipientCountry"
    ]
  }
}