Utilização
Introdução
Na consulta de chave, o processo também ocorre em duas fases:
Fase 1: A instituição pagadora consulta a chave fornecida pelo usuário no DICT (Diretório de Identificadores de Contas Transacionais). Essa consulta retorna as informações da conta do beneficiário vinculada à chave.
Fase 2: Com a confirmação do usuário pagador, a instituição pagadora utiliza os dados obtidos na consulta para criar o pagamento no SPI.
Fluxo para Realização de cashout
:::highlight yellow 📌
Certifique-se de incluir o token de autenticação válido ao realizar as requisições. Para orientações sobre como obter o token e como utiliza-lo, consulte o arquivo de autenticação.
:::
Para realizar um cashout, é necessário consultar a chave Pix previamente e salvar o código 'paymentInitiationId'. Este código identifica a transação e é necessário para a realização do cashout.
Realizando consulta de chave pix
<Frame>
Realizando cashout
Parâmetros necessários
Parâmetro | Descrição |
---|---|
key * | Chave pix. |
value * | Valor para cashout, deve ser inserido em centavos. |
paymentInitiationId* | Id da transação, extraido da consulta da chave pix. |
banking_external_id* | ID da transação dentro do sistema integrado. Deve ser um id aleatório não utilizado anteriormente. |
Você pode acessá-la clicando aqui.
<Frame>
Padrões de resposta
A resposta de sucesso referente ao Saque retornará uma mensagem indicando que a transação foi enviada para processamento e o id da transação.
<Accordion title="Erro na consulta (400)">
Se o Id inserido não for referente a nenhuma transação, um status 400 com a mensagem da imagem será retornado.
![image.png](https://api.apidog.com/api/v1/projects/576186/resources/342668/image-preview)