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

The BankCorrespondentAgent API from Celcoin — 2 operation(s) for bankcorrespondentagent.

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

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

This API exposes 4 operations across 2 paths, and defines 8 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 2 paths 8 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 BankCorrespondentAgent 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 2 paths, 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.

BankCorrespondentAgent 4
POST
/correspAgent
Creates a new bank correspondent agent.
body → 201404400500
GET
/correspAgent
6 params → 200204404400500
PUT
/bankcorrespondentagent/{correspAgentId}
Update an existing bank correspondent agent
1 param body → 200304400401404500
DELETE
/bankcorrespondentagent/{correspAgentId}
Inactivate an existing bank correspondent agent
1 param → 200400401404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are GetCorrespAgentResponse (5 properties), CorrespondentAgent (5 properties), BankCorrespondentAgentResponse (5 properties), CreateCorrespAgentResponse (4 properties). Each schema is shown below with its type and property counts.

CreateCorrespAgentRequest
object
4 properties 4 required
BankCorrespondentAgentResponse
object
5 properties 4 required
UpdateBankCorrespondentAgentRequest
object
2 properties
GetCorrespAgentResponse
object
5 properties
Errs
object
2 properties
ErrorResponse
object
3 properties
CreateCorrespAgentResponse
object
4 properties
CorrespondentAgent
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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