Documentação da API

Integre pagamentos PIX e criptomoedas no seu site ou aplicativo de forma simples e rápida

Rápido

Integração em minutos com nossa API RESTful

Seguro

Autenticação robusta e dados criptografados

Simples

Documentação clara com exemplos práticos

Multi-moeda

Suporte para PIX e criptomoedas

🚀 Começando

Use nossa API para integrar pagamentos PIX e criptomoedas diretamente no seu site ou aplicativo.

📋 Credenciais de Exemplo

Estas são chaves de exemplo. Para usar a API, você precisa criar uma conta e obter suas credenciais reais.

API Key: cp_live_1234567890abcdefghijklmnopqrstuvwxyz

API Secret: sk_live_9876543210zyxwvutsrqponmlkjihgfedcba

Base URL: https://app.caullerpay.com/api/

🔐 Autenticação

Todas as requisições devem incluir suas credenciais nos headers HTTP:

X-API-Key: cp_live_1234567890abcdefghijklmnopqrstuvwxyz
X-API-Secret: sk_live_9876543210zyxwvutsrqponmlkjihgfedcba
Content-Type: application/json

            

⚠️ Importante: As credenciais de API são exclusivas para sua conta e devem ser mantidas em segurança. Não compartilhe essas informações publicamente.

POST https://app.caullerpay.com/api/criar_cobranca.php

Criar Cobrança PIX

Cria uma nova cobrança PIX e retorna o código para pagamento.

Parâmetro	Tipo	Obrigatório	Descrição
`valor`	float	Sim	Valor da cobrança em reais (ex: 100.50)
`descricao`	string	Não	Descrição da cobrança (padrão: "Cobrança PIX")
`cliente`	object	Não	Dados do cliente que vai pagar (opcional)
`cliente.nome`	string	Não	Nome do cliente (obrigatório se informar cliente)
`cliente.email`	string	Não	Email do cliente
`cliente.cpf`	string	Não	CPF do cliente (11 dígitos)
`cliente.telefone`	string	Não	Telefone do cliente

cURL:

curl -X POST "https://app.caullerpay.com/api/criar_cobranca.php" \

  -H "X-API-Key: cp_live_1234567890abcdefghijklmnopqrstuvwxyz" \

  -H "X-API-Secret: sk_live_9876543210zyxwvutsrqponmlkjihgfedcba" \

  -H "Content-Type: application/json" \

  -d '{

  "valor": 100.50,

  "descricao": "Pagamento de serviço"

}'

JavaScript (Fetch):

fetch('https://app.caullerpay.com/api/criar_cobranca.php', {

  method: 'POST',

  headers: {

    'X-API-Key': 'cp_live_1234567890abcdefghijklmnopqrstuvwxyz',

    'X-API-Secret': 'sk_live_9876543210zyxwvutsrqponmlkjihgfedcba',

    'Content-Type': 'application/json'

  },

  body: JSON.stringify({

    valor: 100.50,

    descricao: 'Pagamento de serviço'

  })

})

.then(response => response.json())

.then(data => {

  if (data.sucesso) {

    console.log('Código PIX:', data.dados.copia_e_cola);

  }

});

PHP:

$ch = curl_init('https://app.caullerpay.com/api/criar_cobranca.php');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

curl_setopt($ch, CURLOPT_POST, true);

curl_setopt($ch, CURLOPT_HTTPHEADER, [

  'X-API-Key: cp_live_1234567890abcdefghijklmnopqrstuvwxyz',

  'X-API-Secret: sk_live_9876543210zyxwvutsrqponmlkjihgfedcba',

  'Content-Type: application/json'

]);

curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([

  'valor' => 100.50,

  'descricao' => 'Pagamento de serviço'

]));

$response = curl_exec($ch);

$data = json_decode($response, true);

curl_close($ch);

Sucesso (200):

{

  "sucesso": true,

  "mensagem": "Cobrança criada com sucesso",

  "dados": {

    "id": 123,

    "transacao_id": 123,

    "transaction_id": "abc123def456",

    "valor": "100.50",

    "copia_e_cola": "00020126580014br.gov.bcb.pix...",

    "qr_code": "00020126580014br.gov.bcb.pix...",

    "status": "aguardando",

    "data_criacao": "2024-01-15 10:30:00",

    "created_at": "2024-01-15 10:30:00"

  }

}

Erro (400):

{

  "sucesso": false,

  "mensagem": "Valor mínimo é R$ 5,00",

  "dados": null

}

POST https://app.caullerpay.com/api/criar_deposito_crypto.php

Criar Depósito via Criptomoeda

Cria um novo depósito via criptomoeda e retorna o endereço da carteira para envio.

Parâmetro	Tipo	Obrigatório	Descrição
`valor`	float	Sim	Valor do depósito em reais (ex: 100.50). Mínimo: R$ 27,00
`moeda`	string	Não	Moeda crypto: btc, eth, sol, ltc (padrão: btc)

cURL:

curl -X POST "https://app.caullerpay.com/api/criar_deposito_crypto.php" \

  -H "X-API-Key: cp_live_1234567890abcdefghijklmnopqrstuvwxyz" \

  -H "X-API-Secret: sk_live_9876543210zyxwvutsrqponmlkjihgfedcba" \

  -H "Content-Type: application/json" \

  -d '{

  "valor": 100.00,

  "moeda": "btc"

}'

JavaScript (Fetch):

fetch('https://app.caullerpay.com/api/criar_deposito_crypto.php', {

  method: 'POST',

  headers: {

    'X-API-Key': 'cp_live_1234567890abcdefghijklmnopqrstuvwxyz',

    'X-API-Secret': 'sk_live_9876543210zyxwvutsrqponmlkjihgfedcba',

    'Content-Type': 'application/json'

  },

  body: JSON.stringify({

    valor: 100.00,

    moeda: 'btc'

  })

})

.then(response => response.json())

.then(data => {

  if (data.sucesso) {

    console.log('Endereço:', data.dados.endereco);

    console.log('Valor em crypto:', data.dados.valor_crypto);

  }

});

Sucesso (200):

{

  "sucesso": true,

  "mensagem": "Depósito via criptomoeda criado com sucesso",

  "dados": {

    "id": 123,

    "transacao_id": 123,

    "transaction_id": "CRYPTO_BTC_123456",

    "payment_id": "123456",

    "order_id": "crypto_1234567890_abc123",

    "endereco": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",

    "valor_crypto": "0.00123456",

    "valor": 100.00,

    "valor_brl": 100.00,

    "moeda": "BTC",

    "qrcode_text": "bitcoin:1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa?amount=0.00123456",

    "status": "aguardando",

    "data_criacao": "2024-01-15 10:30:00",

    "created_at": "2024-01-15 10:30:00"

  }

}

GET https://app.caullerpay.com/api/consultar_transacao.php

Consultar Status de Transação

Consulta o status de uma transação específica.

Parâmetro	Tipo	Obrigatório	Descrição
`id`	integer	Sim	ID da transação

cURL:

curl "https://app.caullerpay.com/api/consultar_transacao.php?id=123" \

  -H "X-API-Key: cp_live_1234567890abcdefghijklmnopqrstuvwxyz" \

  -H "X-API-Secret: sk_live_9876543210zyxwvutsrqponmlkjihgfedcba"

JavaScript (Fetch):

fetch('https://app.caullerpay.com/api/consultar_transacao.php?id=123', {

  headers: {

    'X-API-Key': 'cp_live_1234567890abcdefghijklmnopqrstuvwxyz',

    'X-API-Secret': 'sk_live_9876543210zyxwvutsrqponmlkjihgfedcba'

  }

})

.then(response => response.json())

.then(data => console.log(data));

{

  "sucesso": true,

  "mensagem": "Transação encontrada",

  "dados": {

    "id": 123,

    "transaction_id": "abc123def456",

    "valor": "100.50",

    "status": "pago",

    "data_pagamento": "2024-01-15 10:35:00",

    "data_criacao": "2024-01-15 10:30:00",

    "created_at": "2024-01-15 10:30:00",

    "copia_e_cola": "00020126580014br.gov.bcb.pix...",

    "qr_code": "00020126580014br.gov.bcb.pix..."

  }

}

GET https://app.caullerpay.com/api/saldo.php

Consultar Saldo

Retorna o saldo disponível e bloqueado da conta.

cURL:

curl "https://app.caullerpay.com/api/saldo.php" \

  -H "X-API-Key: cp_live_1234567890abcdefghijklmnopqrstuvwxyz" \

  -H "X-API-Secret: sk_live_9876543210zyxwvutsrqponmlkjihgfedcba"

JavaScript (Fetch):

fetch('https://app.caullerpay.com/api/saldo.php', {

  headers: {

    'X-API-Key': 'cp_live_1234567890abcdefghijklmnopqrstuvwxyz',

    'X-API-Secret': 'sk_live_9876543210zyxwvutsrqponmlkjihgfedcba'

  }

})

.then(response => response.json())

.then(data => console.log(data));

{

  "sucesso": true,

  "mensagem": "Saldo consultado",

  "dados": {

    "saldo": "1000.00",

    "saldo_bloqueado": "50.00",

    "saldo_disponivel": "950.00"

  }

}

🔔 Webhooks

Configure uma URL de webhook nas suas configurações para receber notificações automáticas quando:

Uma cobrança for paga
Um saque for processado

Formato do Webhook:

POST https://seusite.com/webhook

Content-Type: application/json

{

  "tipo": "transacao",

  "evento": "pago",

  "dados": {

    "id": 123,

    "valor": "100.50",

    "status": "pago",

    "transaction_id": "abc123"

  },

  "timestamp": "2024-01-15T10:35:00Z"

}

📊 Códigos de Status

Código	Descrição
`200`	Sucesso
`400`	Erro na requisição (dados inválidos)
`401`	Não autenticado (credenciais inválidas)
`403`	Conta não verificada ou suspensa
`500`	Erro interno do servidor