Add a Recipient Account
Read on adding a recipient
Last updated
Read on adding a recipient
Last updated
This API can be used to add recipient’s bank or wallet account. Recipient account information details needs to be added prior to initiating a transfer.
POST /v2/senders/{{senderId}}/recipients/{{recipientId}}/accounts
| Parameter | Required | Type | Description |
|---|---|---|---|
senderId
Yes, in URL
UUID
ID of the sender
recipientId
Yes, in URL
UUID
ID of the recipient
account_number
Yes, if bank
String
Bank account number.
account_type
Yes, if bank
String
Account type. Enumerated value - checking, savings, debit_card_deposit
bank_id
Yes, if bank
String
Bank ID. Details can be obtained from this API.
branch_id
Yes, if bank
String
Branch ID. Details can be obtained from this API.
branch_location
No
String
Branch location. Details can be obtained from this API.
payout_method
Yes
String
Payout method type. Enumerated value - BANK_DEPOSIT, WALLET
identification_value
Yes, if wallet
String
Recipient's mobile wallet ID. Mobile Wallet ID is recipient phone number along with country code and area code.
identification_type
No
String
Wallet type. Enumerated value - TEL. The default value for identification_type is TEL
payer_id
Yes, if wallet
Integer
ID of payer associated with receiver's wallet. Details can be obtained from this API.
account_holder_name.first_name
No
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
No
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
No
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
Conditional
String
This field may be required for recipient bank accounts in the US. Please refer to your spec sheet.
additional_info.ifs_code
Conditional
String
This field may be required for recipient bank accounts in the India. Please refer to your spec sheet.
additional_info.swift_bic_code
Conditional
String
This field may be required for recipient bank accounts in the UK. Please refer to your spec sheet.
additional_info.branch_number
Conditional
String
Branch number of bank. This field may be required for certain recipient bank accounts.
additional_info.bsb_number
Conditional
String
Bank-State-Branch is a six-digit number that identifies banks and branches. This field may be required for certain recipient bank accounts.
additional_info.bik_code
Conditional
String
Identification code of the bank. This field may be required for certain recipient bank accounts.
additional_info.cbu_alias
Conditional
String
Alphanumeric code for each bank account. This field may be required for certain recipient bank accounts.
additional_info.sort_code
Conditional
String
Six digit number that identifies recipient bank. This field may be required for certain recipient bank accounts.
additional_info.aba_routing_number
Conditional
String
Nine numeric characters used by banks to identify specific financial institutions. This field may be required for certain recipient bank accounts.