API REST · JSON

Documentação da API

Bem-vindo à documentação da API ConnectBank. Use este guia para integrar depósitos PIX, saques e webhooks no seu sistema.

URL Base

https://api.connectpay.site

Como funciona

Obtenha suas credenciais No painel, acesse Credenciais de API e copie seu client_id e client_secret.
Autentique-se Envie as credenciais para POST /api/auth/login e receba um token JWT.
Chame os endpoints Use o header Authorization: Bearer <token> em depósitos e saques.
Receba webhooks Configure a URL de callback na requisição para ser notificado sobre mudanças de status.

Autenticação

Envie suas credenciais (client_id e client_secret) para obter um token de acesso. Use o token Bearer nas requisições seguintes.

POST /api/auth/login

Corpo da requisição

JSON

Copiar

{
  "client_id": "seu_cliente_id",
  "client_secret": "seu_cliente_secreto"
}

Resposta

JSON

Copiar

{
  "message": "Authentication successful.",
  "token": "seu_token_jwt",
  "user": {
    "id": 1,
    "name": "Nome",
    "email": "email@example.com",
    "client_id": "seu_cliente_id"
  }
}

Mantenha o segredo em segurança

Nunca exponha o client_secret no front-end. Armazene em variáveis de ambiente no seu servidor.

Depósito

Cria um depósito PIX e retorna o QR Code para pagamento.

POST /api/payments/deposit

Headers

HTTP

Copiar

Authorization: Bearer seu_token_jwt
Content-Type: application/json

Corpo da requisição

JSON

Copiar

{
  "amount": 100.00,
  "external_id": "id_unico",
  "clientCallbackUrl": "https://example.com/callback",
  "payer": {
    "name": "Nome",
    "email": "email@example.com",
    "document": "12345678901"
  }
}

Resposta

JSON

Copiar

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

Saque

Inicia um saque via PIX para a chave informada.

POST /api/withdrawals/withdraw

Headers

HTTP

Copiar

Authorization: Bearer seu_token_jwt
Content-Type: application/json

Corpo da requisição

JSON

Copiar

{
  "amount": 50.00,
  "external_id": "id_unico_saque",
  "pix_key": "chave_pix",
  "key_type": "CPF",
  "name": "Nome",
  "taxId": "12345678901",
  "description": "Solicitação de saque",
  "clientCallbackUrl": "https://example.com/callback"
}

key_type aceita: CPF, CNPJ, EMAIL, PHONE.

Resposta

JSON

Copiar

{
  "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 no status das transações na URL informada em clientCallbackUrl.

Exemplo — depósito pendente

JSON

Copiar

{
  "transaction_id": "bced117701628c6f8104m50fmc7l5o4f",
  "status": "PENDING",
  "amount": 1,
  "type": "Deposit"
}

Exemplo — depósito concluído

JSON

Copiar

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

Exemplo — saque pendente

JSON

Copiar

{
  "transaction_id": "bced117701628c6f8104m50fmc7l5o4f",
  "status": "PENDING",
  "amount": 1,
  "type": "Withdrawal"
}

Exemplo — saque concluído

JSON

Copiar

{
  "transaction_id": "2e79273435565c95312am50fyeae3q2h",
  "status": "COMPLETED",
  "amount": 2.00,
  "type": "Withdrawal"
}