Cancelar agendamento em lote de pagamento

Este endpoint permite cancelar um lote de agendamento de pagamentos enquanto o lote estiver em status cancelável.

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

/account/ACCOUNT_KEY/batch_payment_schedule/BATCH_PAYMENT_SCHEDULE_KEY/cancel

MÉTODO

PATCH

Request Path Params

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

Response

Success Response

STATUS

200

Response Body: Lote de agendamento cancelado

{
  "batch_payment_schedule_key": "a3214093-e51c-55e2-b5d3-60244475b3fb",
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "account_key": "6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
  "total_amount": 1357.3,
  "batch_payment_schedule_status": "canceled",
  "payment_type": "bank_slip"
}

Response Body Params

Campo	Tipo	Descrição
batch_payment_schedule_key *	uuid4	Chave única de identificação do lote de agendamento.
request_control_key *	uuid4	Chave única de identificação da requisição do cliente (lote).
account_key *	uuid4	Chave da conta debitada.
total_amount *	number	Soma dos valores dos itens do lote.
batch_payment_schedule_status *	enum	Status do lote após a solicitação de cancelamento.
payment_type *	enum	Tipo do pagamento.

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

Enumeradores payment_type

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

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)
403	BIP000010	Forbidden	User is not allowed to do this action	Usuário não tem autorização para fazer essa ação
404	BIP000011	Not Found	The source account key was not found.	A chave da conta de origem não foi encontrada.
404	BIP000083	Not Found	Batch payment not found by batch payment key.	Lote de pagamentos não encontrado pela chave do lote.
400	BIP000085	Bad Request	Batch payment status is not pending approval.	Status do lote de pagamentos não é de aprovação pendente.