Listar Agendamentos

Este endpoint tem a finalidade de fornecer detalhes de todos os agendamentos realizados pelo parceiro integrador, 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

ENDPOINT

/account/ACCOUNT_KEY/payment_schedules

MÉTODO

GET

Request Path Params

Campo	Tipo	Descrição	Caracteres
account_key *	uuid4	Chave única de identificação da conta.	36

Request Query String Params

Campo	Tipo	Descrição
request_control_key	uuid4	Chave única de identificação da request do cliente.
payment_schedule_key	uuid4	Chave única de identificação do agendamento.
payment_key	uuid4	Chave única de identificação do pagamento gerado para o agendamento.
payment_type	enum	Tipo do pagamento.
payment_schedule_status	enum	Status do agendamento.
date_from	string	Data inicial. Formato "YYYY-MM-DD".
date_to	string	Data final. Formato "YYYY-MM-DD".
page	string	Número da página requisitada. 1 por padrão.
page_size	string	Tamanho da página requisitada na consulta. 30 por padrão e valor máximo.

Enumeradores payment_type

Enumerador	Tipo	Descrição
bank_slip	string	Boleto bancário
collection_slip	string	Fatura de recolhimento

Enumeradores payment_schedule_status

Enumerador	Descrição
pending_2fa_approval	Agendamento pendente de autenticação de dois fatores (2FA)
scheduled	Pagamento agendado com sucesso
executed	O agendamento foi executado com sucesso e o pagamento referente ao agendamento gerado
rejected	O agendamento foi rejeitado e nenhum pagamento foi gerado
canceled	Agendamento cancelado
error	Erro ao realizar o agendamento

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",
       "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_schedule_status":"scheduled"
    },
    {
      "payment_key": "33860ad0-bcb0-47b7-bbe7-c7e3ec2fc61a",
      "request_control_key": "ae4508df-f2cb-4e28-9f04-a19b7f2758c9",
      "payer_name": "COOPERATIVA INDUSTRIAL MURILO",
      "payer_document_number": "62069937000118",
      "source_account_key": "daae79e6-ee8b-449f-aa1e-96959d5d5a72",
      "paid_amount": 1389.21,
      "payment_date": "2024-04-30",
      "payment_type": "collection_slip",
      "bank_slip": null,
      "collection_slip": {
        "barcode": null,
        "digitable_line": "836200000138892100450006762142420244046000010192",
        "collection_name": "CIA ULTRAGAZ SA-COD",
        "collection_document_number": "00394460005887",
        "expiration_date": "2024-04-15",
        "total_amount": 1389.21
      },
      "payment_schedule_status": "scheduled"
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 30
  }
}

Response Body Params

Campo	Tipo	Descrição
payment_key *	uuid4	Chave única de identificação do pagamento.
request_control_key *	uuid4	Chave única de identificação da request do cliente.
payer_name *	string	Nome do pagador efetivo.
payer_document_number *	string	Número de documento do pagador efetivo (CPF/CNPJ).
source_account_key *	uuid4	Chave da conta debitada.
paid_amount *	number	Valor pago efetivamente.
payment_date *	string	Data do pagamento.
payment_type *	enum	Tipo do pagamento.
bank_slip	object	Boleto bancário.
collection_slip	object	Fatura de recolhimento.
payment_schedule_status *	enum	Status do agendamento.

Enumeradores payment_type

Enumerador	Tipo	Descrição
bank_slip	string	Boleto bancário
collection_slip	string	Fatura de recolhimento

Enumeradores payment_schedule_status

Enumerador	Descrição
pending_2fa_approval	Agendamento pendente de autenticação de dois fatores (2FA)
scheduled	Pagamento agendado com sucesso
executed	O agendamento foi executado com sucesso e o pagamento referente ao agendamento gerado
rejected	O agendamento foi rejeitado e nenhum pagamento foi gerado
canceled	Agendamento cancelado
error	Erro ao realizar o agendamento

Objeto bank_slip

Campo	Tipo	Descrição
barcode *	string	Código de barras.
digitable_line *	string	Linha digitável.
payer_name *	string	Nome do pagador.
payer_document_number *	string	Número de documento do pagador (CPF/CNPJ).
beneficiary_name *	string	Nome do beneficiário.
beneficiary_trading_name	string	Nome fantasia do beneficiário.
beneficiary_document_number *	string	Número de documento do beneficiário (CPF/CNPJ).
beneficiary_bank_ispb *	string	Código ispb do banco do beneficiário.
guarantor_name	string	Nome do sacador avalista.
guarantor_document_number	string	Número de documento do sacador avalista (CPF/CNPJ).
expiration_date *	string	Data de vencimento.
max_payment_date *	string	Data máxima de pagamento.
partial_payment_indicator *	enum	Indicador de pagamento parcial.
registered_payment_amount	string	Valor total de pagamento registrado.
nominal_amount *	number	Valor original.
total_amount *	number	Valor total.
rebate_amount *	number	Valor do abatimento.
discount_amount *	number	Valor do desconto.
fine_amount *	number	Valor da multa.
interest_amount *	number	Valor do juros.

Enumeradores partial_payment_indicator

Enumerador	Tipo	Descrição
allowed	string	Permitido
not_allowed	string	Não permitido

Objeto collection_slip

Campo	Tipo	Descrição
barcode *	string	Código de barras.
digitable_line *	string	Linha digitável.
collection_name *	string	Nome do pagador.
collection_document_number *	string	Número de documento do convênio (CPF/CNPJ).
expiration_date *	string	Data de vencimento.
total_amount *	number	Valor 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 HTTP	Código QI	Título	Descrição (eng)	Descrição (pt-br)
400	BIP000026	Bad Request	Invalid payment date format. The correct format is YYYY-MM-DD.	Formato de data de pagamento inválido. O formato correto é YYYY-MM-DD.
400	BIP000027	Bad Request	Invalid integer value for page or size query string parameters.	Valor inválido para parâmetros de página ou tamanho de página.
400	BIP000047	Bad Request	Invalid payment type.	Tipo de pagamento inválido.