Listar Moedas

Este endpoint retorna todas as moédas fiduciárias disponíveis para a sua conta. Use esta rota para consultar e criar a requisição para pedido de saque.

---

Endpoint

• Método: GET

URL do Endpoint

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

---

Testar Integração

Utilize o formulário abaixo para simular a listagem de moedas fiduciárias.

Testar: Listar Moedas (Saque)

1. Suas Credenciais

Email

Senha

---

Requisição

A requisição não requer corpo (body), apenas os Headers de autenticação.

Headers Obrigatórios

Header	Valor	Descrição
Authorization	Bearer <seu_token>	O token JWT obtido no login.

---

Respostas (Responses)

Sucesso (200 OK)

Retorna uma lista (array) de objetos, onde cada objeto é uma moeda cadastrada.

[
  {
    "_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
      }
    }
  }
]

Erros Comuns

Status	Mensagem	Motivo Provável
401	Unauthorized	• Token inválido ou expirado. • Header inválido ou não informado. • IP não permitido.
404	Not Found	Cliente não encontrado.
500	Internal Server Error	Erro interno de servidor. Entrar em contato com suporte.

---

Como usar

A principal finalidade de listar as moedas fiduciárias é permitir a seleção da moeda correta para criar um pedido de saque (Withdraw Order).

A resposta deste endpoint fornece o Objeto Completo da moeda, que é obrigatório na construção do payload de criação do pedido.

O Fluxo de Integração

1. Liste as moedas: Chame este endpoint (GET /withdraw/company/currencies).
2. Seleção: Identifique a moeda desejada na lista (geralmente filtrando pelo name ou symbol, ex: "BRL").
3. Envio: Você deve passar o objeto dentro da propriedade currency no payload de criação do pedido, na documentação de criação de saque é mostrado os valores obrigatórios.

Exemplo Prático

1. O que você recebe ao listar as moedas fiduciárias:

[
  {
    "_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. Como você deve enviar no saque (POST /withdraw):

Você vai pegar o objeto acima e injetá-lo 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 informação desse JSON será explicado na página de criar pedido de saque.

---

Integração

Node.js

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

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); // Response
} catch (error) {
    console.log(error.response.data.message) // Error
}
})()