Celcoin BankCorrespondentAgent API

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

Operations 4

POST /correspAgent Creates a new bank correspondent agent.
GET /correspAgent
PUT /bankcorrespondentagent/{correspAgentId} Update an existing bank correspondent agent
DELETE /bankcorrespondentagent/{correspAgentId} Inactivate an existing bank correspondent agent

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/celcoin-bankcorrespondentagent-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

celcoin-bankcorrespondentagent-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: billissuance-settlement-webservice AnnotationCompetenceCalendar Bank Correspondent Agent API
  version: v1.0.0
servers:
- url: https://sandbox.openfinance.celcoin.dev/billissuance/v1
tags:
- name: BankCorrespondentAgent
paths:
  /correspAgent:
    post:
      tags:
      - BankCorrespondentAgent
      summary: Creates a new bank correspondent agent.
      requestBody:
        description: Data required to create the bank correspondent agent.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCorrespAgentRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CreateCorrespAgentRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreateCorrespAgentRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCorrespAgentResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    get:
      tags:
      - BankCorrespondentAgent
      parameters:
      - name: id
        in: query
        schema:
          type: string
          format: uuid
      - name: correspAgentId
        in: query
        schema:
          type: string
      - name: consigneeId
        in: query
        required: true
        schema:
          type: string
          format: uuid
      - name: document
        in: query
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCorrespAgentResponse'
        '204':
          description: No Content
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /bankcorrespondentagent/{correspAgentId}:
    put:
      tags:
      - BankCorrespondentAgent
      summary: Update an existing bank correspondent agent
      parameters:
      - name: correspAgentId
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBankCorrespondentAgentRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/UpdateBankCorrespondentAgentRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UpdateBankCorrespondentAgentRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankCorrespondentAgentResponse'
        '304':
          description: Not Modified
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - BankCorrespondentAgent
      summary: Inactivate an existing bank correspondent agent
      parameters:
      - name: correspAgentId
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankCorrespondentAgentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    GetCorrespAgentResponse:
      type: object
      properties:
        page:
          type: integer
          format: int32
        pageCount:
          type: integer
          format: int64
        pageSize:
          type: integer
          format: int32
        totalItens:
          type: integer
          format: int64
        correspondents:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CorrespondentAgent'
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        correlationId:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Errs'
      additionalProperties: false
    UpdateBankCorrespondentAgentRequest:
      type: object
      properties:
        socialName:
          type:
          - string
          - 'null'
        document:
          type:
          - string
          - 'null'
      additionalProperties: false
    CreateCorrespAgentRequest:
      required:
      - consigneeId
      - correspondentAgencyId
      - document
      - socialName
      type: object
      properties:
        correspondentAgencyId:
          type:
          - string
          - 'null'
        consigneeId:
          type: string
          format: uuid
        socialName:
          type:
          - string
          - 'null'
        document:
          type:
          - string
          - 'null'
      additionalProperties: false
    BankCorrespondentAgentResponse:
      required:
      - consigneeId
      - correspAgentId
      - createdAt
      - id
      type: object
      properties:
        id:
          type: string
          format: uuid
        correspAgentId:
          type:
          - string
          - 'null'
        consigneeId:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    Errs:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    CreateCorrespAgentResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        correspondentAgencyId:
          type:
          - string
          - 'null'
        consigneeId:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
      additionalProperties: false
    CorrespondentAgent:
      type: object
      properties:
        id:
          type: string
          format: uuid
        correspAgentId:
          type:
          - string
          - 'null'
        consigneeId:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: Autenticação utilizando JTW Bearer Token
      scheme: Bearer
      bearerFormat: JWT