PApaycrest
Provider

Cancel an order

Changed on

Provider cancels a previously accepted order. The aggregator will attempt reassignment. A duplicate reason cancels the order without reassignment; see reason below.

post/provider/orders/{id}/cancel

Request

  • Base URL
    https://api.paycrest.io/v2
  • URL
    https://api.paycrest.io/v2/provider/orders/{id}/cancel
  • Auth
    API key in header API-Key

Path parameters

idstring uuid required

Request body

reasonstring

Reason for cancellation. duplicate_gateway_order:<holdingOrderId> (another Paycrest order already holds the same on-chain order) or duplicate_reference:<holdingOrderId>, where <holdingOrderId> is the UUID of that other order, tells the aggregator you will not pay out because the order is a duplicate. The order is then cancelled and not reassigned, but only if the aggregator can confirm the claim: the holding order must be a different order with the same on-chain order and token, or the on-chain order must already be fulfilled or refunded. A reason without a valid holding order id is never confirmed. An unconfirmed claim is handled as an ordinary cancel. The Paycrest provider node sends these reasons automatically.

Response

Order cancelled

statusstring
messagestring
dataobject

The actual response data (e.g., ReceiveAddressResponse, etc.)

Example response

{
  "status": "success",
  "message": "Operation successful"
}

Changes