v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
Pagamentos - Cliente

Pagamento - Confirmar

Pré-requisitos:
Uma solicitação de pagamento iniciada em algum dos seguintes procedimentos:

  • Iniciação de pagamento por chave
  • Iniciação de pagamento por qrcode
  • Iniciação de pagamento manual

Características:

  • Realiza a validação dos dados do recebedor do pagamento.
  • Parametriza o valor à ser pago.
  • Solicita o pagamento para o contraparte através de uma solicitação.
  • Os dados do pagamento realizado podem ser consultados em Pagamento - Consulta por PagamentoId
  • Ao ser debitado dispara um webhook sob o evento "Pagamento" com o EndToEndId retornado na iniciação de pagamento. Veja Configurando webhook de pagamentos

Atenção!

Uma confirmação de pagamento significa que a sua intenção de realizar o pagamento foi encaminhada ao BACEN.
Qualquer solicitação de pagamento esta sujeita a cancelamento ou rejeição, cenário no qual o débito na conta não é realizado.

post/pix/direto/forintegration/v1/pagamentos/{pagamentoId}/confirmacao

Path parameters

pagamentoIdstring uuid required

Identificador do pagamento gerado em uma das iniciaçãoes.

Identificador do pagamento gerado em uma das iniciaçãoes.

Request body

valornumber double required

Valor do pagamento. Para pagamentos de qrcodes dinâmicos o valor na confirmação deve conferir com o retornado na iniciação do pagamento.

campoLivrestring nullable
efetuarEmstring date-time nullable

Data em que o pagamento será efetuado

Response

O pagamento foi confirmado com sucesso e o valor já foi bloqueado na conta do cliente pagador.