billpayments

Consulta um pagamento de conta

Changed on Nov 3, 2026

Tipos de pagamento de contas: 0 - Undefined 1 - Concessionaria 2 - FichaCompensacao <returns></returns>

post/v5/transactions/billpayments/authorize

Request

Base URL
https://sandbox.openfinance.celcoin.dev
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/celcoin/apis/api-para-transa-es/docs/v5/transactions/billpayments/authorize/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

externalTerminalstring nullable

Terminal de identificação externa do sistema do cliente, Ex: CPF.

externalNSUinteger

Identificador da transação do sistema cliente.

Example request

{
  "externalTerminal": "11122233344",
  "externalNSU": 1234,
  "barCode": {
    "type": 2,
    "digitable": "34191090080012213037050059980008586260000065000",
    "barCode": "34195862600000650001090000122130375005998000"
  }
}

Response

Success

assignorstring nullable

Cedente do pagamento consultado.

settleDatestring nullable

Informa a data em que o pagamento será enviado para liquidação.

dueDatestring date-time

Retorna a data de vencimento extraída do código de barras.

endHourstring nullable

Informa a Hora corte do convênio(HH:MM).

initeHourstring nullable

Informa a Hora recebimento Inicial do convênio(HH:MM).

nextSettlestring nullable

Informa se o título será liquidado no próximo dia útil.

digitablestring nullable

Linha digitável.

transactionIdinteger

Protocolo de identificação da operação.

typeinteger

Tipo da conta.

valuenumber double

Valor extraído do código de barras.

maxValuenumber double

Valor máximo para pagamento, extraído do código de barras.

minValuenumber double

Valor mínimo para pagamento, extraído do código de barras.

errorCodestring nullable

Código status da operação.

messagestring nullable

Informa descrição do erro.

statusinteger

Status da operação.

Example response

{
  "assignor": "BANCO ITAU S.A.",
  "registerData": {
    "documentRecipient": "21.568.259/0001-00",
    "documentPayer": "96.906.497/0001-00",
    "payDueDate": "2031-05-25T00:00:00",
    "nextBusinessDay": "2021-05-24T00:00:00",
    "dueDateRegister": "2021-05-20T00:00:00",
    "allowChangeValue": true,
    "recipient": "BENEFICIARIO AMBIENTE HOMOLOGACAO",
    "payer": "PAGADOR AMBIENTE HOMOLOGACAO",
    "interestValueCalculated": 25.6,
    "maxValue": 1032.9,
    "minValue": 344.3,
    "fineValueCalculated": 13,
    "originalValue": 650,
    "totalUpdated": 688.6,
    "totalWithAdditional": 38.6
  },
  "settleDate": "24/06/2021",
  "dueDate": "2021-05-20T00:00:00Z",
  "endHour": "20:00",
  "initeHour": "07:00",
  "nextSettle": "N",
  "digitable": "34191090080012213037050059980008586260000065000",
  "transactionId": 7083533,
  "type": 2,
  "value": 650,
  "errorCode": "000"
}

Changes

Nov 3, 2026b1e1fd65abf5 Revision changes
- breaking
  the response's body type changed from no type to object for status
- breaking
  removed the media type application/json for the response with the status
- breaking
  removed the media type application/json for the response with the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response's property type changed from no type to number, and format from no format to double for status
- breaking
  the response's property type changed from no type to string for status
- breaking
  the response's property type changed from no type to number, and format from no format to double for status
- breaking
  the / response's property type changed from integer to number, and format from no format to double for status
- breaking
  the / response's property type changed from integer to number, and format from no format to double for status
- breaking
  the / response's property type changed from integer to number, and format from no format to double for status
- breaking
  the / response's property type changed from integer to number, and format from no format to double for status
- breaking
  the / response's property type changed from no type to string, and format from no format to date-time for status
- breaking
  the / response's property type changed from integer to number, and format from no format to double for status
- breaking
  the / response's property type changed from integer to number, and format from no format to double for status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  api operation id pagamento-de-contas-2 removed and replaced with
- info
  the endpoint scheme security Bearer was added to the API
- info
  api tag billpayments added
- info
  added the media type application/*+json to the request body
- info
  added the media type application/json-patch+json to the request body
- info
  added the media type text/json to the request body
- info
  the request property / became nullable
- info
  the request property / became nullable
- info
  the request property became nullable
- info
  the request property became optional
- info
  the request property default value 23793381286008301352856000063307789840000150000 was removed
- info
  the request property default value 0 was removed
- info
  removed subschema #1: ERRO NA CONVERSÃO DO CÓDIGO DE BARRAS subschema #2: HORARIO MIN NAO ATINGIDO subschema #3: TRANSACAO NAO ENCONTRADA subschema #4: TRANSACAO JA REALIZADA subschema #5: FALHA NA COMUNICACAO COM A SUA INSTUICAO subschema #6: PAGAMENTO JA EFETUADO subschema #7: PAGAMENTO NAO PERMITIDO subschema #8: COD-BARRAS INVALIDO subschema #9: CODIGO BARRAS INVALIDO subschema #10: RECEBIMENTO NAO AUTORIZADO. DOCUMENTO VENCIDO subschema #11: DOCUMENTO NAO RECEBIVEL NA INSTITUICAO subschema #12: PDV C/ TRANSACAO EM PROCESSAMENTO subschema #13: MAXIMO DE DIAS DE ATRASO EXCEDIDO subschema #14: MAXIMO DE DIAS DE ADIANTAMENTO NAO ALCANCADO subschema #15: CONTA COM VALOR MAIOR QUE O LIMITE subschema #16: PROBLEMA COM O REGISTRO DA CONSULTA subschema #17: CEDENTE NAO AUTORIZADO. PAGAMENTO NAO EFETUADO subschema #18: BOLETO DE PAGAMENTO JA BAIXADO subschema #19: PROCESSO DE ABERTURA DA JANELA DA NUCLEA from the response body oneOf list for the response status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  the response's property default value true was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status

Operation history