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

📌

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

Acesse a rota 'Consulta'

Você pode acessá-la clicando aqui.

Autenticação

Você precisará de um token para a autenticação. Saiba como aqui.

Preenchendo dados

Após inserir o token retorne a aba 'Params', preencha o campo com a chave pix a ser consultada e envie.

Resposta

Na resposta da chave pix o primeiro item em 'pix_key' retornado será o 'paymentInitiationId', este é o id da transação que será utilizado na requisição de cashout.

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.

Lembre-se de incluir o token de autenticação

Acesse a rota 'Realizar Cashout'

Você pode acessá-la clicando aqui.

Preenchendo os campos

Preencha os campos seguindo as intruções da tabela de parâmetros necessários para Cashout.

Padrões de resposta

✔️ Sucesso (200)

Erro na consulta (400)

Não autorizado (401)

Introdução#

Fluxo para Realização de cashout#

Realizando consulta de chave pix#

Realizando cashout#