API Reference

Get required fields to create a beneficiary

Every country may have a different set of requirements to create a beneficiary to send funds. This API returns requirement dynamically based on the following input parameters.

  1. Country

  2. Banks

  3. Customer type

  4. Beneficiary type

  5. Method

All possible fields for creating a beneficiary

Please note these fields maybe required based on the above criteria

Parameter NameDescription
beneficiary_destination_account_numberAccount Number, 5–20 chars
beneficiary_destination_branch_idBank Branch Code
beneficiary_bsb_numberFor AUS bank routing number
beneficiary_transit_numberFor CAD bank routing number
beneficiary_destination_methodAllowed: BANK, E_WALLET
transaction_purpose
beneficiary_country_codeAlpha-3 Country Code, 3 chars
beneficiary_first_name1–100 chars
beneficiary_last_name1–100 chars
beneficiary_nationality
transaction_purpose_remarks
beneficiary_typeAllowed: INDIVIDUAL, BUSINESS
beneficiary_residential_addressUp to 255 chars
beneficiary_phoneUp to 20 chars (must include country code)
beneficiary_stateUsually 2 chars (US state code)
beneficiary_town
beneficiary_city3–35 chars
beneficiary_id_doc_typeDoesn’t this have defined ENUMs?
beneficiary_id_doc_type_remarks
beneficiary_occupation
beneficiary_occupation_remarks
beneficiary_id_doc_number
beneficiary_email
beneficiary_destination_currency3 chars (e.g., USD, PHP, etc.)
beneficiary_bank_name1–100 chars
beneficiary_branch_name
beneficiary_bicSWIFT/BIC
beneficiary_id_doc_issue_dateYYYY-MM-DD
beneficiary_id_doc_expiry_dateYYYY-MM-DD
beneficiary_zip_code
beneficiary_ibanIBAN format
beneficiary_street
source_chainAllowed: POLYGON (or other chain)
source_currencyAllowed: USDC
beneficiary_destination_railAllowed: ACH, ACH_SAME_DAY, WIRE
beneficiary_routing_numberExactly 9 chars
beneficiary_postal_code5–9 chars
customer_id36 chars
developer_fee_fixedMin: 0
developer_fee_percentage0–95
refund_wallet_addressWallet address, 42 chars
beneficiary_destination_method_idMin: 1

Guidelines on particular corridors

Please note all transfers are local transfers, hence local details are required and expected. There are a few cases where there may be a few guidelines on how to make the transfer. Those guidelines have been noted down below.

GBP transfers:

Use an IBAN starting with “GB” when entering a GBP account number. It must support Faster Payments Service (FPS).
Do not enter a local account number—this will cause the transfer to be cancelled.

INR transfers:

Must have a valid IFSC code. Address of the beneficiary must be within 35 characters.

Language
URL
Click Try It! to start a request and see the response here!