v1
latestOpenAPI 3.0.02026-07-14866188.2 KBInfo
Get beneficiary validation rules for a specific country.
Retrieves validation rules and field requirements for beneficiary information based on country code.
get/v0.2.4/info/beneficiary-rules/{countryCode}
Path parameters
countryCodestring required
Two-letter country code (ISO 3166-1 alpha-2, e.g. US, PE, MX, BR)
Query parameters
method'' | 'clabe' | 'phonenum' | 'debitcard' | 'pix_ind'
Get rules for specific payment method. Defaults to Bank. Options include clabe, phonenum, debitcard.
Response
Success.
Example response
{
"status": "success",
"message": "Beneficiary rules retrieved successfully",
"data": [
{
"name": "accountNumber",
"label": "Account Number",
"regexPattern": "^[0-9]{10}$",
"validValues": [
"Savings",
"Checking"
],
"defaultValue": "Savings",
"inputType": "text",
"required": true
}
]
}