Introdução

Bem-vindo à documentação da API! Aqui você encontra todos os endpoints, exemplos e dicas para integrar sua aplicação de forma rápida e segura.

Base URL:
https://api.netflypay.com

Autenticação

Faça login para obter um token Bearer e acessar os recursos da API.

POST
https://api.netflypay.com/api/auth/login

Body da requisição:

{
  "client_id": "your_client_id",
  "client_secret": "your_client_secret"
}

Resposta:

{
  "token": "your_generated_token",
  "expires_in": 3600
}

Depósito

Crie um depósito e gere um QR Code para pagamento.

POST
https://api.netflypay.com/api/payments/deposit

Headers:

{
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Body da requisição:

{
  "amount": 100.00,
  "external_id": "unique_deposit_id",
  "clientCallbackUrl": "https://example.com/callback",
  "payer": {
    "name": "John Doe",
    "email": "johndoe@example.com",
    "document": "12345678901"
  }
}

Resposta:

{
  "message": "Deposit created successfully.",
  "qrCodeResponse": {
    "transactionId": "12345",
    "status": "PENDING",
    "qrcode": "base64_encoded_qr_code",
    "amount": 100.00
  }
}

Saque

Inicie um saque e envie fundos via PIX.

POST
https://api.netflypay.com/api/withdrawals/withdraw

Headers:

{
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Body da requisição:

{
  "amount": 50.00,
  "external_id": "unique_withdrawal_id",
  "pix_key": "user_pix_key",
  "key_type": "CPF",
  "name": "John Doe",
  "taxId": "12345678901",
  "description": "Withdrawal request",
  "clientCallbackUrl": "https://example.com/callback"
}

Resposta:

{
  "message": "Withdrawal processed successfully.",
  "withdrawal": {
    "transaction_id": "12345",
    "status": "COMPLETED",
    "amount": 50.00,
    "fee": 2.50
  }
}

Webhooks

Receba notificações em tempo real sobre mudanças de status das transações.

Webhook de Depósito:

{
  "transaction_id": "bced117701628c6f8104m50fmc7l5o4f",
  "status": "PENDING",
  "amount": 1,
  "type": "Deposit"
}
{
  "transaction_id": "2e79273435565c95312am50fyeae3q2h",
  "status": "COMPLETED",
  "amount": 2.00,
  "type": "Deposit"
}

Webhook de Saque:

{
  "transaction_id": "bced117701628c6f8104m50fmc7l5o4f",
  "status": "PENDING",
  "amount": 1,
  "type": "Withdraw"
}
{
  "transaction_id": "2e79273435565c95312am50fyeae3q2h",
  "status": "COMPLETED",
  "amount": 2.00,
  "type": "Withdraw"
}