beneficiaryRequiredFieldsV2
Parameters
| Parameters |
Type |
Required |
Description |
| bank_country |
String |
true |
2 letter ISO code of the country the bank account is located |
| currency |
String |
true |
The 3 character code of the currency |
| entity_id |
UUID |
true |
Entity ID from the entity that will be used to create the beneficiary |
GraphQL Query
query BeneficiaryRequiredFieldsV2($bankCountry: ISO3166_1!, $currency: ISO4217!, $entityId: UUID!) {
beneficiaryRequiredFieldsV2(bank_country: $bankCountry, currency: $currency, entity_id: $entityId) {
fedwire {
personal {
variable
regex
variable_sub_type
example
enum
valid_bank_codes {
code
bank_name
swift_bic
}
}
business {
variable
regex
variable_sub_type
example
enum
}
}
swift {
personal {
variable
regex
variable_sub_type
example
enum
valid_bank_codes {
code
bank_name
swift_bic
}
}
business {
variable
regex
variable_sub_type
example
enum
}
}
local {
personal {
variable
regex
variable_sub_type
example
enum
valid_bank_codes {
code
bank_name
swift_bic
}
}
business {
variable
regex
variable_sub_type
example
enum
}
}
mobile {
personal {
variable
regex
variable_sub_type
example
enum
valid_bank_codes {
code
bank_name
swift_bic
}
}
business {
variable
regex
variable_sub_type
example
enum
}
}
}
}
Query Variables
{
"bankCountry": "BR",
"currency": "BRL",
"entityId": "0fba2c87-67d0-45b8-8d8c-5234725f9890"
}
Response
{
"data": {
"beneficiaryRequiredFields": {
"personal": [
{
"variable": "country",
"regex": "^[A-Z]{2}$",
"variable_sub_type": null,
"example": "US",
"enum": null,
"valid_bank_codes": null
},
{
"variable": "first_name",
"regex": "^.{1,}$",
"variable_sub_type": null,
"example": "John",
"enum": null,
"valid_bank_codes": null
},
{
"variable": "last_name",
"regex": "^.{1,}$",
"variable_sub_type": null,
"example": "Smith",
"enum": null,
"valid_bank_codes": null
},
{
"variable": "email",
"regex": "(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])",
"variable_sub_type": null,
"example": "john.smith@example.com",
"enum": null,
"valid_bank_codes": null
},
{
"variable": "entity_id",
"regex": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$",
"variable_sub_type": null,
"example": null,
"enum": null,
"valid_bank_codes": null
},
{
"variable": "phone",
"regex": null,
"variable_sub_type": null,
"example": null,
"enum": null,
"valid_bank_codes": null
},
{
"variable": "bank_country",
"regex": "^[A-Z]{2}$",
"variable_sub_type": null,
"example": "US",
"enum": null,
"valid_bank_codes": null
},
{
"variable": "account_number",
"regex": "^[A-Za-z0-9]{1,16}$",
"variable_sub_type": "account_number",
"example": "1234567890123456",
"enum": null,
"valid_bank_codes": null
},
{
"variable": "city",
"regex": null,
"variable_sub_type": null,
"example": null,
"enum": null,
"valid_bank_codes": null
},
{
"variable": "address1",
"regex": null,
"variable_sub_type": null,
"example": null,
"enum": null,
"valid_bank_codes": null
},
{
"variable": "routing_code",
"regex": "^\d{7}$",
"variable_sub_type": "bank_code",
"example": "2800249",
"enum": null,
"valid_bank_codes": null
},
{
"variable": "branch_name",
"regex": "^.{3,30}$",
"variable_sub_type": "branch_name",
"example": "Jakarta Branch",
"enum": null,
"valid_bank_codes": null
},
{
"variable": "currency",
"regex": "^[A-Z]{3}$",
"variable_sub_type": null,
"example": "USD",
"enum": null,
"valid_bank_codes": null
},
{
"variable": "bank_name",
"regex": "^.{1,}$",
"variable_sub_type": null,
"example": null,
"enum": null,
"valid_bank_codes": null
},
{
"variable": "postal_code",
"regex": null,
"variable_sub_type": null,
"example": null,
"enum": null,
"valid_bank_codes": null
},
{
"variable": "bank_address1",
"regex": null,
"variable_sub_type": null,
"example": null,
"enum": null,
"valid_bank_codes": null
},
{
"variable": "swift_bic",
"regex": "^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$",
"variable_sub_type": null,
"example": null,
"enum": null,
"valid_bank_codes": null
},
{
"variable": "bank_city",
"regex": null,
"variable_sub_type": null,
"example": null,
"enum": null,
"valid_bank_codes": null
}
],
"business": [
{
"variable": "business_country",
"regex": "^[A-Z]{2}$",
"variable_sub_type": null,
"example": "US",
"enum": null
},
{
"variable": "business_name",
"regex": "^.{1,}$",
"variable_sub_type": null,
"example": "Routefusion",
"enum": null
},
{
"variable": "email",
"regex": "(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])",
"variable_sub_type": null,
"example": "routefusion@example.com",
"enum": null
},
{
"variable": "entity_id",
"regex": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$",
"variable_sub_type": null,
"example": null,
"enum": null
},
{
"variable": "phone",
"regex": null,
"variable_sub_type": null,
"example": null,
"enum": null
},
{
"variable": "bank_country",
"regex": "^[A-Z]{2}$",
"variable_sub_type": null,
"example": "US",
"enum": null
},
{
"variable": "account_number",
"regex": "^[A-Za-z0-9]{1,16}$",
"variable_sub_type": "account_number",
"example": "1234567890123456",
"enum": null
},
{
"variable": "business_city",
"regex": null,
"variable_sub_type": null,
"example": null,
"enum": null
},
{
"variable": "business_address1",
"regex": null,
"variable_sub_type": null,
"example": null,
"enum": null
},
{
"variable": "routing_code",
"regex": "^\d{7}$",
"variable_sub_type": "bank_code",
"example": "2800249",
"enum": null
},
{
"variable": "branch_name",
"regex": "^.{3,30}$",
"variable_sub_type": "branch_name",
"example": "Jakarta Branch",
"enum": null
},
{
"variable": "currency",
"regex": "^[A-Z]{3}$",
"variable_sub_type": null,
"example": "USD",
"enum": null
},
{
"variable": "bank_name",
"regex": "^.{1,}$",
"variable_sub_type": null,
"example": null,
"enum": null
},
{
"variable": "business_postal_code",
"regex": null,
"variable_sub_type": null,
"example": null,
"enum": null
},
{
"variable": "bank_address1",
"regex": null,
"variable_sub_type": null,
"example": null,
"enum": null
},
{
"variable": "swift_bic",
"regex": "^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$",
"variable_sub_type": null,
"example": null,
"enum": null
},
{
"variable": "bank_city",
"regex": null,
"variable_sub_type": null,
"example": null,
"enum": null
}
]
}
}
}