Confirmar agendamento em lote de fatura de recolhimento

Este endpoint permite validar o token de autenticação de dois fatores (2FA) de um lote de agendamento de faturas de recolhimento em batch_payment_schedule_status pending_2fa_approval.

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/payment/schedule_collection_slip/BATCH_PAYMENT_SCHEDULE_KEY/validate_token

MÉTODO

PATCH

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 Body: Validação de token do lote de agendamento

{
  "token": "329adf"
}

Body Params

Campo	Tipo	Descrição	Caracteres
`token`	string	Código de autenticação enviado ao aprovador de movimentações da conta	6

Response

Success Response

STATUS

200

Response Body: Lote de agendamento confirmado

{
  "batch_payment_schedule_key": "33860ad0-bcb0-47b7-bbe7-c7e3ec2fc61a",
  "request_control_key": "ae4508df-f2cb-4e28-9f04-a19b7f2758c9",
  "account_key": "daae79e6-ee8b-449f-aa1e-96959d5d5a72",
  "total_amount": 1939.31,
  "batch_payment_schedule_status": "scheduled",
  "payment_type": "collection_slip"
}

Response Body Params

Campo	Tipo	Descrição
`batch_payment_schedule_key` *	uuid4	Chave única de identificação do agendamento em lote.
`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 de agendamento após a validação do token.
`payment_type` *	string	Tipo do pagamento; para este fluxo, espera-se `collection_slip`.

Enumeradores batch_payment_schedule_status

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

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.
400	BIP000058	Bad Request	Error while validating verification token	Erro ao validar token de verificação
400	BIP000059	Bad Request	Number of verification token validation attempts exceeded.	Número de tentativas de validação de token de verificação excedido.
400	BIP000060	Bad Request	Verification token expired.	Token de verificação expirado.
400	BIP000061	Bad Request	Verification token validation failed.	Falha na validação do token de verificação.
400	BIP000065	Bad Request	Payment verification time window exceeded.	Janela de tempo de verificação de pagamento excedida.
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.
400	BIP000086	Bad Request	A token is required for SMS or email validation.	Um token é necessário para validação via SMS ou email.

Request​

Request Endpoint​

Request Path Params​

Body Params​

Response​

Success Response​

Response Body Params​

Enumeradores batch_payment_schedule_status​

Error Response​