Skip to main content
GET
/
v1
/
beneficiaries
/
dynamic-required-fields
List Required Information For Beneficiaries
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"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer token authentication. Obtain token from /v1/oauth/token endpoint

Query Parameters

customer_id
string<uuid>
required

Customer ID of a verified customer

beneficiary_type
enum<string>
required

Beneficiary type

Available options:
INDIVIDUAL,
BUSINESS
country_code
string
required

ISO Alpha-3 country code of any supported country from the 'Get countries' list

currency_code
string
required

Currency code of the supported country

method
string
required

Available method for a particular country (e.g., BANK, E_WALLET)

method_id
string
required

Available method ID of a particular country

branch_id
string

(Optional) Required if method contains branches

Response

Required fields retrieved successfully

data
object[]