Reissue line items
You can reissue Choice Products (Reward Link®, Promo Link™, Disbursement Link, or Global Choice Link) with the corrected recipient information or corrected amount. With the reissue endpoint, the original reward is permanently canceled refunding the amount minus any fees, and a new order is generated using the same reward (UTID) allowing you to correct the recipient’s name, email address, and reward amount. The new order uses the same account as the original order to withdraw the reward amount.
Note:
- You can only reissue Choice products anytime within five (5) calendar days of sending it.
- You can only reissue the first issuance of a Promo Link. If a Promo Link has expired and been reissued at least once, it can’t be reissued.
- You can only reissue the same reward with a different amount, email, or recipient’s name.
- You cannot reissue with a different currency. Cancel the reward completely and then issue a brand-new reward in the currency of your choice.
How to issue a line item?
Let's say you realize that you have sent the Reward Link to the wrong recipient. You can reissue the reward with the correct recipient information. Here's how:
To reissue an existing line item:
- Call
POST {URI}/line-items/{referenceLineItemid}/reissue
to reissue the reward. - Enter the
referenceLineItemID
for the line item you are planning to reissue. - Enter a reason code, amount, and other fields. The returned payload is that of the newly issued order.
Use the following endpoint to reissue a line item:
Endpoint | Description |
---|---|
POST {URI}/lineItems/{referenceLineItemID}/reissue | Reissue a line item. |
The following path parameter is used with this endpoint:
Path params | Data type | Description |
---|---|---|
referencLineItemID | string | Reference line item ID is returned in the line item's response. (Required) |
The following body parameters are used to provide the reason to reissue the line item. See Get all reason codes for descriptions:
Body params | Data type | Description |
---|---|---|
reasonCode | string | (Required) Enter the reason why this line item is being reissued. See Get all reason codes for reasons and their descriptions. -DELIVERY_INFO -REWARD_AMOUNT -REWARD_TYPE -RECIPIENT -CURRENCY -RECEPIENT_REQUESTED -OTHER |
otherReason | string | This field is required if reasonCode is "OTHER". Enter a description why you need to reissue this line item only if the available reasonCodes don't meet your need. |
amount | number | Amount of the line item being reissued. |
recipient | object | (Optional) Use to update recipient name or email address: -firstName -lastName |
notes | string | (Optional) order notes (up to 150 characters). |
Here is the successful returned response of the new order when reissuing a line item. Note that it has a new referenceOrderID
.
{
"referenceOrderID": "string",
"externalRefID": "string",
"customerIdentifier": "string",
"accountIdentifier": "string",
"accountNumber": "string",
"amountCharged": {
"value": 0,
"currencyCode": "string",
"exchangeRate": 0,
"fee": 0,
"total": 0
},
"denomination": {
"value": 0,
"currencyCode": "string",
"exchangeRate": 0,
"fee": 0,
"total": 0
},
"utid": "string",
"ptid": "string",
"rewardName": "string",
"sender": {
"firstName": "string",
"lastName": "string",
"email": "string"
},
"recipient": {
"email": "string",
"firstName": "string",
"lastName": "string",
"address": {
"streetLine1": "string",
"streetLine2": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"country": "string"
}
},
"emailSubject": "string",
"message": "string",
"sendEmail": true,
"etid": "string",
"status": "string",
"orderStatus": "string",
"lineItemStatus": "string",
"campaign": "string",
"createdAt": "2025-02-13T17:05:17.830Z",
"notes": "string",
"orderClientSource": "string",
"purchaseOrderNumber": "string",
"orderExternalRefIdDupe": true,
"reward": {
"credentials": {
"additionalProp": "string"
},
"credentialList": [
{
"label": "string",
"value": "string",
"type": "string",
"credentialType": "string"
}
],
"redemptionInstructions": "string"
}
}
If you try to reissue with the referenceLineItemID
of a line item that has been canceled, you get 422 unprocessable .
{
"timestamp": "2025-02-18T22:31:11.990150487Z",
"requestId": "cfe60046-a95a-4a2c-b861-b75e69cf31b6",
"path": "/raas/v2/lineItems/RG250218-134884-59-1/reissue",
"httpCode": 422,
"httpPhrase": "Unprocessable Entity",
"i18nKey": "422.242",
"message": "Line Item ineligible to reissue."
}
The possible response codes for this endpoint are:
- 202 Accepted
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
- 422 Unprocessable Entity
- 500 Internal Server Error
Updated 2 days ago