💳 Receivable Consultation

This document describes how to use the receivable consultation endpoint available in the Partners API.

Endpoint

Method: GET

Path: /receivable/{cnpj}

Required scope: partner-can/receivable.read

Authentication

All requests must include a valid OAuth2 bearer token in the Authorization header:

Path Parameter

Parameter	Type	Required	Description
`cnpj`	string	Yes	CNPJ with exactly 14 numeric digits (numbers only).

Request Example

Success Response (200)

{
  "total_amount": 150000.0,
  "total_available_amount": 92000.0,
  "limit_per_operation": 50000.0,
  "limit_used": 18000.0,
  "acquirers": [
    {
      "description": "Acquirer A",
      "total_amount": 90000.0
    },
    {
      "description": "Acquirer B",
      "total_amount": 60000.0
    }
  ]
}

Response Fields

Field	Type	Description
`total_amount`	number	Total receivable amount identified for the CNPJ.
`total_available_amount`	number	Amount currently available for operations.
`limit_per_operation`	number	Maximum allowed amount per operation.
`limit_used`	number	Amount already consumed from the available limit.
`acquirers`	array	Breakdown of receivables by acquirer.

Error Responses

Code	Meaning	Recommended Action
`401`	Unauthorized	Check token validity, expiration, and scope.
`404`	Not Found	Verify if the CNPJ exists and is eligible for consultation.

⚠️ Point of Attention

Receivable schedule consultation is only available for clients that are already registered with Kapitale.

💳 Receivable Consultation

Endpoint#

Authentication#

Path Parameter#

Request Example#

Success Response (200)#

Response Fields#

Error Responses#

⚠️ Point of Attention#