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

The Consignee API from Celcoin — 1 operation(s) for consignee.

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

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

This API exposes 4 operations across 1 path, and defines 15 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 1 paths 15 schemas 1 DELETE1 GET1 POST1 PUT

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 Consignee 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 1 path, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Consignee 4
POST
/consignee
body → 200
PUT
/consignee
body → 200
GET
/consignee
1 param → 200
DELETE
/consignee
2 params → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are AgenciesResponse (9 properties), UpdateAgenciesResquest (8 properties), AgenciesRequest (7 properties), UpdateRubricConfigRequest (6 properties). Each schema is shown below with its type and property counts.

TypeProduct
string
CreateAgenciesResponse
object
2 properties
ConsigneeResponse
object
6 properties
CreateConsigneeResponse
object
3 properties 1 required
UpdateConsigneeRequest
object
5 properties 1 required
UpdateRubricConfigRequest
object
6 properties
AgenciesRequest
object
7 properties
UpdateAgenciesResquest
object
8 properties
AgenciesResponse
object
9 properties
CreateConsigneeRequest
object
4 properties
CreditProviderType
string
RubricConfigResponse
object
5 properties
RubricConfigRequest
object
5 properties
DeleteConsigneeResponse
object
6 properties
ClientResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

celcoin-consignee-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 Files API
Celcoin Guarantee API
Celcoin LegacyGuarantee API
Celcoin LegalPerson API
Celcoin NaturalPerson API
Celcoin OutstandingBalance API
Celcoin Proposal API