Pular para o conteúdo principal

Listar Pagamentos

Este endpoint tem a finalidade de fornecer detalhes de todas as cobranças pagas pelo cliente, incluindo boletos bancários e Faturas de recolhimento.

Boleto bancário

É o boleto bancário convencional (linhas digitáveis não iniciadas com dígito 8). Possui registro na Câmara Interbancária de Pagamento (CIP/Núclea) e pode ser pago em instituições financeiras e de pagamento autorizadas a funcionar pelo Banco Central.

Fatura de recolhimento

Esse tipo de cobrança é emitido por concessionárias de serviços (conta de água, luz, telefone e gás) e órgão públicos (tributos). Eles não são registrados na Câmara Interbancária de Pagamento (CIP/Núclea), por isso, não retornam as mesmas informações que um Boleto bancário apresenta.

Request​

Request Endpoint​

ENDPOINT
/account/ACCOUNT_KEY/payments
MÉTODO
GET

Request Path Params​

CampoTipoDescriçãoCaracteres
account_key *uuid4Chave única de identificação da conta.36

Request Query String Params​

CampoTipoDescrição
request_control_keyuuid4Chave única de identificação da request do cliente.
payment_keyuuid4Chave única de identificação do pagamento.
payment_schedule_keyuuid4Chave única de identificação do agendamento de pagamento.
payment_typeenumTipo do pagamento.
payment_statusenumStatus do pagamento.
date_fromstringData inicial. Formato "YYYY-MM-DD".
date_tostringData final. Formato "YYYY-MM-DD".
pagestringNúmero da página requisitada. 1 por padrão.
page_sizestringTamanho da página requisitada na consulta. 30 por padrão e valor máximo.

Enumeradores payment_type​

EnumeradorTipoDescrição
bank_slipstringBoleto bancário
collection_slipstringFatura de recolhimento

Enumeradores payment_status​

EnumeradorDescrição
pending_executionPendente de execução
executedExecutado
revertedRevertido
rejectedRejeitado
errorErro

Response​

Success Response​

STATUS
200
Response Body: Consulta de pagamentos
{
  "data": [
    {
        "payment_key":"c4325104-d60b-44f3-aae4-49155564a2ea",
        "request_control_key":"b713b2f6-2f48-4d18-b0c9-7186e4edf189",
        "payer_name":"COOPERATIVA INDUSTRIAL MURILO",
        "payer_document_number":"00037025000160",
        "source_account_key":"6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
        "transaction_key":"4e80070a-a0bb-4be2-8178-55fbd73a3704",
        "transaction_revert_key":null,
        "paid_amount":1050.1,
        "payment_date":"2024-04-03",
        "payment_type":"bank_slip",
        "bank_slip": {
                "bank_slip_key":"95080ffd-3ac5-48d7-b3fe-659e4aaba81a",
                "barcode":"00193967000009910000000003615574000000002417",
                "digitable_line":"00190000090361557400500000024174396700000991000",
                "payer_name":"COOPERATIVA TESTE",
                "payer_document_number":"00037025000160",
                "beneficiary_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
                "beneficiary_trading_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
                "beneficiary_document_number":"52069937000117",
                "beneficiary_bank_ispb":"00000000",
                "guarantor_name":null,
                "guarantor_document_number":null,
                "expiration_date":"2024-03-29",
                "max_payment_data": "2026-03-29",
                "partial_payment_indicator":"allowed",
                "registered_payment_amount":9029.0,
                "nominal_amount":9910.0,
                "total_amount":10129.1,
                "rebate_amount":0.0,
                "discount_amount":0.0,
                "fine_amount":0.0,
                "interest_amount":219.1
            },
        "collection_slip":null,
        "payment_status":"executed"
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 30
  }
}

Response Body Params​

CampoTipoDescrição
payment_key *uuid4Chave única de identificação do pagamento.
request_control_key *uuid4Chave única de identificação da request do cliente.
payer_name *stringNome do pagador efetivo.
payer_document_number *stringNúmero de documento do pagador efetivo (CPF/CNPJ).
source_account_key *uuid4Chave da conta debitada.
transaction_key *uuid4Chave da transação do pagamento.
transaction_revert_keyuuid4Chave da transação de reversão do pagamento.
paid_amount *numberValor pago efetivamente.
payment_date *stringData do pagamento.
payment_type *enumTipo do pagamento.
bank_slipobjectBoleto bancário.
collection_slipobjectFatura de recolhimento.
payment_status *enumStatus do pagamento.

Enumeradores payment_type​

EnumeradorDescrição
bank_slipBoleto bancário
collection_slipFatura de recolhimento

Enumeradores payment_status​

EnumeradorDescrição
pending_executionPendente de execução
executedExecutado
revertedRevertido
rejectedRejeitado
errorErro

Objeto bank_slip​

CampoTipoDescrição
barcode *stringCódigo de barras.
digitable_line *stringLinha digitável.
payer_name *stringNome do pagador.
payer_document_number *stringNúmero de documento do pagador (CPF/CNPJ).
beneficiary_name *stringNome do beneficiário.
beneficiary_trading_namestringNome fantasia do beneficiário.
beneficiary_document_number *stringNúmero de documento do beneficiário (CPF/CNPJ).
beneficiary_bank_ispb *stringCódigo ispb do banco do beneficiário.
guarantor_namestringNome do sacador avalista.
guarantor_document_numberstringNúmero de documento do sacador avalista (CPF/CNPJ).
expiration_date *stringData de vencimento.
max_payment_date *stringData máxima de pagamento.
partial_payment_indicator *enumIndicador de pagamento parcial.
registered_payment_amountstringValor total de pagamento registrado.
nominal_amount *numberValor original.
total_amount *numberValor total.
rebate_amount *numberValor do abatimento.
discount_amount *numberValor do desconto.
fine_amount *numberValor da multa.
interest_amount *numberValor do juros.

Enumeradores partial_payment_indicator​

EnumeradorDescrição
allowedPermitido
not_allowedNão permitido

Objeto collection_slip​

CampoTipoDescrição
barcode *stringCódigo de barras.
digitable_line *stringLinha digitável.
collection_name *stringNome do pagador.
collection_document_number *stringNúmero de documento do convênio (CPF/CNPJ).
expiration_date *stringData de vencimento.
total_amount *numberValor total.

Error Response​

STATUS
4XX
Response Body
{
    "title": "Título",
    "description": "Description in english",
    "translation": "Descrição em português",
    "code": "Código"
}
Código HTTPCódigo QITítuloDescrição (eng)Descrição (pt-br)
400BIP000026Bad RequestInvalid payment date format. The correct format is YYYY-MM-DD.Formato de data de pagamento inválido. O formato correto é YYYY-MM-DD.
400BIP000027Bad RequestInvalid integer value for page or size query string parameters.Valor inválido para parâmetros de página ou tamanho de página.
400BIP000047Bad RequestInvalid payment type.Tipo de pagamento inválido.