Get all reason codes

Use GET {URI}/lineItems/reasonCodes to get all reason codes for actions such as freeze, unfreeze, cancel, and reissue on your platform. Reason codes can be used or displayed in your application to provide clear and specific reasons for each action.

For example, when an order is placed, various actions such as freezing, canceling, or reissuing line items might be necessary. Reason codes help document why these actions were taken. During financial audits, reason codes help ensure actions taken on financial transactions are well-documented for suspicious or fraudulent activities.

Endpoint	Description
`GET {URI}/lineItems/reasonCodes`	Get all reason codes for the reward action (freeze, unfreeze, cancel, and reissue) on this platform.

The following enumerations are provided in the Tango API as the reason codes to freeze a line item:

Freeze reasons (Enum)	Description
DELIVERY_INFO	Incorrect recipient’s delivery information
REWARD_AMOUNT	Incorrect reward amount
REWARD_TYPE	Incorrect reward type
VERIFY_ORDER	Incorrect order
FRAUD	Investigating possible fraud
OTHER	Enter your description if the reasons in this table do not meet your need.

The following enumerations are provided in the Tango API as the reason codes to unfreeze a line item:

Unfreeze reasons (Enum)	Description
DELIVERY_INFO	The recipient’s delivery information is verified.
REWARD_AMOUNT	The reward amount is verified.
REWARD_TYPE	The reward type is verified.
VERIFIED_ORDER	The order is verified.
FRAUD	No fraud has been detected.
OTHER	Enter your description if the reasons in this table do not meet your need.

The following enumerations are provided in the Tango API as the reason codes to cancel a line item:

Cancel reasons (Enum)	Description
DELIVERY_INFO	Incorrect recipient delivery information
REWARD_AMOUNT	Incorrect reward amount
REWARD_TYPE	Incorrect reward type
RECIPIENT	Incorrect recipient
CURREENCY	Incorrect currency
RECIPIENT_REQUESTED	Recipient requested change
RECIPIENT_OBLIGATIONS	Recipient didn’t fulfill obligations
DUPLICATE	Duplicate order
FRAUD	Fraud is detected
OTHER	Enter your description if the reasons in this table do not meet your need.

The following enumerations are provided in the Tango API as the reason codes to reissue a line item:

Cancel reasons (Enum)	Description
DELIVERY_INFO	Incorrect recipient delivery information
REWARD_AMOUNT	Incorrect reward amount
REWARD_TYPE	Incorrect reward type
RECIPIENT	Incorrect recipient
CURREENCY	Incorrect currency
RECIPIENT_REQUESTED	Recipient requested change
OTHER	Enter your description if the reasons in this table do not meet your need.

Here's an example payload for reason codes endpoint:

{
  "FREEZE": {
    "additionalProp": "string"
  },
  "UNFREEZE": {
    "additionalProp": "string"
  },
  "CANCEL": {
    "additionalProp": "string"
  },
  "CANCEL_AND_REISSUE": {
    "additionalProp": "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:

200 OK
400 Bad request
401 Unauthorized