Delete Coupon

DELETE 
/payments/coupon

The "Delete Coupon" API allows you to permanently remove a coupon from your system using its unique identifier. Use this endpoint to discontinue promotional offers or clean up unused coupons. Note that this action cannot be undone.

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

altIdstringrequired

Location Id

altTypestringrequired
Alt Type
Available optionslocation
idstringrequired

Coupon Id

Example (auto)

{
  "altId": "BQdAwxa0ky1iK2sstLGJ",
  "altType": "location",
  "id": "6241712be68f7a98102ba272"
}

application/json

Successful response

application/json

Schema

Schema

successbooleanrequired

Indicates whether the delete was successful

traceIdstringrequired

Unique identifier for tracing this API request

Example (auto)

{
  "success": true,
  "traceId": "c667b18d-8f5e-44cf-a914"
}