Referência da API

Documentação completa dos endpoints disponíveis

Base URL

https://uat.pixley.app

Autenticação

Inclua suas credenciais no header:

X-API-Key: SEU_API_KEY

X-Secret-Key: SEU_SECRET_KEY

Gerar Chaves de API

Geração de Chaves de API

API KEYSSECURITY

Gera novas chaves de API para autenticação.

Requisição

POST https://uat.pixley.app/api/auth/keys/generate-api-keys

Resposta

{
  "message": "API keys generated successfully",
  "apiKey": "a1b2c3d4-e5f6-7890-abcd-123456789012",
  "secretKey": "f8e7d6c5b4a398765432109876543210abcdef1234567890abcdef1234567890"
}

Campos do Corpo da Requisição

O corpo da requisição deve conter os seguintes campos: - Nenhum campo necessário.

Validação de Chaves

Validação de Chaves de API

API KEYSSECURITY

Valida as chaves de API fornecidas para garantir acesso às APIs.

Requisição

POST https://uat.pixley.app/api/auth/keys/key-validate

Resposta

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Campos do Corpo da Requisição

O corpo da requisição deve conter os seguintes campos: - Nenhum campo necessário.

Converter Moeda

Conversão de Moedas

CONVERSION

Converte um valor de uma moeda de origem para uma moeda de destino, com opção de simulação ou execução real.

Requisição

POST https://uat.pixley.app/api/banking/convert

x-api-key: 94b0f31b-b740-4735-af0f-5e841f32c457
x-secret-key: b7e24c4d2e8956c153c3d0bada964842109f279e1f5b77687b050ae4ce3071e6
{
  "fromCurrency": "cPix",
  "toCurrency": "USDT",
  "amount": 800,
  "simulation": false
}

Resposta

{
  "message": "Conversion successful",
  "fromCurrency": "cPix",
  "toCurrency": "USDT",
  "price": "5.9491",
  "feeAmount": "0.7000",
  "fromAmount": "8.0000",
  "toAmount": "0.9943"
}

Campos do Corpo da Requisição

O corpo da requisição deve conter os seguintes campos: - fromCurrency: Moeda de origem (ex.: "cPix"). - toCurrency: Moeda de destino (ex.: "USDT"). - amount: Valor a ser convertido em centavos (ex.: 800 = 8.00). - simulation: Booleano indicando se é uma simulação (true) ou execução real (false).

Sacar Criptomoeda

Saque de Criptomoedas

WITHDRAWAL

Solicita o saque de uma quantidade de criptomoeda para um endereço de carteira especificado, com opção de simulação.

Requisição

POST https://uat.pixley.app/api/banking/withdraw-crypto

x-api-key: 94b0f31b-b740-4735-af0f-5e841f32c457
x-secret-key: b7e24c4d2e8956c153c3d0bada964842109f279e1f5b77687b050ae4ce3071e6
{
  "currency": "USDT",
  "receiverAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "amount": 100,
  "network": "Polygon",
  "simulation": false
}

Resposta

{
"message": "Withdrawal request submitted successfully",
"jobId": "2663"
}

Campos do Corpo da Requisição

O corpo da requisição deve conter os seguintes campos: - currency: Moeda a ser sacada (ex.: "USDT"). - receiverAddress: Endereço da carteira de destino. - amount: Valor a ser sacado em centavos (ex.: 100 = 1.00). - network: Rede blockchain utilizada (ex.: "Polygon"). - simulation: Booleano indicando se é uma simulação (true) ou execução real (false).

Obter Pix Copia e Cola

Recuperação de Pix Copia e Cola

PIX

Recupera os detalhes de um Pix Copia e Cola gerado anteriormente.

Requisição

GET https://uat.pixley.app/api/banking/brcodes/:uuid

Resposta

{
  "amount": "0.51",
  "fees": null,
  "network": null,
  "token": null,
  "qr_code": "00020101021226930014BR.GOV.BCB.PIX2571spi-qrcode.bancocryptoex.com.br/spi/pj/v2/a050b96223b54048a80a2ad57afbd2ed52040000530398654040.515802BR5901*6013CAPITAL_CITY61088803200562070503***6304BEB5",
  "wallet_address": null,
  "created_at": "2025-02-05T21:54:42.883Z",
  "pix_status": "pending",
  "tx_hash": null
}

Campos do Corpo da Requisição

O corpo da requisição deve conter os seguintes campos: - Nenhum campo necessário.

Transação Cripto (Pix para USDT)

Cotação e Execução de Transação Pix para USDT

CONVERSION

Obtém uma cotação para uma transação ou executa uma transação real. Receben valores em USDT diretamente na carteira do usuário.

Requisição

POST https://uat.pixley.app/api/banking/quote-transaction

x-api-key: 94b0f31b-b740-4735-af0f-5e841f32c457
x-secret-key: b7e24c4d2e8956c153c3d0bada964842109f279e1f5b77687b050ae4ce3071e6
{
  "value": 800,
  "simulation": false,
  "receiverAddress": "0x9876543210fedcba9876543210fedcba98765432"
}

Resposta

{
  "id": "36fecd02-0af1-4c55-9c67-acd08bd2d187",
  "uuid": "d1459d07e3a643e3aead579a90c18669",
  "value": 800,
  "receiverAddress": "0x9876543210fedcba9876543210fedcba98765432",
  "status": "pending",
  "created_at": "2025-02-16T21:10:53Z",
  "updated_at": "2025-02-16T21:10:53Z"
}

Campos do Corpo da Requisição

O corpo da requisição deve conter os seguintes campos: - value: Valor em centavos a ser convertido (ex.: 800 = 8.00). - simulation: Booleano indicando se é uma simulação (true) ou execução real (false). - receiverAddress: Endereço da carteira de destino para receber USDT.

Obter Cotação de Transação

Consulta de Cotação de Transação

CONVERSION

Recupera os detalhes de uma cotação de transação específica.

Requisição

GET https://uat.pixley.app/api/banking/quote-transaction/:transactionId

Resposta

{
  "id": "36fecd02-0af1-4c55-9c67-acd08bd2d187",
  "uuid": "d1459d07e3a643e3aead579a90c18669",
  "value": 800,
  "receiverAddress": "0x9876543210fedcba9876543210fedcba98765432",
  "status": "completed",
  "created_at": "2025-02-16T21:10:53Z",
  "updated_at": "2025-02-16T21:11:02Z"
}

Campos do Corpo da Requisição

O corpo da requisição deve conter os seguintes campos: - Nenhum campo necessário.

Obter Saldo

Recuperação de Saldo

BALANCE

Recupera os saldos de moedas fiduciárias e criptomoedas.

Requisição

GET https://uat.pixley.app/api/banking/balance

Resposta

{
  "fiat": {
    "BRL": "100.50",
    "USD": "25.00"
  },
  "crypto": {
    "USDT": "0.00",
    "BTC": "0.0001"
  }
}

Campos do Corpo da Requisição

O corpo da requisição deve conter os seguintes campos: - Nenhum campo necessário.

Pagamento

PAYMENTBANKING

Realiza um pagamento via chave PIX.

Requisição

POST https://uat.pixley.app/api/banking/payment

x-api-key: 94b0f31b-b740-4735-af0f-5e841f32c457
x-secret-key: b7e24c4d2e8956c153c3d0bada964842109f279e1f5b77687b050ae4ce3071e6
{
  "type": "CHAVE",
  "valor": "1.01",
  "descricao": "Payment for invoice #1234",
  "destinatario": {
    "chave": "12345678901"
  }
}

Resposta

{
  "message": "Payment processed successfully",
  "transactionId": "abc123",
  "status": "completed"
}

Campos do Corpo da Requisição

O corpo da requisição deve conter os seguintes campos: - type: Tipo de pagamento (ex.: "CHAVE"). - valor: Valor a ser pago (ex.: "1.01"). - descricao: Descrição do pagamento. - destinatario: Objeto com a chave do destinatário.

Obter Extrato

Recuperação de Extrato

STATEMENT

Recupera o extrato de transações.

Requisição

GET https://uat.pixley.app/api/banking/statement

Resposta

{
  "transactions": [
    {
      "id": "123",
      "type": "payment",
      "amount": "10.50",
      "currency": "BRL",
      "status": "completed",
      "created_at": "2025-02-16T21:10:53Z"
    }
  ]
}

Campos do Corpo da Requisição

O corpo da requisição deve conter os seguintes campos: - Nenhum campo necessário.

Obter Transação

Consulta de Transação

TRANSACTION

Recupera os detalhes de uma transação específica.

Requisição

GET https://uat.pixley.app/api/banking/transaction/:transactionId

Resposta

{
  "id": "123",
  "type": "payment",
  "amount": "10.50",
  "currency": "BRL",
  "status": "completed",
  "created_at": "2025-02-16T21:10:53Z",
      "details": {
      "description": "Payment for invoice #1234",
      "recipient": "12345678901"
    }
}

Campos do Corpo da Requisição

O corpo da requisição deve conter os seguintes campos: - Nenhum campo necessário.

Obter Carteira do Usuário

Consulta de Carteira por Tipo de Rede

WALLET

Recupera a carteira do usuário para um tipo específico de rede blockchain.

Requisição

GET https://uat.pixley.app/api/wallet/user-wallet

Resposta

{
  "wallet_address": "0x1234567890abcdef1234567890abcdef12345678",
  "network_type": "EVM",
  "created_at": "2025-03-13T21:31:38.319Z",
  "updated_at": "2025-03-13T21:31:38.319Z"
}

Campos do Corpo da Requisição

Parâmetros de consulta: - networkType: Tipo de rede blockchain (EVM, BTC, Hathor, TRON, etc.)

Obter Carteiras do Usuário

Consulta de Todas as Carteiras do Usuário

WALLET

Recupera todas as carteiras blockchain do usuário autenticado.

Requisição

GET https://uat.pixley.app/api/wallet/user-wallets

Resposta

{
  "EVM": {
    "wallet_address": "0x1234567890abcdef1234567890abcdef12345678",
    "created_at": "2025-03-13T21:31:38.319Z",
    "updated_at": "2025-03-13T21:31:38.319Z"
  },
  "BTC": {
    "wallet_address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
    "created_at": "2025-03-13T01:56:28.663Z",
    "updated_at": "2025-03-13T01:56:28.663Z"
  },
  "Hathor": {
    "wallet_address": "HThi8YqGqKjvK8K8K8K8K8K8K8K8K8K8K8K8K8",
    "created_at": "2025-03-13T22:13:09.601Z",
    "updated_at": "2025-03-13T22:13:09.601Z"
  },
  "TRON": {
    "wallet_address": "TQn9Y2khDD95J42FQtQTdwVVRqKqJqKqKqK",
    "created_at": "2025-03-13T22:00:49.432Z",
    "updated_at": "2025-03-13T22:00:49.432Z"
  }
}

Campos do Corpo da Requisição

Não é necessário enviar parâmetros para esta requisição.

Verificar Saúde

Verificação de Saúde do Servidor

HEALTH

Verifica o status de saúde do servidor.

Requisição

GET https://uat.pixley.app/health

Resposta

{
  "status": "healthy",
  "timestamp": "2025-02-16T21:10:53Z",
  "version": "1.0.0"
}

Campos do Corpo da Requisição

O corpo da requisição deve conter os seguintes campos: - Nenhum campo necessário.

Primeiros Passos

Comece a integrar em 3 passos simples

Obtenha credenciais

Entre em contato para obter suas chaves de API.

Solicitar credenciais

Teste a API

Use os exemplos para testar sua integração.

curl -X POST https://uat.pixley.app/payments

Configure webhooks

Configure webhooks para receber notificações em tempo real.