Beneficiary Validation
Header Parameters
application/json
{insert Client-level "access_code"}
Path Parameters
A unique 6-digit client identifier for each client account
Unique beneficiary ID that can be used in other endpoints.
Body Parameters
Full name of the account holder.
The client-assigned template identifier. This value should match the clientIntegrationId in the URL. The value in this field is returned in the beneIdentifier field when you run GET View Bene.
Two-letter ISO code for the country where the beneficiary's bank is located.
ISO-4217 Currency Code for the bank account.
Beneficiary classification = Individual or Business. Most of the other values shown in GET Beneficiary Rules.
Methods of payment that can be used for this beneficiary = [W or E] W = Wire E = EFT
Show child attributes
Beneficiary settlement details
Method of payment preferred by this beneficiary.
The account holder's two-letter ISO country code.
The account holder's province or state. Required for Canada and the United States
First line of the account holder's address. PO Box addresses are not allowed for Australia, Canada, and Mexico.
Second line of the account holder's address. PO Box addresses not allowed for Australia, Canada, and Mexico.
The account holder's city.
The account holder's postal or zip code. Required for Canada or the United States.
The account holder's phone number. Required if mandatory for destination country.
The unique identifier for the bank or financial institution. Required for Wires
Name of the financial institution.
The bank's two-letter ISO country code.
The bank's province or state. Required for Canada or the United States.
The bank's city.
First line of the bank's address.
Second line of the bank's address.
The bank's postal or zip code. Required for Canada or the United States.
Bank account number
Bank account number
Bank routing code - used to identify a specific financial institution. In some countries, the routing code is known by another name, such as ABA Number, Transit Number, Sort Code, BSB Number, IFSC Code, or Branch Code. Required for Wires.
Bank routing code
Default payment reference that will be used if a reference is not provided on a payment. The payment reference is transmitted with the payment, subject to banking constraints.
Internal email addresses to notify when a payment is made to this beneficiary.
External email addresses to notify when a payment is made to this beneficiary.
Enter the details of the recipient who will receive the funds. Must start with FFC followed by name and account number. Do not enter special characters.
Specifies whether to send an email alert to the beneficiary whenever a payment is released = [true, false].
Email address. (required if SendPayTracker = true)
The fields and corresponding values needed to satisfy regulatory requirements for the destination country. Required if mandatory for the destination country. Use GET Beneficiary Rules endpoint to retrieve valid values.
What made this section unhelpful for you?
Response
Error Codes
400 Bad Request - Value provided doesn't match the RegEx
The value in the specified field does not contain the required number of characters or contains characters that are not allowed.
400 Bad Request - Field is mandatory
One or more required field values are missing.
400 Bad Request - Value provided is not in the set of valid values
The value provided is not an allowed value for the specified field.
400 Bad Request - Beneficiary Identifier has already been assigned
The templateIdentifier already exists and cannot be used again.