Cancel order

Partners Integration - Production

https://partners.kapitale.com.br/v1

PATCH

/order/cancel/{order_id}

Cancels an order specifying the reason. Scope: orders.read

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Order canceled successfully

Body

🟠404

🟠400BadRequest

🟠401Unauthorized

🔴500InternalServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://partners.kapitale.com.br/v1/order/cancel/550e8400-e29b-41d4-a716-446655440000' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "Order canceled at customer request"
}'

Response Example

200 - Example 1

{
    "message": "Order cancelled successfully"
}

Modified at 2026-03-19 13:59:13

Set payment invoice

Fetch receivables by CNPJ