Utilização
Pix QRCode
Nos pagamentos iniciados por QR Code, o processo ocorre em duas fases:
Fase 1: O usuário pagador lê o QR Code de cobrança ou fornece o código copia e cola. A instituição pagadora decodifica essas informações para obter os dados da conta do beneficiário.
Fase 2: Com a confirmação do usuário pagador, a instituição pagadora usa os dados decodificados para criar o pagamento no SPI.
Os QRCodes gerados têm uma duração fixa de 84.000 segundos e são dinâmicos, permitindo que qualquer usuário faça o pagamento.
```mermaid sequenceDiagram Bankspace->>API Bankspace: 1. Decodifica a cobrança Pix QR Code API Bankspace->>SPI (Bacen): 2. Decodifica o QR Code no PSP recebedor SPI (Bacen)-->>API Bankspace: 3. Retorna os dados da cobrança API Bankspace-->>Bankspace: 4. Retorna os dados da cobrança QR Code ``` ```mermaid sequenceDiagram Bankspace->>API Bankspace: 1. Cria um cashout Pix API Bankspace-->>Cliente: 2. Retorna criação de cashout com sucesso API Bankspace->>SPI (Bacen): 3. Cria o cashout Pix no SPI pelo provedor direto SPI (Bacen)-->>API Bankspace: 4. Retorna status final da transação de forma assíncrona API Bankspace-->>Bankspace: 5. Envia webhook com status final da transação ```Dados da requisição:
Parametro | valor | Descrição |
---|---|---|
value * | 1000 | O valor da transação deve ser inserido em centavos. |
pix_key | +5543999999999 | A chave pix padrão já é carregada automaticamente no envio da requisição, portanto, não é necessário inserira-la manualmente. |
banking_external_id* | 12n3c4t56 | ID da transação dentro do sistema integrado. Deve ser um id aleatório não utilizado anteriormente. |
:::highlight purple 📌
Para a criação de QR Code é necessário possuir ao menos uma chave pix cadastrada na Bankspace.
:::
Ainda não possui uma chave pix padrão?
</Frame>
<Frame>
Fluxo para criar novo QR Code
:::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.
:::
:::highlight yellow 💡
Lembre-se de substituir os dados de exemplo. Os campos que devem ser inseridos manualmente estão destacados na imagem.
:::
Padrões de resposta
A resposta esperada ao enviar a requisição é um status de sucesso (200).
Na área destacada em vermelho, você pode visualizar uma prévia da resposta esperada da requisição.
Na área destacada em verde, você verá a resposta que será recebida após clicar no botão de enviar.
Se você está vendo esta mensagem, é provável que tenha se esquecido de inserir o token de autenticação na aba 'Auth' ou tenha inserido um token inválido ou expirado. Certifique-se de incluir o token de autenticação na aba 'Auth' ou fornecer um token válido.