Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Celcoin OutstandingBalance API

The OutstandingBalance API from Celcoin — 4 operation(s) for outstandingbalance.

Celcoin OutstandingBalance API is one of 15 APIs that Celcoin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include OutstandingBalance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version v1.0.0.

Requests are made against a single base URL, https://sandbox.openfinance.celcoin.dev/billissuance/v1.

4 operations 4 paths 9 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v1.0.0
Base URL
https://api.openfinance.celcoin.com.br/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Celcoin OutstandingBalance API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer).

  • Bearer — Autenticação utilizando JTW Bearer Token

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

OutstandingBalance 4
POST
/outstanding-balance/inform
Inform outstanding balance
1 param body → 200404400500
POST
/outstanding-balance/reject
Reject outstanding balance
1 param body → 200404400500
POST
/outstanding-balance/settled-purchase/{outstandingBalancetInformedId}
Settled purchase
2 params → 200404400500
POST
/outstanding-balance/report-payment/{outstandingBalancePaymentId}
Report the payment for outstanding balance
2 params → 200404400500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are OutstandingBalanceInformedRequest (9 properties), SettledPurchaseResponse (5 properties), OutstandingBalancePaymentResponse (3 properties), InfoAccount (3 properties). Each schema is shown below with its type and property counts.

SettledPurchaseResponse
object
5 properties
OutstandingBalanceRejectedRequest
object
2 properties 1 required
InfoAccount
object
3 properties 3 required
OutstandingBalanceRejectedResponse
object
3 properties
ErrorResponse
object
3 properties
Errs
object
2 properties
OutstandingBalanceInformedRequest
object
9 properties 2 required
OutstandingBalancePaymentResponse
object
3 properties
OutstandingBalanceInformedResponse
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

celcoin-outstandingbalance-api-openapi.yml Raw ↑

Other APIs Celcoin publishes across the network.

Celcoin Card Solutions API
Celcoin Payments API
Celcoin Open Finance API
Celcoin AnnotationCompetenceCalendar API
Celcoin BankCorrespondentAgent API
Celcoin Consignee API
Celcoin Files API
Celcoin Guarantee API
Celcoin LegacyGuarantee API
Celcoin LegalPerson API
Celcoin NaturalPerson API
Celcoin Proposal API