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 Settlement API

The Settlement API from Celcoin — 2 operation(s) for settlement.

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

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

This API exposes 2 operations across 2 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.

2 operations 2 paths 9 schemas 1 GET1 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 Settlement API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer).

  • Bearer — Autenticação utilizando JTW Bearer Token

Paths & Operations 2

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

Settlement 2
POST
/settlement
Inclusão da baixa do boleto.
body → 201400401404500
GET
/settlement/{id}
Consulta da baixa do boleto.
1 param → 200400401404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Settlement (20 properties), SettlementIssuanceRequest (5 properties), WebExceptionResponse (4 properties), TagRequest (2 properties). Each schema is shown below with its type and property counts.

WebExceptionResponse
object
Classe WebExceptionResponse Modelo de resposta de erro.
4 properties
Tag
object
Classe Tag Modelo de tag de marcação da baixa.
2 properties
SettlementOrigin
string
Valores SettlementOrigin Tipo de origem da baixa. Values: INTERBANCARIA - Origem interbancaria. INTRABANCARIA - Origem intrabancaria.
SettlementIssuanceRequest
object
Classe SettlementIssuanceRequest Modelo de requisição de inclusão de baixa via ponta destinatária.
5 properties 4 required
SettlementType
string
Valores SettlementType Tipo de baixa. Values: SOLICITACAOCEDENTE - Baixa Solicitação Cedente. SOLICITACAODESTINATARIA - Baixa Solicitação Destinataria.
Settlement
object
Classe Settlement Modelo de baixa.
20 properties
WebExceptionDetails
object
Classe WebExceptionDetails Modelo de resposta de detalhes do erro.
2 properties
TagRequest
object
Classe TagRequest Modelo de requisição de tag de marcação da baixa.
2 properties 2 required
SettlementStatus
string
Valores SettlementStatus Situação da baixa. Values: PROCESSAMENTO - Processamento. REJEITADA - Rejeitada. REGISTRADA - Registrada. CANCELADA - Cancelada. DISTR…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

celcoin-settlement-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 OutstandingBalance API