Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.safefypay.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Sua primeira cobrança PIX ou boleto

Siga este guia para criar sua primeira cobrança PIX ou boleto em poucos minutos.
1

Obtenha suas credenciais

Acesse o Painel Safefy e crie uma credencial de API.Você receberá:
  • clientId - Identificador público da sua aplicação
  • clientSecret - Chave secreta (exibida apenas uma vez, mantenha em segurança!)
2

Gere um token de acesso

Com suas credenciais, solicite um token JWT:
curl -X POST https://api-payment.safefypay.com.br/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{
    "grantType": "client_credentials",
    "clientId": "pk_sandbox_seu_client_id",
    "clientSecret": "sk_sandbox_seu_client_secret"
  }'
Resposta:
{
  "data": {
    "accessToken": "eyJhbGciOiJIUzI1NiIs...",
    "tokenType": "Bearer",
    "expiresIn": 3600
  }
}
3

Crie uma cobrança PIX ou boleto

Use o token para criar sua primeira cobrança:
curl -X POST https://api-payment.safefypay.com.br/v1/transactions \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "pix",
    "amount": 1000,
    "currency": "BRL",
    "description": "Minha primeira cobrança",
    "callbackUrl": "https://seusite.com/webhook"
  }'
Para boleto, informe o cliente e a data de vencimento:
curl -X POST https://api-payment.safefypay.com.br/v1/transactions \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "boleto",
    "amount": 1000,
    "currency": "BRL",
    "description": "Boleto de teste",
    "customerId": "550e8400-e29b-41d4-a716-446655440000",
    "boletoDueDate": "2024-12-31",
    "callbackUrl": "https://seusite.com/webhook"
  }'
Resposta:
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "Pending",
    "amount": 1000,
    "pix": {
      "qrCode": "data:image/png;base64,...",
      "copyAndPaste": "00020126580014br.gov.bcb.pix..."
    }
  }
}
4

Receba o pagamento

Quando o pagamento for confirmado, você receberá um webhook na URL configurada:
{
  "event": "transaction.completed",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "Completed",
    "amount": 1000,
    "completedAt": "2024-01-15T10:30:00Z"
  }
}

​
Próximos passos

Autenticação

Entenda como funciona a autenticação OAuth2.

Webhooks

Configure notificações em tempo real.

Sandbox

Teste pagamentos em ambiente de desenvolvimento.

Criar transação

Veja a referência completa do endpoint.