Get User Recipient

Description

The getUserRecipient endpoint is used to retrieve the list of recipients associated with a user's loyalty account. These recipients are typically individuals or entities to whom loyalty rewards, points, or benefits can be transferred, shared, or designated.

Request

Endpoint

/ui/v1/getUserRecipient/{id}

Note

Replace id above with the internal ID of the Recipient.

Method

GET

Content-Type: application/json
Authorization: Basic $TOKEN

Note

Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.

Given a username of username and a password of password, the request header would appear as follows:

Content-Type: application/json
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Response

{
    "id": 4,
    "createdDateTime": 1752174723000,
    "lastUpdatedDateTime": null,
    "userId": 692,
    "recipientNickname": null,
    "recipientLastName": "Velaatlanta",
    "recipientLoyaltyRewardsNumber": 10000000000005,
    "recordStatus": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "useThisRecipientAsDefault": false,
    "message": null
}

Updated As Of Version: 6.6.x