Skip to main content
Plataformas de corretora integram gateways via conectores pré-construídos. O gateway expõe uma facade compatível com esse conector: a corretora só aponta o conector para o nosso endpoint — zero código novo. Base URL: https://api.swytchpay.app/compat/zyropay Envelope { success, data, errors } · valores em BRL decimal. Credenciais (modo test, para validar a integração): 
clientId (Client ID):     pk_test_…   (fornecido pela plataforma)
password (Client Secret): sk_test_…   (fornecido pela plataforma · só aparece uma vez)

​
Autenticação

POST /compat/zyropay/cli/client/authenticate 
{ "clientId": "<sua chave pública>", "password": "<sua chave secreta>" }
→ { "success": true, "data": { "clientId": "…", "name": "…", "token": "<Bearer 8h>" } }
Envie o token como Authorization: Bearer … nas demais chamadas.

​
Gerar PIX (cobrança)

POST /compat/zyropay/cli/payment/pix/generate-pix 
{ "value": 50.00, "expiration": 3600, "externalId": "pedido-42" }
→ { "success": true, "data": { "pix": "000201…", "value": 50, "clientId": "…", "paymentId": "dep_…", "movId": "…" } }
pix é o copia-e-cola (renderize o QR no front). paymentId identifica a cobrança e volta no webhook.

​
Saque · saldo · webhook

POST /compat/zyropay/cli/payment/pix/pix-key          { externalId, pixKey, payment: { amount: "100.00" } }
GET  /compat/zyropay/cli/client/balance               { accountBalance, availableBalance, … }
PUT  /compat/zyropay/cli/client/update/notification-url  registra a URL que recebe as confirmações
O webhook de confirmação chega no formato do conector: 
{ "status": "CONFIRMED", "type": "PixIn", "externalId": "pedido-42", "paymentId": "dep_…", "movId": "…", "amount": 50, "securityParaphrase": "…" }
Valide pela securityParaphrase (a mesma que você cadastrou em notification-url).
A camada de Token IP / allowlist de IP do conector está estruturada e é ajustada por integração. Fale com o time para o provisionamento.