Download the PHP package xgate/xgate-integration without Composer

XGATE

O que a XGate?

Uma solução moderna para pagamentos e conversões financeiras. Uma plataforma robusta para transações PIX e Cripto, perfeita para otimizar operações financeiras.

• Processamento instantâneo via PIX.
• Conversão automática de moeda FIAT para cripto.
• Depósitos e saques em Bitcoin, Ethereum, SHIBA INU, USDT, USDC, BNB e MATIC.
• Monitoramento em tempo real via dashboard avançado.

Instalação

Manual

Iniciar integração:

Crie um instância da classe Xgate para ter acesso aos métodos.

Errors:

👉 DEPÓSITO usando moeda fiduciária:

• PARÂMETRO 1: Valor de depósito

• PARÂMETRO 2: Informações do cliente ou ID do cliente que já existe	parâmetro	Obrigatório	Tipo	Descrição
  name	SIM	String	Nome do cliente
  phone	NÃO	String	Telefone do cliente
  email	NÃO	String	E-mail do cliente
  document	SIM	String	Algum documento do cliete, ex: CPF

• PARÂMETRO 3: Tipo de transação

Resposta:

👉 DEPÓSITO convertendo moeda fiduciária para cripto moeda:

• PARÂMETRO 1: Valor de depósito

• PARÂMETRO 2: Informações do cliente ou ID do cliente que já existe	parâmetro	Obrigatório	Tipo	Descrição
  name	SIM	String	Nome do cliente
  phone	NÃO	String	Telefone do cliente
  email	NÃO	String	E-mail do cliente
  document	SIM	String	Algum documento do cliete, ex: CPF

• PARÂMETRO 3: Tipo de transação
• PARÂMETRO 3: Para qual cripto moeda quer converter

Resposta:

👉 DEPÓSITO de cripto moeda (Gerar uma carteira)

• PARÂMETRO 1: Informações do cliente ou ID do cliente que já existe	parâmetro	Obrigatório	Tipo	Descrição
  name	SIM	String	Nome do cliente
  phone	NÃO	String	Telefone do cliente
  email	NÃO	String	E-mail do cliente
  document	SIM	String	Algum documento do cliete, ex: CPF

Resposta:

OBSERVAÇÃO: Não é gerado uma solicitação de depósito para cripto moeda, apenas a carteira onde o cliente pode transferir o valor que ele desejar.

👉 DEPÓSITO de cripto moeda convertendo para moeda fiduciária

❌ Não temos essa opção disponível no momento.

👉 SAQUE usando moeda fiduciária:

• PARÂMETRO 1: Valor de saque

• PARÂMETRO 2: Informações do cliente ou ID do cliente que já existe	parâmetro	Obrigatório	Tipo	Descrição
  name	SIM	String	Nome do cliente
  phone	NÃO	String	Telefone do cliente
  email	NÃO	String	E-mail do cliente
  document	SIM	String	Algum documento do cliete, ex: CPF

• PARÂMETRO 3: Tipo de transação

• PARÂMETRO 4: Informações da chave pix	parâmetro	Obrigatório	Tipo	Descrição
  key	SIM	String	Chave pix
  type	SIM	String	Tipo da chave, opções: PHONE, CPF, CNPJ, EMAIL, RANDOM

Resposta:

👉 SAQUE convertendo cripto moeda para moeda fiduciária:

• PARÂMETRO 1: Valor de saque

• PARÂMETRO 2: Informações do cliente ou ID do cliente que já existe	parâmetro	Obrigatório	Tipo	Descrição
  name	SIM	String	Nome do cliente
  phone	NÃO	String	Telefone do cliente
  email	NÃO	String	E-mail do cliente
  document	SIM	String	Algum documento do cliete, ex: CPF

• PARÂMETRO 3: Cripto moeda
• PARÂMETRO 4: Para qual forma de pagamento você quer receber (Converter)

• PARÂMETRO 5: Informações da chave pix	parâmetro	Obrigatório	Tipo	Descrição
  key	SIM	String	Chave pix
  type	SIM	String	Tipo da chave, opções: PHONE, CPF, CNPJ, EMAIL, RANDOM

Resposta:

👉 SAQUE para carteira externa:

• PARÂMETRO 1: Valor de saque

• PARÂMETRO 2: Informações do cliente ou ID do cliente que já existe	parâmetro	Obrigatório	Tipo	Descrição
  name	SIM	String	Nome do cliente
  phone	NÃO	String	Telefone do cliente
  email	NÃO	String	E-mail do cliente
  document	SIM	String	Algum documento do cliete, ex: CPF

• PARÂMETRO 3: Rede blockchain
• PARÂMETRO 4: Cripto moeda
• PARÂMETRO 5: Chave pública da carteira que vai receber a transferência

Resposta:

👉 SAQUE convertendo moeda fiduciária para cripto moeda

❌ Não temos essa opção disponível no momento.

👉 BUSCAR lista de moedas fiduciária disponíveis para depósito

Resposta:

👉 BUSCAR lista de moedas fiduciária disponíveis para saques

Resposta:

👉 BUSCAR lista de cripto moedas disponíveis para depósito

Resposta:

👉 BUSCAR lista de cripto moedas disponíveis para saque

Resposta:

👉 BUSCAR redes blockchain disponíveis para depósito e suas cripto moedas suportadas

Resposta:

👉 BUSCAR redes blockchain disponíveis para saque e suas cripto moedas suportadas

Resposta:

👉 COTAÇÃO de depósito convertendo moeda fiduciária para cripto moeda

• PARÂMETRO 1: Valor de depósito
• PARÂMETRO 3: Tipo de transação
• PARÂMETRO 3: Para qual cripto moeda quer converter

Resposta:

👉 COTAÇÃO de depósito convertendo cripto moeda para moeda fiduciária

❌ Não temos essa opção disponível no momento.

👉 COTAÇÃO de saque convertendo cripto moeda para moeda fiduciária

• PARÂMETRO 1: Valor de saque
• PARÂMETRO 3: Cripto moeda
• PARÂMETRO 3: Para qual forma de pagamento você quer receber (Converter)

Resposta:

👉 COTAÇÃO de saque convertendo moeda fiduciária para cripto moeda

❌ Não temos essa opção disponível no momento.

👉 COTAÇÃO de saque para um carteira de cripto moeda externa

• PARÂMETRO 1: Valor de saque
• PARÂMETRO 3: Rede blockchain
• PARÂMETRO 3: Cripto moeda (A rede blockchain precisa suportar essa cripto moeda)

Resposta:

👉 CLIENTE: Criar um cliente

• PARÂMETRO 1: Informações do cliente	parâmetro	Obrigatório	Tipo	Descrição
  name	SIM	String	Nome do cliente
  phone	NÃO	String	Telefone do cliente
  email	NÃO	String	E-mail do cliente
  document	SIM	String	Algum documento do cliete, ex: CPF

Resposta:

👉 CLIENTE: Atualizar informações do cliente

• PARÂMETRO 1: ID do cliente existente

• PARÂMETRO 2: Informações do cliente	parâmetro	Obrigatório	Tipo	Descrição
  name	SIM	String	Nome do cliente
  phone	NÃO	String	Telefone do cliente
  email	NÃO	String	E-mail do cliente
  document	SIM	String	Algum documento do cliete, ex: CPF

Resposta:

👉 PIX: Criar uma chave pix para um clientes

• PARÂMETRO 1: Informações do cliente ou ID do cliente existente	parâmetro	Obrigatório	Tipo	Descrição
  name	SIM	String	Nome do cliente
  phone	NÃO	String	Telefone do cliente
  email	NÃO	String	E-mail do cliente
  document	SIM	String	Algum documento do cliete, ex: CPF

• PARÂMETRO 2: Informações da chave pix do cliente	parâmetro	Obrigatório	Tipo	Descrição
  key	SIM	String	Nome do cliente
  type	SIM	String	Tipo da chave, opções: PHONE, CPF, CNPJ, EMAIL, RANDOM

Resposta:

👉 PIX: Buscar todas as chaves pix de um cliente

• PARÂMETRO 1: Informações do cliente ou ID do cliente existente	parâmetro	Obrigatório	Tipo	Descrição
  name	SIM	String	Nome do cliente
  phone	NÃO	String	Telefone do cliente
  email	NÃO	String	E-mail do cliente
  document	SIM	String	Algum documento do cliete, ex: CPF

Resposta:

👉 PIX: Deletar uma chave pix do cliente

• PARÂMETRO 1: ID do cliente
• PARÂMETRO 2: ID da chave pix do cliente

Resposta:

👉 EMPRESA: Buscar saldo da empresa

Busca todas as moedas fiduciárias e cripto moedas

Resposta:

Busca uma moeda fiduciária específica

• PARÂMETRO 1: ID da moeda fiduciária

Resposta:

OBSERVAÇÃO: Pode ser o ID tanto da moeda fiduciária de saque como a de depósito

Busca uma cripto moeda específica

• PARÂMETRO 1: ID da cripto moeda

Resposta:

OBSERVAÇÃO: Pode ser o ID tanto da cripto moeda de saque como a de depósito

👉 SUB EMPRESA: Criar sub empresa

OBSERVAÇÃO: Um objecto único com os seguites parâmetros:

• PARÂMETRO 1: user: Informações do primeiro usuário (ADMIN) da sub conta

  • name:	OBRIGATÓRIO	String	Nome do usuário

  • email:	OBRIGATÓRIO	String	E-mail do usuário

  • password:	OBRIGATÓRIO	String	Senha do usuário

  • phone:	OBRIGATÓRIO	String	Object com inforções do telefone do usuário

  • type:	OBRIGATÓRIO	String	Tipo do número. Opções: mobile

  • number:	OBRIGATÓRIO	String	Número de telefon

  • areaCode:	OBRIGATÓRIO	String	Código do estado

  • countryCode:	OBRIGATÓRIO	String	Código do país

• PARÂMETRO 2 e 3: deposit e withdraw: Informações de taxas de depósito e saque Tanto no deposit como no withdraw tem os parâmetros currencies, cryptocurrencies e blockchainNetworks.

  • currencies: Moedas fiduciárias
  • cryptocurrencies: Cripto moedas
  • blockchainNetworks: Redes blockchains

  E cada uma delas tem a opção de mandar um object { type: "PERCENTAGE", value: 1, }, isso significa que toda a categoria terão o mesmo valor de taxa. Exemplo:

  OBSERVAÇÃO: A palavra 'categoria' pode-se se entender que é currencies, cryptocurrencies e blockchainNetworks

  Isso significa que todas as moedas fiduciárias de saque terão uma taxa de 1%, isso server para todos. Agora se você quiser definir uma porcentagem para cada moeda fiduciárias diferente, você precisa buscar a listagem de todas as moedas (Isso serve tembém para as outras categorias). Exemplo:

  Cenário hipotético: Adicionando um valor de dinâmico para cada cripto moeda de depósito

  Sempre que usar essa opção, adicione um object com dois parâmetros, o 1°: o nome da categoria no singular e o 2°: fee, onde será adicionado um object com os dois parâmetros, type = Tipo de taxa e value = Valor da taxa. No primeiro parâmetro você pode adicionar tanto o ID da moeda como o object completo.

  Na "vida real", você pode criar um painel visual para adicionar essas taxas diferentes ou apenas criar um object fixo definindo a taxa de cada categoria e moedas.

Resposta:

👉 SUB EMPRESA: Adicionar o primeiro IP da sub empresa

⚠️ Essa rota adiciona o primeiro IP da sub empresa, caso tente adicionar um segundo IP, retornará um error.

Primeiro é criado um nova instância da classe Xgate e é passada as informações de acesso da sub conta. OBSERVAÇÃO: Todos os métodos chamados nessa intância, afetará a sub empresa e não a empresa principal.

• PARÂMETRO 1: IP, Aceitas IPV4 e IPV6

Resposta:

👉 SUB EMPRESA: Adicionar o primeiro Webhook da sub empresa

⚠️ Essa rota adiciona a primeira rota de Webhook da sub empresa, caso tente adicionar um segundo Webhook, retornará um error.

Primeiro é criado um nova instância da classe Xgate e é passada as informações de acesso da sub conta. OBSERVAÇÃO: Todos os métodos chamados nessa intância, afetará a sub empresa e não a empresa principal.

Um object com os seguintes parâmetros:

• PARÂMETRO 1: externalWebhookUrl: URL do webhook
• PARÂMETRO 2: name: Nome para identificação do webhook

Resposta: