Get details for a specific line item
This Tango API endpoint retrieves the full details of a specific line item using its unique identifier. The referenceLineItemID is generated when the reward is issued. This endpoint returns everything Tango knows about that reward instance, including: status and permissions, reward credentials, amount details, redemption activity and history, sender and recipient information, redemption history, and much more.
Endpoint
Use this endpoint to retrieve the full details of a single reward line item using its unique referenceLineItemID.
| Endpoint | Description |
|---|---|
GET {URI}/lineItems/{referenceLineItemID} | Get details for a specific line item. |
Parameters
Get referenceLineItemID from the line items response, then use it to retrieve the full line item details.
| Path params | Data type | Description |
|---|---|---|
referenceLineItemID | string | The unique line item identifier returned when the reward is issued. |
Example
Here's a payload example for this endpoint:
{
"referenceLineItemID": "string",
"externalReferenceLineItemID": "string",
"referenceOrderID": "string",
"orderSource": "string",
"status": "string",
"orderStatus": "string",
"emailStatus": "string",
"deliveryMethod": "string",
"deliveryStatus": "string",
"rewardStatus": "string",
"canCancel": true,
"canFreeze": true,
"lineNumber": 0,
"rewardName": "string",
"amountIssued": {
"value": 0,
"currencyCode": "string",
"exchangeRate": 0,
"fee": 0,
"total": 0
},
"amountCharged": {
"value": 0,
"currencyCode": "string",
"exchangeRate": 0,
"fee": 0,
"total": 0
},
"remainingBalance": 0,
"dateIssued": "2026-03-30T23:17:50.923Z",
"expirationDate": "2026-03-30T23:17:50.923Z",
"accountNumber": "string",
"accountIdentifier": "string",
"etid": "string",
"ptid": "string",
"utid": "string",
"customerIdentifier": "string",
"recipient": {
"firstName": "string",
"lastName": "string",
"email": "string",
"mobileNumber": "string",
"address": {
"companyName": "string",
"streetLine1": "string",
"streetLine2": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"country": "string"
}
},
"sender": {
"firstName": "string",
"lastName": "string",
"email": "string"
},
"purchaseOrderNumber": "string",
"campaign": "string",
"orderNotes": "string",
"lineItemActionReason": "string",
"reissuedFromReferenceLineItemId": "string",
"reissuedToReferenceLineItemId": "string",
"lineItemErrors": [
{
"error_code": "string",
"error_message": "string"
}
],
"reward": {
"credentials": {
"additionalProp": "string"
},
"credentialList": [
{
"label": "string",
"value": "string",
"type": "string",
"credentialType": "string"
}
],
"redemptionInstructions": "string"
},
"resendHistory": [
{
"dateIssued": "2026-03-30T23:17:50.923Z",
"sender": {
"firstName": "string",
"lastName": "string",
"email": "string"
},
"recipient": {
"email": "string",
"mobileNumber": "string"
},
"deliveryMethod": "string",
"deliveryStatus": "string",
"etid": "string",
"reasonCode": "NOT_RECEIVED",
"otherReason": "string"
}
],
"redemptionHistory": [
{
"referenceLineItemID": "string",
"externalReferenceLineItemID": "string",
"referenceOrderID": "string",
"orderSource": "string",
"status": "string",
"orderStatus": "string",
"emailStatus": "string",
"deliveryMethod": "string",
"deliveryStatus": "string",
"rewardStatus": "string",
"canCancel": true,
"canFreeze": true,
"lineNumber": 0,
"rewardName": "string",
"amountIssued": {
"value": 0,
"currencyCode": "string",
"exchangeRate": 0,
"fee": 0,
"total": 0
},
"amountCharged": {
"value": 0,
"currencyCode": "string",
"exchangeRate": 0,
"fee": 0,
"total": 0
},
"remainingBalance": 0,
"dateIssued": "2026-03-30T23:17:50.923Z",
"etid": "string",
"ptid": "string",
"utid": "string",
"recipient": {
"firstName": "string",
"lastName": "string",
"email": "string",
"mobileNumber": "string",
"address": {
"companyName": "string",
"streetLine1": "string",
"streetLine2": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"country": "string"
}
},
"sender": {
"firstName": "string",
"lastName": "string",
"email": "string"
},
"lineItemErrors": [
{
"error_code": "string",
"error_message": "string"
}
]
}
],
"lineItemActionHistory": [
{
"action": "string",
"reason": "string",
"actionDate": "string",
"oldReferenceLineItemId": "string",
"newReferenceLineItemId": "string"
}
],
"rewardViewHistory": [
{
"date": "2026-03-30T23:17:50.923Z",
"status": "string"
}
]
}Key response fields
On a successful request (200 OK), the response body includes several important fields. Below are key notes and considerations to help you understand field behaviors and best practices:
The remainingBalance in the response payload refers to the funds remaining on a reward after a purchase or transaction. Tango can only track and display the remaining balance for Choice products because these are managed within Tango’s system. For Open-loop and Closed-loop cards—such as prepaid Visa, Mastercard, or branded gift cards—Tango does not have access to real-time balances. For those products, remainingBalance is null, even though the card itself may still have funds.
Note:
remainingBalanceis only available for Choice products. Open-loop and Closed-loop cards always returnnull.
Example
Acme Health issues digital wellness cards to employees. Both administrators and employees need to know the remaining balance on each card when checking a line item in the system. When Acme Health calls the endpoint, the response includes a remainingBalance field. For Choice products, this field is calculated as the original amount issued minus the amount spent. For Open‑loop or Closed‑loop cards, the field is returned as null because Acme Health does not track spending after the card is issued.
The rewardViewHistory in the response payload helps you track when a reward was viewed. This feature is used for auditing, analyzing user behavior, enhancing the user experience, and detecting fraud and unusual patterns. Each entry includes the view date and status of the event:
{
...
"rewardViewHistory": [
{
"date": "2026-01-13T19:32:02.154Z",
"status": "string"
}
]
}The resendHistory array in the response payload shows when a reward was resent to the recipient. Use this field to investigate delivery issues, review resend frequency, and support fraud analysis:
{
"resendHistory": [
{
"dateIssued": "2023-02-02T17:16:39.269Z",
"sender": {
"firstName": "string",
"lastName": "string",
"email": "string"
},
"recipient": {
"email": "string",
"mobileNumber": "string"
},
"deliveryMethod": "string",
"deliveryStatus": "string",
"etid": "string",
"reasonCode": "NOT_RECEIVED",
"otherReason": "string"
}
]
}The rewardStatus in the response payload indicates whether a reward is active or frozen. The reward.credentials field is deprecated. Use reward.credentialList instead. credentialList contains the stable reward access attributes returned on an order, including the credential type, label, and value. See Get credential type:
{
"rewardStatus": "string",
"reward": {
"credentials": {
"additionalProp": "string"
},
"credentialList": [
{
"label": "string",
"value": "string",
"type": "string",
"credentialType": "string"
}
],
"redemptionInstructions": "string"
}
}Example error response
Here's an example payload for when you receive an error:
{
"timestamp": "2025-02-21T23:23:13.930Z",
"requestId": "string",
"path": "string",
"httpCode": 0,
"httpPhrase": "string",
"i18nKey": "string",
"message": "The error message will show here for error codes ",
"errors": [
{}
]
}Response codes
The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:
| Response | Description |
|---|---|
| 200 | The request was successful. |
| 400 | The server could not understand the request due to invalid syntax. |
| 401 | Authentication is required, but it has either not been provided or failed. |
| 403 | The server understood the request but refused to authorize it. |
| 404 | The server could not find the requested resource. In other words, the URL you’re trying to access doesn’t point to anything that exists on the server. |
Updated 13 days ago
