1. Orders
Kapitale
  • Integration Guide
    • πŸ“‹ Introduction
    • πŸ” Authentication
    • πŸš€ Integration Flow
    • πŸ”” Webhooks
    • πŸ”„ Integration Flowchart
    • πŸ§ͺ Sandbox Environment
    • πŸ“Š Status Map
    • ⚠️ Error Handling
    • πŸ“ Practical Examples
    • πŸ’³ Receivable Consultation
    • πŸ“ž Support
  • API
    • Retail
      • Fetch retail information by CNPJ
    • Orders
      • Create a new order
        POST
      • List orders
        GET
      • Fetch order by ID
        GET
      • Set payment invoice
        PATCH
      • Cancel order
        PATCH
    • Receivable
      • Fetch receivables by CNPJ
  • Schemas
    • CreateOrderRequest
    • RetailInfo
    • Acquirer
    • CancelOrderRequest
    • PurchaseItem
    • Order
    • FindReceivableResponse
    • OrderStatus
    • PaymentStatus
    • FindByIndustryCnpjResponse
    • OrderStatistics
    • Error
    • ReceivableItem
  1. Orders

Fetch order by ID

Partners Integration - Production
https://partners.kapitale.com.br/v1
Partners Integration - Production
https://partners.kapitale.com.br/v1
GET
/order/{id}
Returns the details of a specific order by ID. Scope: orders.read

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Path Params

Responses

🟒200
application/json
Order found
Body

🟠404
🟠401Unauthorized
πŸ”΄500InternalServerError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://partners.kapitale.com.br/v1/order/550e8400-e29b-41d4-a716-446655440000' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "order_no": "ORD-2024-001",
    "expiry_date": "2024-12-31T00:00:00.000Z",
    "invoice_number": "123456",
    "invoice": "https://s3.amazonaws.com/bucket/invoice.pdf",
    "commercial_invoice_id": "string",
    "payment_status": "pending",
    "order_status": "pending",
    "requested_amount": 10000.5,
    "paid_amount": 9785.49,
    "payment_approved_date": "2019-08-24T14:15:22.123Z",
    "retail_fee": 0,
    "industry_fee": 0.0215,
    "retail_id": "string",
    "industry_id": "string",
    "payment_denied_reason": "string",
    "liquidated_at": "2019-08-24T14:15:22.123Z",
    "canceled_at": "2019-08-24T14:15:22.123Z",
    "denied_at": "2019-08-24T14:15:22.123Z",
    "retail_email": "string",
    "retail_phone": "string",
    "retail_representative": "string",
    "created_at": "2019-08-24T14:15:22.123Z",
    "updated_at": "2019-08-24T14:15:22.123Z"
}
Modified atΒ 2026-03-19 13:59:13
Previous
List orders
Next
Set payment invoice
Built with