Get details for a specific line item

Use the following endpoint to retrieve all details for a specific line item in Tango. This endpoint looks up a line item by its unique ID, or referenceLineItemID and returns a detailed payload including: status and permissions, reward credentials, amount issued and charged, remaining balance, dates, sender and recipient information, redemption history, and much more:

EndpointDescription
GET {URI}/lineItems/{referenceLineItemID}Get details for a specific line item.

This endpoint needs the following query parameter to return a detailed information. The referenceLineItemID is created by the system when the line item is issued. You can retrieve it by calling the Line Items endpoint first, then use it here to get full details.

Query paramsData typeDescription
referenceLineItemIDstringReference line item ID is returned in the Line Items response.

Remaining balance

remainingBalance is now part of the returned payload. Acme Health issues digital wellness cards to employees. Acme admins and employees need to know how much balance is left on each card when they check a line item in the system. When Acme Health calls the above endpoint, the response is included in the remainingBalance. The cards are typically:

  • Closed-loop cards are usable only at Acme Health partner stores. For these cards, the remaining balance is always 0 since they are fully redeemed at issuance.
  • Open-loop cards are usable anywhere like a debit card. For these cards, the remaining balance is always 0 (Acme Health doesn’t track spending after issuance).
  • For Choice Products (RL, PL, DL, GCL), employees can choose from multiple wellness options. For these cards, remaining balance = amount originally issued – total amount charged, calculated using Acme Health’s database or cache. Choice products are: Reward Link® (RL), Global Choice Link, Promo Link ™(PL), and Disbursement Link (DL). See Manage Choice products.

Resend history

To determine whether further action is needed, such as investigating fraud or resending the reward again, you can view resendHistory in the line items payload. You can find out who resent the reward, know when it was resent, identify the email address or mobile number it was sent to, and check the delivery status. Note that every response from this endpoint includes the sender's and the recipient’s address details such as name, email, phone, and address fields.

"resendHistory": [
{{ {}}
{{ "dateIssued": "2023-02-02T17:16:39.269Z",}}
{{ "sender": {}}
{{ "firstName": "string",}}
{{ "lastName": "string",}}
{{ "email": "string"}}
{{ }}}
{{ "recipient": {}}
{{ "email": "string",}

The following example shows the payload when you callGET {URI}/lineItems/{referenceLineItemID}. The reward status indicates whether a reward is frozen or active.

Note that we have deprecated credentials , but use credentialList instead. credentailList is a set of attributes that is returned on an order specifying how to access the purchased reward. credentailList contains credential type, label, value, and other stable parameters. See how to Get credential type.

{
  "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": "2025-11-13T19:09:22.340Z",
  "expirationDate": "2025-11-13T19:09:22.340Z",
  "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"
  },
  "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": "2025-11-13T19:09:22.340Z",
      "expirationDate": "2025-11-13T19:09:22.340Z",
      "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"
        }
      ]
    }
  ],
  "lineItemActionHistory": [
    {
      "action": "string",
      "reason": "string",
      "actionDate": "string",
      "oldReferenceLineItemId": "string",
      "newReferenceLineItemId": "string"
    }
  ]
}

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

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

ResponseDescription
200The request was successful.
400The server could not understand the request due to invalid syntax.
401Authentication is required and has either not been provided or failed.
403The server understood the request but refuses to authorize it.
404The 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.

© 2025 Tango API are provided by Tango, a division of BHN, Inc.