Query Beneficiary Template

Retrieve the required field template for creating a beneficiary. Before calling Create a Beneficiary, use this endpoint to discover which fields are mandatory, optional, and their validation rules for a given region, currency, and account type combination.
Request Parameters
regionstring
required
ISO 3166 two-letter country/region code of the bank or wallet (e.g., US, GB).
currencystring
required
Three-letter ISO 4217 currency code (e.g., USD, EUR).
accountTypestring
required
Beneficiary account type. Default is BANK_ACCOUNT.

Valid Values:

BANK_ACCOUNT — Bank account.
DIGITAL_WALLET — Digital wallet.
entityTypestring
required
Beneficiary entity type. Must be provided together with accountType and relationType (all three or none).

Valid Values:

COMPANY — Corporate entity.
PERSONAL — Individual.
relationTypestring
Relationship type.

Valid Values:

SAME_NAME — Same-name transfer.
THIRD_PARTY — Third-party transfer.
RELATED_MERCHANT — Related merchant transfer.
paymentTypestring
Payment rail to query the template for. Omit to retrieve a merged template covering all payment types.

Valid Values:

LOCAL — Local clearing network (e.g., ACH, SEPA, Faster Payments).
CROSS — Cross-border transfer. Supports international recipients.
walletBrandNamestring conditional
Wallet brand name. Required only for a specified wallet when accountType is DIGITAL_WALLET and a specific wallet needs to be queried. See WalletBrandName.
Response Parameters
resultResult
See Result.
templatesarray
Array of beneficiary field templates. Maximum 5 templates per response.
Show child parametersShow child parameters
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSSuccessN/A
UN_SUPPORT_BUSINESSFUnsupported business.Verify all parameter values are within supported ranges and retry.
CURRENCY_NOT_SUPPORTEDFThe currency is not supported.Check the supported currency and region.
WALLET_TEMPLATE_NOT_EXISTFNo wallet templates met the query conditions.Verify the required info for wallet template.
CARD_TEMPLATE_NOT_EXISTFNo card templates met the query conditions.Verify the required info for card template.
Definition
POST /api/open/v1/beneficiaries/queryTemplate
Request
{
"region": "US",
"currency": "USD",
"accountType": "BANK_ACCOUNT",
"entityType": "COMPANY"
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"templates": [
  {
    "fields": [
      {
        "fieldName": "bankAccountName",
        "fieldDescription": "Beneficiary account name",
        "required": "Y",
        "restrictionType": "PATTERN_RESTRICTION",
        "restrictionMsg": "Only English letters, numbers, and special characters are supported. Max 70 characters.",
        "restrictionRegex": "^[A-Za-z0-9/() .,-?:'+&@]{0,70}$"
      },
      {
        "fieldName": "accountType",
        "fieldDescription": "Account Type",
        "required": "Y",
        "restrictionType": "OPTIONS_RESTRICTION",
        "restrictionMsg": "Please fill out this required field",
        "restrictionOptions": [
          {
            "optionName": "BANK_ACCOUNT",
            "optionValue": "BANK_ACCOUNT"
          },
          {
            "optionName": "DIGITAL_WALLET",
            "optionValue": "DIGITAL_WALLET"
          }
        ]
      }
    ]
  }
]
}