Pular para o conteúdo principal

Cotação Crypto para FIAT

Este endpoint permite calcular antecipadamente quanto o cliente receberá em FIAT ao sacar um valor específico em Crypto.


Endpoint​

  • Método: POST
URL do Endpoint
https://api.xgateglobal.com/withdraw/conversion/brl/pix

Testar Integração​

Utilize o formulário abaixo para simular a cotação. O sistema irá buscar automaticamente os dados da criptomoeda e calcular quanto renderia em FIAT.

💱

Testar: Cotação para Conversão

1. Suas Credenciais

2. Dados da Simulação

Requisição​

É necessário enviar o Header de autenticação e o corpo JSON com o valor e o objeto da moeda.

Headers Obrigatórios​

HeaderValorDescrição
AuthorizationBearer <seu_token>O token JWT obtido no login.

Body (Corpo da Requisição)​

CampoTipoObrigatórioDescrição
amountnumberSimValor em Crypto que se deseja calcular a cotação.
cryptocurrencyobjectSimO objeto da criptomoeda, obtido na rota de listagem de criptomoedas para saques.

Respostas (Responses)​

Sucesso (200 OK)​

Retorna o valor convertido, a moeda e a taxa de câmbio utilizada no momento.

{
"amount": 5.17,
"currency": "R$",
"cryptoToFiatExchangeRate": "R$ 5.170"
}

Erros Comuns​

StatusMensagemMotivo Provável
401Unauthorized• Token inválido ou expirado.
• Header inválido ou não informado.
• IP não permitido.
500Internal Server ErrorErro interno de servidor. Entrar em contato com suporte.

Como usar​

Esta rota não gera um pedido de pagamento, ela serve apenas para consulta.

O Fluxo Recomendado (UX)​

  1. Input: O usuário digita "1" (valor em Crypto) no seu app/site.
  2. Consulta: Seu sistema chama POST /withdraw/conversion/brl/pix enviando o valor 1 Crypto e o objeto da criptomoeda.
  3. Exibição: A API retorna que isso equivale a 5.17. Você exibe: "Você receberá aproximadamente R$ 5,17".
  4. Ação: Se o usuário concordar, você chama a rota de Criar Pedido de Saque Conversão Crypto para FIAT (POST /withdraw).

Exemplo Prático​

Siga os passos abaixo para realizar a cotação Crypto para FIAT.

1. Passo: Insira o valor da criptomoeda para a cotação:

{
"amount": 1,
"cryptocurrency": {
"_id": "6733a2a9******************",
"name": "USDT",
"symbol": "USDT",
"coinGecko": "tether",
"updatedDate": "202******************",
"createdDate": "202******************",
"__v": 0
}
}

2. Passo: Você deve buscar e injetar o objeto da criptomoeda dentro de cryptocurrency:

{
"amount": 1,
"cryptocurrency": {
"_id": "6733a2a9******************",
"name": "USDT",
"symbol": "USDT",
"coinGecko": "tether",
"updatedDate": "202******************",
"createdDate": "202******************",
"__v": 0
}
}

Você pode obter a lista de criptomoedas clicando aqui.


Integração​

O exemplo de integração utiliza a biblioteca Axios em Node.js.

Instalando Axios:

npm install axios

Exemplo Javascript:

const axios = require("axios");

(async () => {
const email = "your_email@domain.com";
const password = "**********";
const amount = 10.90;

try {
const url_api = "https://api.xgateglobal.com"
const login = await axios.post(`${url_api}/auth/token`, { email, password });
const cryptocurrencies = await axios.get(`${url_api}/withdraw/company/cryptocurrencies`, {
headers: {
"Authorization": `Bearer ${login.data.token}`
}
});
const { data } = await axios.post(`${url_api}/withdraw/conversion/brl/pix`, {
amount,
cryptocurrency: cryptocurrencies.data[0]
}, {
headers: {
"Authorization": `Bearer ${login.data.token}`
}
});
console.log(data); // Response
} catch (error) {
console.log(error.response.data.message) // Error
}
})()