Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Places a new stop order to block future recurring transactions from a specific merchant for a given card.
| Fields | Description |
|---|---|
| card_token string Required | Token of the card on which to place the stop order. Allowable Values: Existing card token |
| Fields | Description |
|---|---|
| transaction_token string Required | Marqeta-assigned token identifying the recurring transaction series. Allowable Values: Existing transaction token |
| stop_reason string Required | Reason for the stop order. Allowable Values: CANCELLED_SUBSCRIPTION - Cardholder canceled the subscription.TRIAL_ENDED - Free trial period has ended.UNRECOGNIZED_CHARGE - Cardholder does not recognize the charge.BILLING_ISSUE - Billing dispute or problem.MERCHANT_UNRESPONSIVE - Merchant is not responding to cancellation requests.PRICE_CHANGE - Subscription price changed unexpectedly.SUSPECTED_FRAUD - Potential fraudulent activity.CARD_LOST_OR_REPLACED - Card was lost, stolen, or replaced.OTHER - Other reason. Use the reason_description field for details. |
| reason_description string Optional | Free-text description of the reason. Allowable Values: 255 char max |
| duration integer Optional | Duration of the stop order. Defaults to 13 if a value for this field is not provided.Max: 60.Allowable Values: Integer between 1 and 60 |
| duration_unit string Optional | Unit of the duration of the stop order. Currently the only values supported for this field are MONTH and YEAR. If no value is provided, duration_unit defaults to MONTH.If a value for duration_unit is provided without also providing a value for the duration field, then the endpoint returns a validation error.Allowable Values: MONTH, YEAR |
{
"transaction_token": "15254919",
"stop_reason": "OTHER",
"reason_description": "other reasons",
"duration": 2,
"duration_unit": "MONTH"
}
{
"stop_order_token": "so_12345",
"card_token": "card_token_123",
"transaction_token": "15254919",
"merchant_id": "mid",
"merchant_name": "merchant_name",
"original_amount": 20.00,
"stop_reason": "OTHER",
"reason_description": "other reasons",
"user_token": "cardholder_124",
"duration": 2,
"duration_unit": "MONTH",
"status": "ACTIVE",
"created_time": "2025-01-28T19:24:43Z",
"last_modified_time": "2025-01-28T19:24:43Z",
"expiry_time": "2025-03-28T23:59:59Z"
}
Was this page helpful?