Add a Recipient

Read on how to add a receive user

This API allows you to add a Recipient for given Sender. You will need to provide recipient’s basic information via this API. The response contains a unique Recipient ID that you can store on your end.

The field available_payout_methods shows the list of payout method that are available from the recipient while creating a transaction. For a recipient to be eligible for BANK_DEPOSIT orCASH_PICKUP or WALLET or HOME_DELIVERY, available_payout_methods must contain the payout method.

1. BANK_DEPOSIT is enabled by default for all receivers and they can receive the amount if their bank information is added.

2. For a recipient to be eligible for CASH_PICKUP the field enable_cash_pickup must be set to true while creating or updating the recipient. If the enable_cash_pickup is set to true, additional information about the receiver which were optional may be required based on the receiver's country.

3. If you have been approved for Mobile Wallet,WALLET is enabled for all the applicable receivers.

4. If you have been approved for Home Delivery, HOME_DELIVERY is enabled for all the receivers.

POST /v2/senders/{{senderId}}/recipients

Parameters

Parameter	Required	Type	Description
senderId	Yes, in URL	UUID	ID of the sender under which the recipient will be added
first_name	Yes	String	First name of the recipient
middle_name	No	String	Middle name of the recipient
last_name	Yes	String	Last name of the recipient
country	Yes	String	ISO code of the recipient's country
address_line1	Yes	String	Street address of the recipient
address_line2	No	String	Second line of the street address
city	Yes	String	City of the recipient
postal_code	Yes	String	Zip code of the recipient
province	Yes	String	State or province of the recipient
email	No	Email	The email address of the recipient
home_phone	No	String	Home phone number of the recipient
mobile_phone	No	String	Mobile phone number of the recipient
work_phone	No	String	Work phone number of the recipient
date_of_birth	No	Date	Date of birth of the recipient (yyyy-mm-dd)
occupation	No	String	Occupation of the recipient
sender_relationship	Yes	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
enable_cash_pickup	No	boolean	Set the flag to true for enabling CASH_PICKUP

Request Sample

curl -X POST {{url}}/v2/senders/{{senderId}}/recipients \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: clientid' \
  -H 'X-Client-Secret: clientsecret' \
  -d { \
    "first_name": "string", \
    "middle_name": "string", \
    "last_name": "string", \
    "country": "string", \
    "address_line1": "string", \
    "address_line2": "string", \
    "city": "string", \
    "postal_code": "string", \
    "province": "string", \
    "email": "string", \
    "document": "string", \
    "home_phone": "string", \
    "mobile_phone": "string", \
    "work_phone": "string", \
    "date_of_birth": "string", \
    "occupation": "string", \
    "sender_relationship": "string" \
    "enable_cash_pickup": true \
  }

Response Sample

{
  "id": "UUID",
  "sender_id": "string",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "country": "string",
  "address_line1": "string",
  "address_line2": "string",
  "city": "string",
  "postal_code": "string",
  "province": "string",
  "email": "string",
  "document": "string",
  "home_phone": "string",
  "mobile_phone": "string",
  "work_phone": "string",
  "date_of_birth": "string",
  "occupation": "string",
  "sender_relationship": "string",
  "status": "string",
  "available_payout_methods": [
          "BANK_DEPOSIT",
          "CASH_PICKUP",
          "WALLET",
          "HOME_DELIVERY"
      ]
}