Skip to main content

Order Cancellation

DELETE /api/integrator/order/cancel

An individual order can be canceled through this method.

Options:

  • Identifier (UUID, Required) - Identifier of the integrator in the Keepz system (provided to the integrator by the Keepz representative).
  • encryptedData (String, Required) - Request details encrypted with the key. The encrypted field must contain the following parameters:
    • integratorId (UUID, Required) - Unique identifier of the integrator in the Keepz system (provided to the integrator by the Keepz representative).
    • integratorOrderId (UUID, Required) - Unique identifier of the order in the integrator system.

Example:

Query Parameters:

  • "encryptedData": "string",
  • "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

Encrypted data:

{
    "integratorId": "ce8cc897-6963-4116-ac81-91323d172012",
    "integratorOrderId": "8ab2df0b-c749-4a68-bf3c-1179d17b83a4"
}

Parameters Returned:

  • encryptedData (String) - Response details encrypted with the Keepz key. The encoded value must contain the following parameters:
    • integratorOrderId (UUID) - Unique identifier of the order in the integrator system.
    • status (String) - The status of the order in the Keepz system. In case of successful cancellation of the order, the value of status should be "CANCELLED".

Example:

{
    "encryptedData": "string"
}

{
    "status": "CANCELLED",
    "integratorOrderId": "8ab2df0b-c749-4a68-bf3c-1179d17b83a4"
}