Get Recipient Code

Endpoint: https://rest.virtualincentives.com/{version}/{format}/recipients/{id}/code

Method: GET

πŸ“˜

This endpoint requires approval prior to access. Please contact your Virtual Incentives Client Success Manager to discuss your use case.

Definitions

FieldTypeDescription
coderesponse only
string
Claim code associated with the gift card
pinresponse only
string
PIN associated with the gift card

Examples

Response XML

<recipient>
    <code>AAAAAA-BBBBBB-CCCCCC-DDDDD</code>
    <pin>1234</pin>
<recipient>

Response JSON

{
  "recipient": {
    "code": "AAAAAA-BBBBBB-CCCCCC-DDDDD",
    "pin": "1234"
  }
}