GET////
Returns a paginated list of all stop orders for the given card token, sorted by last modified time.
For errors associated with listing a stop order for a card, see the Errors page.
Path parameters
| Fields | Description |
|---|---|
| card_token string Required | Token of the card on which you have placed a stop order. Allowable Values: Existing card token |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | Number of resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
| data array of objects Conditionally returned | Array of stop order objects. Allowable Values: Valid array of one or more stop order objects |
| end_index integer Conditionally returned | Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that all resources have been returned.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| start_index integer Conditionally returned | Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| data[].* object Conditionally returned | See Stop order object. |
Sample response
JSON
{
"count": 3,
"start_index": 0,
"end_index": 2,
"is_more": false,
"data": [
{
"stop_order_token": "so_12345",
"card_token": "card_token_123",
"transaction_token": "txn_abc",
"merchant_id": "mid_001",
"merchant_name": "merchant_name_001",
"original_amount": 20.00,
"stop_reason": "CANCELLED_SUBSCRIPTION",
"reason_description": "Customer request",
"duration": 13,
"duration_unit": "MONTH",
"status": "ACTIVE",
"created_time": "2025-01-28T19:24:43Z",
"last_modified_time": "2025-01-28T19:24:43Z",
"expiry_time": "2026-02-28T23:59:59Z"
}
]
}