Listar monedas FIAT

Este endpoint devuelve todas las monedas fiduciarias disponibles para su cuenta. Utilice esta ruta para consultar las monedas y construir la solicitud de creación de orden de retiro.

---

Endpoint

• Método: GET

URL del endpoint

https://api.xgateglobal.com/withdraw/company/currencies

---

Prueba de integración

Utilice el formulario a continuación para simular el listado de monedas FIAT.

Probar: Listar Monedas (Retiro)

1. Sus Credenciales

Correo electrónico

Contraseña

---

Solicitud

La solicitud no requiere cuerpo (body); solo encabezados de autenticación Headers.

Encabezados obligatorios

Encabezado	Valor	Descripción
Authorization	Bearer <tu_token>	El token JWT obtenido al iniciar sesión.

---

Respuestas

Éxito (200 OK)

Devuelve una lista (array) de objetos, donde cada objeto es una moneda.

[
  {
    "_id": "6728f0a2cb************",
    "name": "BRL",
    "type": "PIX",
    "createdDate": "2024-1************",
    "updatedDate": "2026-0************",
    "__v": 0,
    "symbol": "R$",
    "supplierFeeByActivity": {
      "xgatetreeal": {
        "type": "FIXED",
        "value": 0.0
      },
      "xgatetreealliquidity": {
        "type": "PERCENTAGE",
        "value": 0.00
      }
    }
  }
]

Errores comunes

Estado	Mensaje	Posible causa
401	Unauthorized	• Token inválido o vencido. • Encabezado inválido o faltante. • IP no permitida.
404	Not Found	Cliente no encontrado.
500	Internal Server Error	Error interno del servidor. Contacte con soporte.

---

Cómo usar

El propósito principal de listar las monedas FIAT es permitir seleccionar la moneda correcta al crear una orden de retiro (Withdraw Order).

La respuesta de este endpoint proporciona el objeto completo de la moneda, que es necesario para construir el payload de creación de la orden.

Flujo de integración

1. Listar las monedas: Llame a este endpoint (GET /withdraw/company/currencies).
2. Seleccionar: Identifique la moneda deseada en la lista (normalmente por name o symbol, por ejemplo, "BRL").
3. Enviar: Pase el objeto dentro de la propiedad currency en el payload de creación de la orden; los campos obligatorios se muestran en la documentación de crear retiro.

Ejemplo práctico

1. Lo que recibe al listar las monedas FIAT:

[
  {
    "_id": "6728f0a2cb************",
    "name": "BRL",
    "type": "PIX",
    "createdDate": "2024-1************",
    "updatedDate": "2026-0************",
    "__v": 0,
    "symbol": "R$",
    "supplierFeeByActivity": {
      "xgatetreeal": {
        "type": "FIXED",
        "value": 0.0
      },
      "xgatetreealliquidity": {
        "type": "PERCENTAGE",
        "value": 0.00
      }
    }
  }
]

2. Cómo debe enviarlo en el retiro (POST /withdraw):

Tomará el objeto anterior e lo insertará dentro de currency:

{
    "amount": 0.2,
    "customerId": "68e7b8****************",
    "currency": {
      "_id": "6728f0a2cb************",
      "name": "BRL",
      "type": "PIX",
      "createdDate": "2024-1************",
      "updatedDate": "2026-0************",
      "__v": 0,
      "symbol": "R$",
      "supplierFeeByActivity": {
        "xgatetreeal": {
          "type": "FIXED",
          "value": 0.0
        },
        "xgatetreealliquidity": {
          "type": "PERCENTAGE",
          "value": 0.00
        }
      }
    },
    "pixKey": {
        "key": "+5512************",
        "type": "PHONE",
        "_id": "68fa5d54004*************"
    }
}

Cada campo de este JSON se explica en la página de creación de orden de retiro.

---

Integración

Node.js

El 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 = "**********";

try {
  const url_api = "https://api.xgateglobal.com"
  const login = await axios.post(`${url_api}/auth/token`, { email, password });
  const { data } = await axios.get(`${url_api}/withdraw/company/currencies`, {
    headers: {
      "Authorization": `Bearer ${login.data.token}`
    }
  });
  console.log(data); // Respuesta
} catch (error) {
  console.log(error.response.data.message) // Error
}
})()