Sender

Properties

Name	Type	Required	Description
account_number	str	❌	Bank account number of sender.
additional_data	dict	❌	Additional data required by the payout method. Object..
additional_last_name	str	❌	The person's second last name.
address	str	❌	The address of the sender.
bank_code	str	❌	Domestic identifier of the bank.
bank_name	str	❌	Name of the bank.
beneficiary_relationship	str	❌	When the beneficiary is not a relative of the sender, the relationship should be specified as client or non-relative.
city	str	❌	City where the sender is located.
company_name	str	❌	Name of the sender company. Relevant when entity_type is company.
country	str	❌
currency	str	❌
date_of_birth	str	❌	The date of birth of the sender. Relevant when entity_type is individual.
date_of_incorporation	str	❌	Date of incorporation of the corporation.
email	str	❌	The person's email address.
entity_type	EntityType	❌
first_name	str	❌	First name of the sender. Relevant when entity_type is individual.
id_	str	❌	ID of the Sender object. String starting with sender_. Response only.
id_date_of_issue	str	❌	The date of issuance of the person's identification document.
id_expiry	str	❌	The expiration date 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 sender. 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.
last_name	str	❌	Last name of the sender. 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	❌	Name of the sender. Relevant when entity_type is company.
nationality	str	❌	The person's nationality.
occupation	str	❌	The person's occupation.
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 of the sender.
province	str	❌	Province portion of the address.
purpose_code	str	❌	Reason for the payout.
source_of_income	str	❌	The person's source of income.
state	str	❌	State where the sender is located.
suburb	str	❌	District of the sender's or beneficiary's city.
tax_id	str	❌	Tax identification number.

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →