Recipient Object

Read for recipient object details

Field
Type
Description

id

UUID

Unique ID of the recipient

sender_id

UUID

The ID of the sender who is registering the recipient to make a transfer.

first_name

string

The first name of the recipient.

middle_name

string

The middle name of the recipient.

last_name

string

The last name of the recipient.

country

string

ISO code of the recipient's country.

address_line1

string

Street address of the recipient.

address_line2

string

Second line of the street address.

city

string

City of the recipient

postal_code

string

Zip code of the recipient

province

string

State or province of the recipient

email

email

Email address of the recipient

home_phone

string

Home phone number of the recipient

mobile_phone

string

Mobile phone number of the recipient. 7-15 digits.

work_phone

string

Work phone number of the recipient

date_of_birth

date

Date of birth of the recipient (yyyy-mm-dd)

occupation

string

Occupation of the recipient. This may be required based on your spec sheet.

sender_relationship

string

Enumerated value: Aunt, Brother, Brother in Law, Cousin, Daughter, Father, Father in Law, Friends, Grand Father, Grand Mother, Husband, Mother, Mother in law, Nephew, Niece, Self, Sister, Sister in Law, Son, Uncle, Wife, Others

status

string

Enumerated value: VERIFIED, UNVERIFIED

available_payout_methods

list

The payout methods available for the recipient. Enumerated value: BANK_DEPOSIT, CASH_PICKUP, WALLET, HOME_DELIVERY.

Last updated