Beneficiary

Properties

Name	Type	Required	Description
aba	str	❌	American Bankers Association routing transit number. United States.
account_number	str	❌	The person's account number.
ach_code	str	❌	Automated Clearing House (ACH) code.
additional_data	dict	❌	Additional data required by the payout method. Object..
additional_last_name	str	❌	The person's second last name.
address	str	❌	Street and number portion of the person's address.
bank_account_holder_name	str	❌	Name of the account holder.
bank_account_type	str	❌	Type of bank account, such as checking or savings.
bank_address	str	❌	Street and number portion of the bank's address.
bank_branch_code	str	❌	Identifier for the bank branch.
bank_branch_name	str	❌	Name of the bank branch.
bank_city	str	❌	City portion of the bank's address.
bank_code	str	❌	Domestic identifier of the bank.
bank_country	str	❌	Two-letter ISO 3166-1 ALPHA-2 code for the bank's country.
bank_name	str	❌	Name of the bank.
bank_province	str	❌	State or province portion of the bank's address.
beneficiary_bic_local	str	❌	NA.
beneficiary_relationship	str	❌	Relationship between the sender and the beneficiary.
bic_swift	str	❌	BIC (SWIFT) code for the bank account.
bsb_code	str	❌	Bank State Branch code for Australia.
card_expiration_month	str	❌	The card’s expiration month.
card_expiration_year	str	❌	The card’s expiration year.
card_number	str	❌	The card number.
category	Category	❌
city	str	❌	City portion of the address.
clabe	str	❌	Standardized bank code for Mexico.
cnaps	str	❌	China National Advanced Payments System (CNAPS) code number.
company_name	str	❌	Name of the beneficiary company. Relevant when entity_type is company.
confirmation_required	bool	❌	Indicates whether the beneficiary must respond to accept or decline a payout. Default is false. Relevant to the rapyd_ewallet payout method type
country	str	❌
currency	str	❌
date_of_birth	str	❌	The person's date of birth.
date_of_incorporation	str	❌	Date of incorporation of the corporation.
default_payout_method_type	str	❌	The type of payout method for the beneficiary. The two-letter prefix must match the beneficiary country code.
email	str	❌	The person's email address.
entity_type	EntityType	❌
ewallet	str	❌	ID of the wallet that the money is transferred to. String starting with ewallet_. Relevant to payout to Rapyd Wallet.
first_name	str	❌	First name of the beneficiary. Relevant when entity_type is individual.
iban	str	❌	International Bank Account Number.
id_	str	❌	ID of the 'beneficiary' object. String starting with beneficiary_. Response only.
id_date_of_issue	str	❌	The date of issuance of the person's identification document.
id_issue_authority	str	❌	The government agency that issued the person's identification document.
id_issue_location	str	❌	The location where the person's identification document was issued.
identification_type	str	❌	Type of identification document for the beneficiary. When entity_type is company, this field must be company_registered_number. When entity_type is individual, one of the following values: _ drivers_license _ identification_id _ international_passport _ residence_permit* social_security * work_permit
identification_value	str	❌	identification number on the document mentioned in identification_type.
ifsc	str	❌	Indian Financial System Code for a bank branch.
issuer_code	str	❌	NA.
last_name	str	❌	Last name of the beneficiary. Relevant when entity_type is individual.
merchant_reference_id	str	❌	ID defined by the merchant. Rapyd does not validate this value to enforce uniqueness.
middle_name	str	❌	The person's middle name.
mobile_number	str	❌	Mobile phone number in E.164 format.
name	str	❌	The person's full name.
nationality	str	❌	The person's nationality.
payment_type	str	❌	Additional classification of the type of payment, as required by the bank. Possible values: priority , regular
phone_country_code	str	❌	The country code of the person's phone.
phone_number	str	❌	Phone number in E.164 format.
postcode	str	❌	Postal code portion of the address.
province	str	❌	Province portion of the address.
purpose_code	str	❌	Purpose of the transaction.
routing_code_type_1	str	❌	NA.
routing_code_type_2	str	❌	NA.
routing_code_type_3	str	❌	NA.
routing_code_value_1	str	❌	NA.
routing_code_value_2	str	❌	NA.
routing_code_value_3	str	❌	NA.
sort_code	str	❌	Routing number for the UK.
state	str	❌	State portion of the address.
statement_narrative	str	❌	Additional description suitable for a customer transaction statement.
suburb	str	❌	District of the sender's or beneficiary's city.
tax_id	str	❌	Tax identification number.
vpa	str	❌	Virtual Payment Address.

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →