Listar Criptomoedas

Este endpoint retorna todas as criptomoedas disponíveis para a sua conta. Use esta rota para consultar os dados necessários para criar requisições de pedido de depósito.

---

Endpoint

• Método: GET

URL do Endpoint

https://api.xgateglobal.com/deposit/company/cryptocurrencies

---

Testar Integração

Utilize o formulário abaixo para simular a listagem de criptomoedas.

🪙

Testar: Listar Criptomoedas de Depósito

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 criptomoeda.

[
  {
    "_id": "67339b18ca5**************",
    "name": "USDT",
    "symbol": "USDT",
    "coinGecko": "tether",
    "updatedDate": "2024-1**************",
    "createdDate": "2024-1**************",
    "__v": 0,
    "uid": "01KH7K88H**************"
  },
  {
    "_id": "67339b2bca5**************",
    "name": "USDC",
    "symbol": "USDC",
    "coinGecko": "usdc",
    "updatedDate": "2024-1**************",
    "createdDate": "2024-1**************",
    "__v": 0,
    "uid": "01KH7K4C0BZ**************"
  }
]

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.
500	Internal Server Error	Erro interno de servidor. Entrar em contato com suporte.

---

Como usar

A principal finalidade de listar as criptomoedas é permitir a seleção da criptomoeda correta para criar um pedido de depósito (Deposit Order).

A resposta deste endpoint fornece o Objeto Completo da criptomoeda, permitindo a construção do payload de criação do pedido.

O Fluxo de Integração

1. Liste as moedas: Chame este endpoint (GET /deposit/company/cryptocurrencies).
2. Seleção: Identifique a criptomoeda desejada na lista (geralmente filtrando pelo name ou symbol, ex: "USDT").
3. Envio: Você deve passar o objeto dentro da propriedade cryptocurrency no payload de criação do pedido. Na documentação de criação de depósito crypto são mostrados os valores obrigatórios.

Exemplo Prático

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

[
  {
    "_id": "67339b18ca5**************",
    "name": "USDT",
    "symbol": "USDT",
    "coinGecko": "tether",
    "updatedDate": "2024-1**************",
    "createdDate": "2024-1**************",
    "__v": 0,
    "uid": "01KH7K88H**************"
  },
  {
    "_id": "67339b2bca5**************",
    "name": "USDC",
    "symbol": "USDC",
    "coinGecko": "usdc",
    "updatedDate": "2024-1**************",
    "createdDate": "2024-1**************",
    "__v": 0,
    "uid": "01KH7K4C0BZ**************"
  }
]

2. Como você deve enviar no depósito (POST /deposit):

Você vai pegar o objeto acima e injetá-lo dentro de cryptocurrency:

{
  "amount": 2,
  "customerId": "672f40**************",
  "currency": {
    "_id": "6728f0a2cb************",
    "name": "BRL",
    "type": "PIX",
    "createdDate": "2024-1************",
    "updatedDate": "2026-0************",
    "__v": 0,
    "symbol": "R$"
  },
  "cryptocurrency": {
    "_id": "67339b2bca5**************",
    "name": "USDC",
    "symbol": "USDC",
    "coinGecko": "usdc",
    "updatedDate": "2024-1**************",
    "createdDate": "2024-1**************",
    "__v": 0,
    "uid": "01KH7K4C0BZ**************"
  },
  "externalId": "67ce09d**************"
}

Cada informação desse JSON será explicado na página de criar pedido de depósito crypto.

---

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}/deposit/company/cryptocurrencies`, {
        headers: {
            "Authorization": `Bearer ${login.data.token}`
        }
    });
    console.log(data); // Response
} catch (error) {
    console.log(error.response.data.message) // Error
}
})()