Recipient Account Object
Field | Type | Description |
---|---|---|
id | UUID | Unique ID of the recipient's account |
recipient_id | UUID | ID of the recipient |
account_number | string | Bank account number |
account_type | string | Account type. Enumerated value: |
bank_id | integer | Bank ID. Details can be obtained from this API. |
branch_id | integer | Bank Branch ID. Details can be obtained from this API. |
branch_location | string | Bank Branch Address. Details can be obtained from this API. |
identification_value | string | Recipient's mobile wallet ID. Mobile Wallet ID is recipient phone number along with country code and area code. |
identification_type | string | Recipient Wallet type. Enumerated value: |
payout_method | string | Payout Method type. Enumerated value: |
payer_id | integer | ID of payer associated with receiver's wallet. Details can be obtained from this API. |
account_holder_name.first_name | String | The account holder’s first name. When applicable, the provided account holder name is matched with the actual account holder’s name received from the bank/wallet provider for verification purposes. If this field is not provided, the first name of the recipient will be used. |
account_holder_name.middle_name | String | The account holder’s middle name. If this field is not provided, the middle name of the recipient will be used. |
account_holder_name.last_name | String | The account holder’s last name. If this field is not provided, the last name of the recipient will be used. |
additional_info.routing_code | String | This field may be required for recipient accounts in the US. Please refer to your spec sheet. |
additional_info.ifs_code | String | This field may be required for recipient accounts in India Please refer to your spec sheet. |
additional_info.swift_bic_code | String | This field may be required for recipient accounts in the UK. Please refer to your spec sheet. |
additional_info.branch_number | String | Branch number of bank. |
additional_info.bsb_number | String | Bank-State-Branch is a six-digit number that identifies banks and branches. |
additional_info.bik_code | String | Identification code of the bank. |
additional_info.cbu_alias | String | Alphanumeric code for each bank account. |
additional_info.sort_code | String | Six digit number that identifies recipient bank. |
additional_info.aba_routing_number | String | Nine numeric characters used by banks to identify specific financial institutions. |
Last updated