Freeze async orders

🚧
Coming soon: This feature will be coming soon.

This endpoint allows you to freeze Choice product rewards in an order. Freezing is only permitted under specific conditions and within a defined time window. It is only used for Choice Products, such as: Reward Link®, Global Choice Link, Promo Link™, and Disbursement Link. See Manage Choice products.

A frozen reward becomes temporarily locked and cannot be redeemed until it is unfrozen or automatically released. Call POST {URI}/asyncOrders/{referenceOrderID}/freeze with an appropriate reason code. The overall outcome is then reported via the webhook event:OrderActionStatus. See Order action status for more information.

Use case

ACME Health uses asynchronous orders to issue large batches of wellness rewards. When a fraud‑monitoring rule flags certain members’ line items after submission, the operations team temporarily freezes specific unredeemed rewards to prevent redemption while the async order is still processing. Freezing is permitted for each reward is a line item within the async order. Fully unredeemed Choice Products can be frozen within five days of issuance to investigate issues such as incorrect amounts, wrong recipient information, or suspected fraud. The freeze is automatically lifting after 48 hours if no further action is taken.

Freeze async orders

Use the following endpoint to freeze a qualified line item:

Endpoint	Purpose
`POST {URI}/asyncOrders/{referenceOrderID}/freeze`	Freeze all eligible line items in an order.

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

Path params	Requirement	Data type	Description
`referenceOrderID`	required	string	Any reference order ID (portal or API) to be frozen

The following body parameters are used to provide the reason for freezing your line item. See Get all reason codes for descriptions:

Body params	Data type	Requirement	Description
reasonCode	string	required	Enter the reason code to cancel this line item. See Get all reason codes VERIFY_ORDER DUPLICATE FRAUD OTHER
otherReason	string	optional	This field is required if `reasonCode` equals OTHER. Enter a description of why you canceled this line item only if the available `reasonCodes` don't meet your needs.

Body params

Data type

Requirement

Description

reasonCode

string

required

Enter the reason code to cancel this line item. See Get all reason codes

VERIFY_ORDER
DUPLICATE
FRAUD
OTHER

otherReason

string

optional

This field is required if reasonCode equals OTHER. Enter a description of why you canceled this line item only if the available reasonCodes don't meet your needs.

📘
Notes

Only fully unredeemed Choice Products, such as: Reward Link®, Global Choice Link, Promo Link™, and Disbursement Link can be frozen.

Freeze must occur within 5 calendar days of reward issuance.

A reward can be frozen multiple times as long as it remains unredeemed and within the valid timeframe.

Frozen rewards auto‑unfreeze after 48 hours if no action is taken.

Promo Links do not have their expiration dates extended by freezing.

Response message

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

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

The response body provides:

Field	What it tells you
`referenceOrderId`	Tango’s system‑assigned order ID
`externalRefID`	Your own order tracking ID (idempotency key)
`status`	The current async processing status
`totalLineItems`	How many rewards were in the order
`date`	When this order event occurred

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

Response code	Meaning
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.
404	The server was unable to find the requested resource. In other words, the URL you're trying to access doesn't point to anything that exists on the server.
422	The server understands the request but cannot process it due to semantic errors.