curl --request GET \
--url https://sandbox.api.fin.com/v1/beneficiaries/dynamic-required-fields \
--header 'Authorization: Bearer <token>'{
"data": [
{
"info": "Customer ID of our system",
"key": "customer_id",
"validation_rule": {
"max_length": 36,
"min_length": 36,
"type": "UUID"
}
},
{
"info": "Refund Wallet Address",
"key": "refund_wallet_address",
"validation_rule": {
"max_length": 42,
"min_length": 42,
"type": "TEXT"
}
},
{
"info": "Bank branch id",
"key": "receiver_destination_branch_id",
"validation_rule": {
"min": 1,
"type": "NUMBER"
}
},
{
"info": "Wallet ID",
"key": "receiver_destination_account_number",
"validation_rule": {
"max_length": 20,
"min_length": 1,
"type": "TEXT"
}
},
{
"info": "Name of the blockchain network (e.g., Ethereum, Polygon)",
"key": "source_chain_name",
"validation_rule": {
"allowed_values": [
"POLYGON"
],
"type": "TEXT"
}
},
{
"info": "Payment Mode",
"key": "receiver_destination_method",
"validation_rule": {
"allowed_values": [
"BANK",
"E_WALLET"
],
"max_length": 50,
"type": "TEXT"
}
},
{
"info": "Enter Dev Fee (Fixed)",
"key": "developer_fee_fixed",
"validation_rule": {
"min": 0,
"type": "DECIMAL"
}
},
{
"info": "Can be a bank or e_wallet id",
"key": "receiver_destination_method_id",
"validation_rule": {
"min": 1,
"type": "NUMBER"
}
},
{
"info": "Id of the crypto token (e.g., USDC, USDT)",
"key": "source_token_id",
"validation_rule": {
"allowed_values": [
"USDC",
"USDT"
],
"type": "TEXT"
}
},
{
"info": "Receiver First Name",
"key": "receiver_first_name",
"validation_rule": {
"max_length": 100,
"min_length": 1,
"type": "TEXT"
}
},
{
"info": "Enter Dev Fee (Percentage)",
"key": "developer_fee_percentage",
"validation_rule": {
"min": 0,
"type": "DECIMAL"
}
},
{
"info": "Enter Beneficiary Type",
"key": "beneficiary_type",
"validation_rule": {
"allowed_values": [
"INDIVIDUAL",
"BUSINESS"
],
"type": "TEXT"
}
},
{
"info": "Receiver Country",
"key": "receiver_country_code",
"validation_rule": {
"max_length": 3,
"min_length": 3,
"type": "TEXT"
}
},
{
"info": "Purpose Of Remittance",
"key": "purpose_of_remittance",
"validation_rule": {
"max_length": 2,
"min_length": 2,
"type": "TEXT"
}
},
{
"info": "Receiver Last Name",
"key": "receiver_last_name",
"validation_rule": {
"max_length": 100,
"min_length": 1,
"type": "TEXT"
}
}
]
}Retrieve dynamic list of required fields and validation rules for creating a beneficiary based on country, currency, and payment method
curl --request GET \
--url https://sandbox.api.fin.com/v1/beneficiaries/dynamic-required-fields \
--header 'Authorization: Bearer <token>'{
"data": [
{
"info": "Customer ID of our system",
"key": "customer_id",
"validation_rule": {
"max_length": 36,
"min_length": 36,
"type": "UUID"
}
},
{
"info": "Refund Wallet Address",
"key": "refund_wallet_address",
"validation_rule": {
"max_length": 42,
"min_length": 42,
"type": "TEXT"
}
},
{
"info": "Bank branch id",
"key": "receiver_destination_branch_id",
"validation_rule": {
"min": 1,
"type": "NUMBER"
}
},
{
"info": "Wallet ID",
"key": "receiver_destination_account_number",
"validation_rule": {
"max_length": 20,
"min_length": 1,
"type": "TEXT"
}
},
{
"info": "Name of the blockchain network (e.g., Ethereum, Polygon)",
"key": "source_chain_name",
"validation_rule": {
"allowed_values": [
"POLYGON"
],
"type": "TEXT"
}
},
{
"info": "Payment Mode",
"key": "receiver_destination_method",
"validation_rule": {
"allowed_values": [
"BANK",
"E_WALLET"
],
"max_length": 50,
"type": "TEXT"
}
},
{
"info": "Enter Dev Fee (Fixed)",
"key": "developer_fee_fixed",
"validation_rule": {
"min": 0,
"type": "DECIMAL"
}
},
{
"info": "Can be a bank or e_wallet id",
"key": "receiver_destination_method_id",
"validation_rule": {
"min": 1,
"type": "NUMBER"
}
},
{
"info": "Id of the crypto token (e.g., USDC, USDT)",
"key": "source_token_id",
"validation_rule": {
"allowed_values": [
"USDC",
"USDT"
],
"type": "TEXT"
}
},
{
"info": "Receiver First Name",
"key": "receiver_first_name",
"validation_rule": {
"max_length": 100,
"min_length": 1,
"type": "TEXT"
}
},
{
"info": "Enter Dev Fee (Percentage)",
"key": "developer_fee_percentage",
"validation_rule": {
"min": 0,
"type": "DECIMAL"
}
},
{
"info": "Enter Beneficiary Type",
"key": "beneficiary_type",
"validation_rule": {
"allowed_values": [
"INDIVIDUAL",
"BUSINESS"
],
"type": "TEXT"
}
},
{
"info": "Receiver Country",
"key": "receiver_country_code",
"validation_rule": {
"max_length": 3,
"min_length": 3,
"type": "TEXT"
}
},
{
"info": "Purpose Of Remittance",
"key": "purpose_of_remittance",
"validation_rule": {
"max_length": 2,
"min_length": 2,
"type": "TEXT"
}
},
{
"info": "Receiver Last Name",
"key": "receiver_last_name",
"validation_rule": {
"max_length": 100,
"min_length": 1,
"type": "TEXT"
}
}
]
}Bearer token authentication. Obtain token from /v1/oauth/token endpoint
Customer ID of a verified customer
Beneficiary type
INDIVIDUAL, BUSINESS ISO Alpha-3 country code of any supported country from the 'Get countries' list
Currency code of the supported country
Available method for a particular country (e.g., BANK, E_WALLET)
Available method ID of a particular country
(Optional) Required if method contains branches
Required fields retrieved successfully
Show child attributes