Consultar lote de agendamento de pagamento

Este endpoint retorna o resumo do lote de agendamento e a lista paginada dos agendamentos que o compõem (boletos bancários ou faturas de recolhimento).

Para localizar batch_payment_schedule_key, utilize Listar lotes de agendamento de pagamento.

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ãos 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

/bill_payment/account/ACCOUNT_KEY/schedule/BATCH_PAYMENT_SCHEDULE_KEY

MÉTODO

GET

Request Path Params

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

Request Query String Params

Campo	Tipo	Descrição
page	string	Número da página dos itens em payment_schedules.data. 1 por padrão.
page_size	string	Tamanho da página dos itens em payment_schedules.data. 30 por padrão e valor máximo.

Response

Success Response

STATUS

200

Response Body: Detalhes do lote de agendamento

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "total_scheduled": 10,
  "total_pending": 0,
  "total_error": 0,
  "total_amount": 1357.3,
  "batch_payment_schedule_status": "scheduled",
  "payment_schedules": {
    "pagination": {
      "current_page": 1,
      "rows_per_page": 30
    },
    "data": [
      {
        "payment_schedule_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_date": "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",
        "error_reason": null
      }
    ]
  }
}

Response Body Params

Campo	Tipo	Descrição
request_control_key *	uuid4	Chave única de identificação da requisição do cliente (lote).
total_scheduled *	int	Quantidade de itens do lote agendados com sucesso.
total_pending *	int	Quantidade de itens ainda pendentes no lote.
total_error *	int	Quantidade de itens com erro no lote.
total_amount *	number	Valor total do lote.
batch_payment_schedule_status *	enum	Status do lote de agendamento.
payment_schedules *	object	Lista paginada dos agendamentos do lote.

Objeto payment_schedules

Campo	Tipo	Descrição
pagination *	object	Paginação da lista de agendamentos do lote.
data *	array	Itens do lote (agendamentos individuais).

Cada elemento de payment_schedules.data contém:

Campo	Tipo	Descrição
payment_schedule_key *	uuid4	Chave única de identificação do agendamento.
request_control_key *	uuid4	Chave única de identificação da requisição do cliente para o item do lote.
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 agendado para pagamento.
payment_date *	string	Data do agendamento.
payment_type *	enum	Tipo do pagamento.
bank_slip	object	Boleto bancário. Pode ser null quando payment_type for collection_slip.
collection_slip	object	Fatura de recolhimento. Pode ser null quando payment_type for bank_slip.
payment_schedule_status *	enum	Status do agendamento.
error_reason	string	Motivo do erro, quando aplicável; caso contrário null.

Objeto pagination

Campo	Tipo	Descrição
current_page *	int	Página atual retornada.
rows_per_page *	int	Quantidade de registros por página.

Enumeradores payment_type

Enumerador	Descrição
bank_slip	Boleto bancário
collection_slip	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 foi gerado
rejected	O agendamento foi rejeitado e nenhum pagamento foi gerado
canceled	Agendamento cancelado
error	Erro ao realizar o agendamento

Enumeradores batch_payment_schedule_status

Enumerador	Descrição
pending_2fa_approval	Pendente de aprovação 2FA
scheduled	Agendado
rejected	Rejeitado
canceled	Cancelado
error	Erro ao agendar

Objeto bank_slip

Campo	Tipo	Descrição
bank_slip_key *	uuid4	Chave única de identificação do boleto bancário.
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	number	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 dos juros.

Enumeradores partial_payment_indicator

Enumerador	Descrição
allowed	Permitido
not_allowed	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 convênio.
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	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.
404	BIP000083	Not Found	Batch payment not found by batch payment key.	Lote de pagamentos não encontrado pela chave do lote.