Update Recipient

Read on updating recipient details

You can update the recipient details using this API. You can only update recipients if a transaction has not been forwarded for delivery to a recipient.

PUT /v2/senders/{{senderId}}/recipients/{{recipientId}}

Details

Parameter	Updatable	Remarks
first_name	Yes
middle_name	Yes
last_name	Yes
country	No
address_line1	Yes
address_line2	Yes
city	Yes	City is mandatory while updating any Address fields
postal_code	Yes
province	Yes	Province is mandatory while updating any Address fields
email	Yes
home_phone	Yes
mobile_phone	Yes
work_phone	Yes
date_of_birth	Yes
occupation	Yes
sender_relationship	No
enable_cash_pickup	Yes

Request Sample

curl -X PUT {{url}}/v2/senders/{{senderId}}/recipients/{{recipientId}} \
  -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", \
    "home_phone": "string", \
    "mobile_phone": "string", \
    "work_phone": "string", \
    "date_of_birth": "string", \
    "occupation": "string", \
    "enable_cash_pickup": true, \
    "sender_relationship": "string"
  }

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",
  "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"
      ]
}