Create Recipient

Authorization* string

Pass your {api_key} as a bearer token in the request header to authorize this call

currency_id* uuid

Currency ID of Recipient, learn more about getting currency id from https://whitelabel.markets/demos/apex/docs/reference/currencies. currency_id has country data linked to it

transfer_purpose_id* uuid

Purpose of sending money to recipient

first_name* string

Recipient First Name

middle_name string

Recipient Middle Name

last_name* string

Recipient Last Name

email string

Recipient Email address

phone string

Recipient Phone number

phone_iso2 string

Recipient Phone number iso2

delivery_method* string

Recipient Payout Method, must be between, bank, mobile_money, cash_pickup

agent_id uuid

Recipient Cash Pickup Agent, required if delivery_method is cash_pickup. Learn more about getting agent_id from https://whitelabel.markets/demos/apex/docs/reference/agents.

mobile_id uuid

Recipient Mobile Money Company, required if delivery_method is mobile_money. Learn more about getting agent_id from https://whitelabel.markets/demos/apex/docs/reference/networks.

mobile_money_number string

Recipient Mobile Money Phone Number, required if delivery_method is mobile_money.

bank_id uuid

Recipient Bank, required if delivery_method is bank. Learn more about getting bank_id from https://whitelabel.markets/demos/apex/docs/reference/banks.

acct_type_id uuid

Recipient Account Type, required if delivery_method is bank. Learn more about getting acct_type_id from https://whitelabel.markets/demos/apex/docs/reference/currencies under international remittance object.

acct_no string

Recipient Bank Account Number, required if delivery_method is bank.

acct_name string

Recipient Bank Account Name, required if delivery_method is bank.

state string

Recipient State iso2

city string

Recipient City

address string

Recipient Address

postal_code string

Recipient Postal/Zip Code