Get Recipient Details

Read for details on added receivers

Get All Recipients

This API returns all recipients associated with the sender along with the recipient's information.

GET /v2/senders/{{senderId}}/recipients

Parameters

Field	Required	Type	Description
senderId	Yes	UUID	Sender ID

Request Sample

curl -X GET {{url}}/v2/senders/{{senderId}}/recipients \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: clientid' \
  -H 'X-Client-Secret: clientsecret'

Response Sample

{
  "result": [
    {
      "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"
    }
  ]
}

Get recipient by Id

Returns information of a specific recipient of the sender.

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

Parameters

Field	Required	Type	Description
senderId	Yes	UUID	ID of sender
recipientId	Yes	UUID	ID of recipient of the sender

Request Sample

curl -X GET {{url}}/v2/senders/{{senderId}}/recipients/{{recipientId}} \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: clientid' \
  -H 'X-Client-Secret: clientsecret'

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