SafelyPay docs
Documentação · API Merchant

A API da SafelyPay

Pagamentos PIX com lastro de segurança: autentique com usuário e senha, cobre e pague por PIX, consulte transações e saldo, e receba eventos assinados por webhook. Tudo sobre a base https://safelypay.payments.onegate.me/v1/.

Do zero ao primeiro PIX
# 1 · autentica e captura o accessToken
TOKEN=$(curl -s "https://safelypay.payments.onegate.me/v1/public/auth" \
  -d '{"username":"'"$USER"'","password":"'"$PASS"'"}' | jq -r .accessToken)

# 2 · cria a cobrança PIX (valor em BRL na escala humana)
curl -s "https://safelypay.payments.onegate.me/v1/private/pix/charge" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"amount":149.90,"payerName":"Maria Souza","payerDocument":"12345678909","externalId":"pedido-7791"}'

Comece aqui

AuthAutenticaçãoLogin com usuário e senha, Bearer nas rotas privadas e renovação por refreshToken.SetupAmbiente & credenciaisBase URL, variáveis de ambiente, escala monetária em BRL e regras de segurança.

PIX

pay-inCriar cobrança PIXGere pixCode e qrCode prontos; a compensação chega por PixBRLDepositEvent.pay-outSolicitar saque PIXPague para uma chave do favorecido; acompanhe por PixBRLWithdrawalEvent.

Transações & saldo

GETListar transaçõesPaginação por cursor, busca e filtros por período.GETConsultar transaçãoPor id interno ou pelo seu externalId de negócio.GETConsultar saldoSaldo disponível e pendente em BRL do merchant.

Webhooks

SetupCadastro de webhookBootstrap idempotente: liste, atualize ou crie — sem duplicar a cada deploy.ReceiverReceptor de eventosValide o segredo e processe a MerchantNotification de forma idempotente.SchemaMerchantNotificationTipos de evento, status, estrutura do payload e exemplo completo.

Referência

ReferenceEndpointsMapa completo dos fluxos da API Merchant.ReferenceErros & idempotênciaStatus HTTP, renovação de token e repetição segura de eventos.