Cancel async orders

🚧

Coming soon: This feature will be coming soon.

This endpoint allows you to cancel Choice Product rewards in an order. A cancelled Choice Product reward becomes permanently void and cannot be redeemed. Only fully unredeemed Choice Product rewards, within the first 5 days of issuance, are eligible for cancellation. You can only cancel Choice Products, such as: Reward Link®, Global Choice Link, Promo Link™, and Disbursement Link. See Manage Choice products and Tango Cancellation Policy for more details.

Use POST {URI}/asyncOrders/{referenceOrderID}/cancel to cancel. When cancelling, you must supply a reason code, such as: fraud or duplicate. The system identifies which rewards meet the cancellation business rules, then processes and refunds them. The overall outcome is then reported via the webhook event:OrderActionStatus. See Order action status for more information.

Use Case

ACME Health sends wellness rewards through large asynchronous batches. Occasionally, an order must be canceled, such as when it was placed by mistake or fraudulently. Because Tango allows cancellation of fully unredeemed Choice Products within five days of issuance, ACME Health can use the POST {URI}/asyncOrders/{referenceOrderID}/cancel endpoint to void the rewards, refund the funds back to the original account, and prevent redemption. The cancellation request requires a valid reason code. Tango returns a 202 Accepted response when the cancel action is received successfully.

Cancel async orders

Use the following endpoint to cancel a qualified line item:

Use the following path parameter to identify which line items you're canceling:

The following body parameters are used to explain why your order was canceled. See Get all reason codes for descriptions:

📘

Notes

• Only fully unredeemed Choice Products, such as: Reward Link®, Global Choice Link, Promo Link™, and Disbursement Link can be cancelled.
• Orders with a status of COMPLETE or PARTIAL are eligible for cancellation, while those with a status of FAILED or PENDING cannot be canceled.
• Line items marked as COMPLETE are eligible for cancellation.
• Rewards with a status of ACTIVE or FROZEN can be canceled.

Response message

Here is the response returned when canceling an order is successful:

{
  "referenceOrderId": "string",
  "externalRefID": "string",
  "status": "string",
  "totalLineItems": 0,
  "date": "2026-02-17T18:02:33.823Z"
}

The response body provides:

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