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.

As credenciais da API de pagamentos usam um schema fixo de permissões para limitar o que cada integração pode fazer.

​
Estrutura da permissão

{
  "version": 1,
  "balance": {
    "read": true
  },
  "transactions": {
    "read": true,
    "write": true
  },
  "customers": {
    "read": true,
    "write": true,
    "edit": true
  },
  "cashouts": {
    "read": true,
    "write": true,
    "allowAnyPixKey": false
  }
}

​
Módulos e efeitos

MóduloCampoEfeito principal
Saldobalance.readPermite GET /v1/balance
Transaçõestransactions.readPermite listagem e detalhe de transações
Transaçõestransactions.writePermite criação e simulação de transações
Clientescustomers.readPermite listagem e detalhe de clientes
Clientescustomers.writePermite criação de clientes
Clientescustomers.editPermite atualização de clientes
Saquescashouts.readPermite listagem e detalhe de saques
Saquescashouts.writePermite criar, cancelar e simular saques
Saquescashouts.allowAnyPixKeyPermite enviar chave PIX arbitrária no create cashout

​
Regras importantes de saque

  1. Sempre use withdrawNowAvailable de GET /v1/balance para definir o valor de saque.
  2. Se requiresFullWithdrawalNow = true, o valor deve ser exatamente withdrawNowAvailable.
  3. Quando cashouts.allowAnyPixKey = false, a integração não pode sacar para chave PIX arbitrária.
  4. O ambiente da operação (Sandbox ou Production) é definido pela própria credencial autenticada.

​
Boas práticas

  1. Crie credenciais separadas por serviço interno.
  2. Aplique menor privilégio possível em cada credencial.
  3. Não use uma única credencial com todos os módulos habilitados para todos os sistemas.
  4. Revogue e gere nova credencial imediatamente em caso de suspeita de vazamento.