Confirmação do pagamento

Após o título ter sido validado com sucesso, o parceiro deverá utilizar este endpoint para confirmar o pagamento . Somente após a confirmação, o pagamento será efetivado.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

O parceiro possua o ID de pagamento gerado na validação do título;
O cliente possua uma conta e cadastro ativos pra que seja possível debitar o saldo do pagamento.

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Payments/confirm

--request POST 'https://sandbox.hiperbanco.com.br/Payments/confirm' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
  "id": "b985967b-a0ed-4810-addd-ec100b128171",
  "bankBranch": "0001",
  "bankAccount": "1104835921",
  "amount": 200,
  "description": "Exemplo de Pagamento de Contas"
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie o seguintes campo em formato JSON:

Nome	Tipo	Descrição
`id`	`string`	Obrigatório. Código ID gerado na etapa de validação.
`bankBranch`	`string`	Obrigatório. Número da agência do banco do pagador.
`bankAccount`	`string`	Obrigatório. Número da conta do pagador.
`amount`	`number`	Obrigatório. Valor a ser pago.
`description`	`string`	Descrição do pagamento.

{
  "id": "b985967b-a0ed-4810-addd-ec100b128171",
  "bankBranch": "0001",
  "bankAccount": "1104835921",
  "amount": 200.00,
  "description": "Exemplo de Pagamento de Contas"
}

Resposta (Response)

Nome	Tipo	Descrição
`authenticationCode`	`string`	Id de confirmação da transação que será utilizado para realizar consultas sobre o pagamento.
`settleDate`	`string`	Data em que o pagamento será liquidado, no formato ISO 8601 - UTC. Caso a data de vencimento coincida com feriados ou finais de semana, esse campo informará a data do próximo dia útil.
`transactionId`	`string`	Id da transação.

{
    "authenticationCode": "37fb18db-21c9-4adb-b6e2-3b63d273ea1c",
    "settleDate": "2025-08-22T00:00:00",
    "transactionId": "ecc3a74c-a25a-4f65-8449-5f850f90bf9d"
}

Após o envio da requisição de confirmação (status Created), e caso não haja nenhum impedimento, o pagamento é confirmado (status Completed), e o valor é retirado da conta do pagador.

Isso geralmente acontece instantaneamente, porém, a compensação do título poderá ocorrer em até três dias úteis.

📘
Nota
Em caso de intermitência, e consequente atraso na confirmação do pagamento em mais de 30 minutos, o dinheiro do pagador é estornado para sua conta e a transação é cancelada (status Canceled).

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Código	Nome	Tipo	Descrição
`400`	`ASSIGNOR_NOT_AUTHORIZED`	`Non authorized assignor, payment was not completed`	Comerciante não autorizado. O pagamento não foi efetivado.
`400`	`PAYMENT_AMOUNT_GREATER_THAT_MAX_ALLOWED_AMOUNT`	`Amount to be paid is above the maximum allowed amount`	O valor do pagamento informado é maior do que o permitido.
`400`	`PAYMENT_AMOUNT_LOWER_THAT_MIN_ALLOWED_AMOUNT`	`Amount to be paid is bellow the min allowed amount`	O valor informado é inferior ao mínimo permitido. Consulte o campo minAmount retornado no endpoint de validação do título.
`400`	`QUERY_ID_ALREADY_UTILIZED`	`Query protocol ID already utilized by another payment`	O ID informado já foi utilizado anteriormente.
`400`	`INVALID_BAR_CODE_BY_QUERY_ID`	`Bar Code is incorrect for the query protocolId informed`	Código de barras inválido.
`400`	`AMOUNT_NOT_ALLOWED`	`Payment amount not allowed`	O valor informado no campo amount é inválido.
`400`	`PAYMENT_ALREADY_PERFORMED`	`Payment already performed`	O pagamento já foi realizado.
`400`	`CASHOUT_LIMIT_NOT_ENOUGH`	`Sender does not have sufficient cash out limit`	A transação excede o limite de valor da transferência.
`400`	`OPERATIONAL_ERROR`	`There is no resource available to perform a transaction at this time.`	Não há recurso disponível para realizar a transação no momento.
`400`	`OPERATION_NOT_COMPLETED`	`Operation not completed. Try Again`	A operação não foi completada. Tente novamente em alguns minutos.
`400`	`AMOUNT_BELLOW_MIN_ALLOWED`	`Payment amount bellow min allowed`	O valor informado é inferior ao mínimo permitido. Consulte o campo minAmount retornado no endpoint de validação do título.
`400`	`AMOUNT_ABOVE_MAX_ALLOWED`	`Payment amount above max allowed`	O valor informado é superior ao máximo permitido. Consulte o campo maxAmount retornado no endpoint de validação do título.
`400`	`PAYMENT_CONFIRMATION_ALREADY_IN_PROCESS`	`A confirmation is already being processed for the payment in question.`	A confirmação desse pagamento já está está sendo processada.
`400`	`PAYMENT_VALUE_EXCEEDED`	`Exceeded the maximum value`	Este boleto supera o valor máximo que pode ser pago, sendo R$249.999,99 para fichas de compensação e R$950.000,00 para concessionárias, tributos e convênios.
`400`	`PAYMENT_AMOUNT_CANNOT_BE_CHANGED`	`Payment amount cannot be changed`	O valor do pagamento não pode ser alterado.
`404`	`QUERY_ID_NOT_FOUND`	`Query protocol ID not not found in the current date`	Id não encontrado. É possível que a consulta tenha sido realizada no mesmo dia da criação do pagamento.
`404`	`TRANSACTION_NOT_FOUND`	`Transaction not found`	Código de barras ou linha digitável é inválida.
`404`	`NOT_FOUND`	`Bill Payment transaction not found for supplied Id`	Boleto não encontrado.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. O evento é:

Evento	Descrição
`BILL_PAYMENT_WAS_CONFIRMED`	Pagamento confirmado.