v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB

Pagamentos - Cliente

Pagamento - Iniciar - QrCodes

Pré-requisitos:
Um qrcode gerado que não seja da sua própria conta.

Características:

Realiza a validação das propriedades do qrcode.
Inicia o procedimento de pagamento.
Para completar o pagamento é necessário que você realize a confirmação dele em Pagamento - Confirmar.
Permite informar o pagamentoId para utilização como identificador externo e se informado, caso o pagamentoId já tenha sido utilizado, não inicia um novo pagamento devolvendo uma resposta idempotente.

post/pix/direto/forintegration/v1/pagamentos/qrcodes

Request body

qrCodestring required

É o preenchido com os dados obtidos através da leitura do qrcode ou também conhecido como código "Copia e Cola".

pagamentoIdstring nullable

Identificador do pagamento. Se informado e já utilizado em outra transação, a resposta será uma idempotência. Se único, o fluxo assincrono tentará iniciar o pagamento com o pagamentoId informado.

Response

Iniciação realizada com sucesso.

observacaostring nullable

Campo destinado a comentários e observações sobre o pagamento iniciado. Caso a resposta seja idempotente, este campo exibirá a mensagem 'Resposta idempotente', indicando que a requisição já foi processada anteriormente.

pagamentoIdstring uuid

Identificador único do pagamento

endToEndIdstring nullable

EndToEndIdentification que transita na PACS002, PACS004 e PACS008

valornumber double nullable

Valor do Pix

tipo'Estatico' | 'Dinamico'

campoLivrestring nullable

txIdstring nullable

Identificador da transação