Consultar Agendamento

Este endpoint é utilizado para consultar as informações de um agendamento de pagamento de um Boleto Bancário ou Fatura 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_schedule/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
payment_schedule_key *	uuid4	Chave única de identificação do agendamento.	36

Response

Success Response

STATUS

200

Response Body: Agendamento de pagamento de boleto bancário

{
   "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"
}

Response Body: Agendamento de pagamento de fatura de recolhimento

{
  "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"
}

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 do documento do pagador efetivo (CPF/CNPJ).
source_account_key *	uuid4	Chave da conta debitada.
transaction_key *	uuid4	Chave da transação do pagamento.
transaction_revert_key	uuid4	Chave da transação de reversão do pagamento.
paid_amount *	number	Valor pago efetivamente.
payment_date *	string	Data do agendamento.
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 do 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 do 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 do 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	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	BIP000001	Bad Request	The barcode or digitable line must have 44 or 47 characters.	O código de barras ou linha digitável deve ter 44 ou 47 caracteres.
400	BIP000002	Bad Request	The bill sent does not correspond to a bank slip.	A conta enviado não corresponde a um boleto bancário.
400	BIP000003	Bad Request	The digitable line sent is invalid.	A linha digitável enviada é inválida.
404	BIP000004	Not Found	The bank slip was not found.	O boleto não foi encontrado.
400	BIP000005	Bad Request	It was not possible to consult the bank slip at this time. Please try again in a few minutes.	Não foi possível consultar o boleto neste momento. Por favor, tente novamente em alguns minutos.
400	BIP000006	Bad Request	Bank slip already written off	Boleto já baixado
400	BIP000007	Bad Request	Bank slip blocked for payment	Boleto bloqueado para pagamento
400	BIP000008	Bad Request	Bank slip already paid	Boleto já pago
400	BIP000009	Bad Request	Invalid bank slip. Please consult issuing bank	Boleto inválido. Favor consultar banco emissor