Cash Out

💡

Escopo Necessário: baas.withdraw

Para poder utilizar este recurso, é necessário você realizar a geração de um par de chaves RSA e fazer o envio da chave privada na Dashboard.

Atenção: Este Endpoint usa chave de idempotência para prevenir a ocorrência de requisições duplicadas.

O que é uma Chave de Idempotência?

O mecanismo de Chave de idempotência visa garantir que uma operação seja executada uma única vez, independente da quantidade de requisições realizadas, ou seja, caso seja enviado a mesma chave de idempotência no header, a ação não será executada novamente, no entanto será retornado como sucesso pois ela já foi executada.

Para evitar duplicidade, recomendamos gerar um UUID baseado no seu payload e com algum identificador exclusivo da solicitação como id ou data por exemplo.

💡

Lembre-se: Cabe a você a geração e garantia de unicidade da chave.

Gerando o RSA

Para gerar o RSA, você precisa rodar os seguintes comandos via terminal.

📌

Para Gerar o RSA, é necessário possuir o OpenSSL instalado ou software similar.

Execute o seguinte comando no terminal para gerar a chave Privada:

Após gerar a chave privada, execute o comando abaixo para Gerar a chave Pública:

Agora que já temos as chaves RSA geradas, vamos fazer a criptofrafia do payload que conterá os dados da transferência.

Acesse nosso Tutorial de como Cadastrar a Chave Privada na Dashboard

Criptografias

Chave Privada

Chave Pública

Criptografando seu Payload

A chave que iremos usar para Criptografar o payload será a pública, e o resultado, será enviado no body para nós.

Para te ajudar, preparamos um exemplo de script em node.js que faz a criptografia, você pode adaptar para a sua linguagem de programação.

Código

Node.js

PixOut Payload

Agora que temos o payload criptografado, você passará os resultadosdo em cada campo correspondente no json.

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Respostas

🟢201PIX Out Criado

application/json

Caso receba este HTTP, siginifica que a solicitação de retirada foi criada, mas está pendente de aprovação pela adquirente ou time Tryplo e deverá ser processado em breve. Você será alertado no webhook da atualização do status.

Body

🟢202PIX Out em Processamento

🟢208Chave de Idempotência Já Utilizada

🟠403Idempotency-Key

🟠400Erro

curl --location -g --request POST 'https://api.tryplopay.com/baas/pix-out' \ --header 'Idempotency-Key: {{$string.uuid}}' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "aes": "FgRlihoWXZKjwjon7tVe/cKU3aABSJGtfOCszfHNW+d3yaxbNmlayqscevVpKzfDLQtC9sgtRWg6E6do+rnzmNnDHNloq56BbEHqWGhHJZOqLVx7SiRLxULKnVj3ydlNV2IqYH19L4QlzUw9hDL48MCU7Se9Lf5tubm4eXmgNToZmjhQS4CMGG17p4rszvMWuzGRmKqqFj2znyZRwQlrLoeu1G2mcNAXdXZtVAmShTq+bhGRO/T5Blc5Gr9axPJyu/MwzWvTCs0vhH/kkvimtOQ/ZvGEpkklISnKO4naKpmCAvp9BwF5TzgNLfMrYAcwUbg7j0Tapxofm+zH5jU+WQ==", "iv": "vYQdLgkj5/kwvJaKGf1bkQ==", "encrypted": "5SGsNB532iE3cpTAUncGJkj+qwik0eWPyBpDk4CwJ+3912/EjPmIr00kl18MeEOjMtZIi8jP1KKlZHgUIOsPOqD7Yauxu++SWD3Kc6kU/MA=" }'

O que é uma Chave de Idempotência?#

Gerando o RSA#

Criptografando seu Payload#

Requisição

Respostas

O que é uma Chave de Idempotência?

Gerando o RSA

Criptografando seu Payload