Reissue line items
You can reissue Choice Product (Reward Link®, Global Choice Link, Promo Link™, and Disbursement 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.
Use the following endpoint to reissue a line item:
| Endpoint | Description |
|---|---|
POST {URI}/lineItems/{referenceLineItemID}/reissue | Reissue a line item on this platform. |
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}/lineItems/{referenceLineItemID}/reissueto reissue the reward. - Enter the
referenceLineItemIDfor 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.
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 | Requirement | Description |
|---|---|---|---|
reasonCode | string | required | Enter the reason why this line item is being reissued. See Get all reason codes for reasons and their descriptions.
|
otherReason | string | required if | Enter a description why you need to reissue this line item only if the available |
amount | number | optional | Amount of the line item being reissued. |
deliveryMethod | string, enum | optional | Specify delivery method for the order. The allowed methods are: NONE, EMAIL, PHONE, ADDRESS, EMBEDDED. |
recipient | object | optional | Use to update recipient details when reissuing a line item. You can modify the recipient’s name, email, and mobile number. |
-firstName | string | optional | Use to update the recipient’s first name (0–100 characters). Cannot include < , >, and / For physical rewards, the maximum length is 25 characters. Allowed characters for physical rewards are digits (0–9), letters (a–z, A–Z), space, period (.), comma (,), and hyphen (-). |
-lastName | string | optional | Use to update the recipient’s last name (0–100 characters). Cannot include < , >, and / For physical rewards, the maximum length is 25 characters. Allowed characters for physical rewards are digits (0–9), letters (a–z, A–Z), space, period (.), comma (,), and hyphen (-). |
string | optional | Use to update the recipient’s email address. Is required if the delivery method is email. | |
-mobileNumber | string | optional | Use to update the recipient’s mobile number. It's required if the delivery method is SMS. |
notes | string | optional | Order notes up to 150 characters. |
Here is the successful returned response of the new order when reissuing a line item. The following order supports mobile delivery logic which is controlled by the recipient.mobileNumber files and the deliveryMethod value. Mobile delivery is only allowed if the MOBILE_DELIVERY feature is enabled for the account. Reissue has a new referenceOrderID.
{
"referenceOrderID": "string",
"externalRefID": "string",
"customerIdentifier": "string",
"accountIdentifier": "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",
"reward": {
"credentials": {
"additionalProp": "string"
},
"credentialList": [
{
"label": "string",
"value": "string",
"type": "string",
"credentialType": "string"
}
],
"redemptionInstructions": "string"
},
"sender": {
"firstName": "string",
"lastName": "string",
"email": "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"
}
},
"emailSubject": "string",
"message": "string",
"deliveryMethod": "NONE",
"status": "string",
"campaign": "string",
"purchaseOrderNumber": "string",
"createdAt": "2025-10-22T01:41:26.025Z",
"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."
}Here's an example payload for when you receive any 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:
| Response code | Meaning |
|---|---|
| 201 | New resource has been successfully created as a result of the request. |
| 202 | The server has received and accepted the request, but has not yet completed processing it. |
| 400 | The server could not understand the request due to invalid syntax. |
| 401 | Authentication is required and has either not been provided or failed. |
| 403 | The server understood the request but refuses to authorize it. |
| 422 | The server understands the request but cannot process it due to semantic errors. |
| 500 | Something went wrong on the server, but the server cannot be more specific about what the exact problem is. |
Updated 7 days ago
