Beneficiary Object

Beneficiary Object

{
    "id": "bnf_d05lmjp8ddevmnvfp3a0",
    "object": "beneficiary",
    "created_at": "2025-04-25T09:52:15.739077Z",
    "beneficiary_details": {
        "address": {
            "line1": "Address line 1",
            "line2": "Address line 2",
            "city": "city",
            "state": "state",
            "country": "SG",
            "postal_code": "10090"
        },
        "destination": "bnk_d05lmjuq59csbboqt9d0",
        "destination_details": {
            "bank": {
                "account_number": "90980778",
                "bank_codes": {
                    "ifsc_code": "IFX001"
                },
                "bank_name": "Bank of India",
                "branch_name": "",
                "country": "IN",
                "currency": "INR",
                "iban": "",
                "firc_required": true,
                "purpose_code": ""
            },
            "type": "bank"
        },
        "email": "[email protected]",
        "name": "John Doe",
        "phone": null,
        "type": "business"
    }
    ,
    "documents": [],
    "metadata": null
}
FieldtypeDescription
idstringUnique ID for the beneficiary. Begins with 'bnf_'
objectstringThis is 'beneficiary' here
created_attimestampTimestamp at which the beneficiary object is created. (ISO 8601 format - YYYY-MM-DDTHH:MM:SS±hh:mm)
beneficiary_detailsjsonDetails of the beneficiary. Refer here for beneficiary_details sub-fields
purposeenumThe reason for payout. Refer <https://docs.tazapay.com/docs/reasons-for-payout> for the possible values.
firc_requiredbooleanWhether FIRC is required for the payout made for this beneficiary. Only applicable when the destination currency is INR.
metadatajsonSet of key-value pairs to attach to the payout

beneficiary_details

FieldSub-fieldstypeDescription
typeenumBeneficiary type - business or individual
namestringName of the beneficiary
emailstringEmail of the beneficiary
addressjsonAddress of the beneficiary
line1stringAddress line 1
line2stringAddress Line 2
citystringCity
statestringState
countrystringISO 3166-1 alpha-2 country code, in uppercase
postal_codestringPostal Code
destination_details
typeenumType of the destination - bank, wallet or local_payment_network
bank / waleet / local_payment_networkjsonA JSON containing the destination details

bank

FieldtypeDescription
bank_namestringName of the bank
account_numberstringAccount Number
ibanstringIBAN
countrystringTwo-letter country code (ISO 3166-1 alpha-2)
currencystringThree-letter ISO currency code
branch_namestringName of the branch
purpose_codestringPurpose Code in the Indian context
bank_codesjsonBank Codes (For example - swift_code, ifsc_code). Refer here for the list of codes.

wallet

FieldtypeDescription
deposit_addressstringDeposit Address
typeenumName of the wallet (Type of the deposit address)
currencystringcurrency

local_payment_method

FieldtypeDescription
typestringType of the local_payment_network (example - pix_brl, upi_inr, promptpay_thb)
deposit_key_typeenumType of the deposit key. Conditionally Mandatory depending on the value of type
deposit_keystringDeposit key corresponding to the type of local payment network (Example, PIX key for PIX, UPI handle for UPI, etc.)