Quickstart - SwytchPay

Beta — o contrato da 1.0 está em evolução. Esta página descreve o que a API aceita e devolve hoje.

A 1.0 responde em https://api.go.swytchpay.app. As credenciais são um par: a chave pública (ak_…) vai em x-api-key e a secreta (sk_…) em x-api-secret. Uma chave de teste começa com ak_test_; a de produção, com ak_live_.

Crie um depósito

curl -X POST https://api.go.swytchpay.app/v1/deposits \
  -H "x-api-key: ak_test_xxx" \
  -H "x-api-secret: sk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "orden-42",
    "amount_cents": 50000,
    "currency": "MXN",
    "method": "SPEI",
    "payer": { "name": "Juan Pérez", "email": "juan@ok.mx", "document": "PEGJ850315HDFRRN01" }
  }'

Resposta 201:

{ "id": "dep_…", "status": "PENDING", "amount_cents": 50000, "flow": "REDIRECT", "charge": { "type": "spei", "redirect_url": "https://…", "expires_at": 1788367323 } }

.O charge traz o que o pagador usa, e ele muda com o trilho: o emv no PIX, uma redirect_url no SPEI e no PSE. Sem currency, o padrão é BRL (PIX). O valor é amount_cents — inteiro, na menor unidade da moeda.

Registre seu webhook

curl -X POST https://api.go.swytchpay.app/v1/webhooks \
  -H "x-api-key: ak_test_xxx" -H "x-api-secret: sk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{ "name": "minha corretora", "url": "https://suacorretora.com/webhooks/swytch" }'

A resposta traz o secret (whsec_…) uma única vez — guarde para validar a assinatura. O evento deposit.paid avisa quando o dinheiro entrou.

Confira o saldo

curl https://api.go.swytchpay.app/v1/balance \
  -H "x-api-key: ak_test_xxx" -H "x-api-secret: sk_test_xxx"
# { "currency": "BRL", "available_minor": "0", "pending_minor": "0", "blocked_minor": "0",
#   "balances": [ …uma posição por moeda… ] }

Os valores vêm em unidades mínimas, como texto. A raiz é o saldo em reais; balances traz a posição de cada moeda da conta.

Pronto: você criou a cobrança, registrou o aviso e leu o saldo. Veja Depósitos para os campos de cada trilho.