Cotización de Cripto a FIAT
Este endpoint le permite calcular con anticipación cuánto recibirá el cliente en moneda fiduciaria al retirar un monto específico en criptomonedas.
Endpoint
- Método: POST
https://api.xgateglobal.com/withdraw/conversion/brl/pix
Prueba de integración
Utilice el formulario a continuación para simular la cotización. El sistema obtendrá automáticamente los datos de la criptomoneda y calculará cuánto produciría en moneda fiduciaria.
Probar: Cotización para Conversión
Solicitud
Debe enviar el encabezado de autenticación y el cuerpo JSON con el valor y el objeto de moneda.
Encabezados obligatorios
| Encabezado | Valor | Descripción |
|---|---|---|
Authorization | Bearer <tu_token> | El token JWT obtenido al iniciar sesión. |
Cuerpo (Request Body)
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
amount | number | Sí | Monto en criptomonedas para el que desea calcular la cotización. |
cryptocurrency | object | Sí | El objeto de la criptomoneda, obtenido desde la ruta de listado de criptomonedas. |
Respuestas
Éxito (200 OK)
Devuelve el valor convertido, la moneda y la tasa de cambio utilizada en ese momento.
{
"amount": 5.17,
"currency": "R$",
"cryptoToFiatExchangeRate": "R$ 5.170"
}
Errores comunes
| Estado | Mensaje | Posible causa |
|---|---|---|
| 401 | Unauthorized | • Token inválido o vencido. • Encabezado inválido o faltante. • IP no permitida. |
| 500 | Internal Server Error | Error interno del servidor. Contacte con soporte. |
Cómo usar
Esta ruta no genera una orden de pago; solo sirve para consulta.
Flujo recomendado (UX)
- Entrada: El usuario escribe "1" (monto en criptomonedas) en su aplicación o sitio.
- Consulta: Su sistema llama a
POST /withdraw/conversion/brl/pixenviando el valor 1 en criptomonedas y el objeto de la criptomoneda. - Visualización: La API devuelve que esto equivale a
5.17. Usted muestra: "Recibirá aproximadamente R$ 5.17". - Acción: Si el usuario está de acuerdo, llama a la ruta Crear orden de retiro por conversión de Cripto a FIAT (
POST /withdraw).
Ejemplo práctico
Siga los pasos a continuación para realizar la cotización de Cripto a FIAT.
Paso 1: Ingrese la cantidad en criptomonedas para la cotización:
{
"amount": 1,
"cryptocurrency": {
"_id": "6733a2a9******************",
"name": "USDT",
"symbol": "USDT",
"coinGecko": "tether",
"updatedDate": "202******************",
"createdDate": "202******************",
"__v": 0
}
}
Paso 2: Debe obtener e inyectar el objeto de la criptomoneda dentro de cryptocurrency:
{
"amount": 1,
"cryptocurrency": {
"_id": "6733a2a9******************",
"name": "USDT",
"symbol": "USDT",
"coinGecko": "tether",
"updatedDate": "202******************",
"createdDate": "202******************",
"__v": 0
}
}
Puede obtener la lista de criptomonedas haciendo clic aquí.
Integración
- Node.js
Este ejemplo de integración utiliza la librería Axios en Node.js.
Instalando Axios:
npm install axios
Ejemplo en 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); // Respuesta
} catch (error) {
console.log(error.response.data.message) // Error
}
})()