Celcoin

Celcoin OutstandingBalance API

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

Documentation GitHub OpenAPI

Operations 4

POST /outstanding-balance/inform Inform outstanding balance

POST /outstanding-balance/reject Reject outstanding balance

POST /outstanding-balance/settled-purchase/{outstandingBalancetInformedId} Settled purchase

POST /outstanding-balance/report-payment/{outstandingBalancePaymentId} Report the payment for outstanding balance

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-outstandingbalance-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: billissuance-settlement-webservice AnnotationCompetenceCalendar Outstanding Balance API
  version: v1.0.0
servers:
- url: https://sandbox.openfinance.celcoin.dev/billissuance/v1
tags:
- name: OutstandingBalance
paths:
  /outstanding-balance/inform:
    post:
      tags:
      - OutstandingBalance
      summary: Inform outstanding balance
      parameters:
      - name: correspAgentId
        in: header
        description: Bank Correspondent Agent Id
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutstandingBalanceInformedRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/OutstandingBalanceInformedRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/OutstandingBalanceInformedRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutstandingBalanceInformedResponse'
        '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'
  /outstanding-balance/reject:
    post:
      tags:
      - OutstandingBalance
      summary: Reject outstanding balance
      parameters:
      - name: correspAgentId
        in: header
        description: Bank Correspondent Agent Id
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutstandingBalanceRejectedRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/OutstandingBalanceRejectedRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/OutstandingBalanceRejectedRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutstandingBalanceRejectedResponse'
        '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'
  /outstanding-balance/settled-purchase/{outstandingBalancetInformedId}:
    post:
      tags:
      - OutstandingBalance
      summary: Settled purchase
      parameters:
      - name: outstandingBalancetInformedId
        in: path
        description: Id outstanding balance informed
        required: true
        schema:
          type: string
          format: uuid
      - name: correspAgentId
        in: header
        description: Bank Correspondent Agent Id
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettledPurchaseResponse'
        '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'
  /outstanding-balance/report-payment/{outstandingBalancePaymentId}:
    post:
      tags:
      - OutstandingBalance
      summary: Report the payment for outstanding balance
      parameters:
      - name: correspAgentId
        in: header
        description: Bank Correspondent Agent Id
        schema:
          type: string
      - name: outstandingBalancePaymentId
        in: path
        description: Id from outstanding balance payment
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutstandingBalancePaymentResponse'
        '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'
components:
  schemas:
    InfoAccount:
      required:
      - bank
      - branch
      - number
      type: object
      properties:
        bank:
          type:
          - string
          - 'null'
        branch:
          type:
          - string
          - 'null'
        number:
          type:
          - string
          - 'null'
      additionalProperties: false
    OutstandingBalancePaymentResponse:
      type: object
      properties:
        outstandingBalancePaymentId:
          type: string
          format: uuid
        code:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    OutstandingBalanceRejectedResponse:
      type: object
      properties:
        outstandingBalanceInformedId:
          type: string
          format: uuid
        status:
          type:
          - string
          - 'null'
        updateAt:
          type: string
          format: date-time
      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
    OutstandingBalanceInformedRequest:
      required:
      - debtorBalanceAmount
      - requestOutstandingBalanceId
      type: object
      properties:
        requestOutstandingBalanceId:
          type: string
          format: uuid
        debtorBalanceAmount:
          type: number
          format: double
        nameBeneficiary:
          type:
          - string
          - 'null'
        documentBenficiary:
          type:
          - string
          - 'null'
        expirationDate:
          type:
          - string
          - 'null'
          format: date-time
        description:
          type:
          - string
          - 'null'
        detailOutstandingBalance:
          type:
          - string
          - 'null'
        proposalRefinancing:
          type:
          - string
          - 'null'
        infoAccount:
          $ref: '#/components/schemas/InfoAccount'
      additionalProperties: false
    OutstandingBalanceInformedResponse:
      required:
      - status
      type: object
      properties:
        outstandingBalanceInformedId:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
        status:
          type:
          - string
          - 'null'
      additionalProperties: false
    Errs:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    SettledPurchaseResponse:
      type: object
      properties:
        outstandingBalanceInformedId:
          type: string
          format: uuid
        statusOutstandingBalanceInformed:
          type:
          - string
          - 'null'
        updateAt:
          type: string
          format: date-time
        annotationId:
          type: string
          format: uuid
        statusAnnotation:
          type:
          - string
          - 'null'
      additionalProperties: false
    OutstandingBalanceRejectedRequest:
      required:
      - outstandingBalanceInformedId
      type: object
      properties:
        outstandingBalanceInformedId:
          type: string
          format: uuid
        description:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: Autenticação utilizando JTW Bearer Token
      scheme: Bearer
      bearerFormat: JWT