API reference

Uma API de pagamentos com qualquer gateway por trás. Toda request se autentica com a secret key de um app como Bearer token: a key diz qual app está chamando, e as rotas do app escolhem o gateway. A tenant key (Settings) age como admin sobre todos os apps (app escolhe um; sem ele, o Default app). As requests de criação aceitam o header Idempotency-Key: enviar a mesma key de novo devolve o primeiro resultado, com status 200. Comece pelo POST /connect: o app decide se é um pagamento avulso ou uma subscription. O header opcional X-Pay-Version é aceito e fica reservado para mudanças futuras.

URL base

https://pay.contagorda.com/api/v1

Autenticação

Toda request envia uma secret key como Bearer token: a key de um app (Apps) para seus produtos, ou a tenant key (Settings) como admin. Uma key ausente ou errada responde 401.

-H "Authorization: Bearer $PAY_SECRET_KEY"

Erros

401 e 404 respondem { "error": message }. Erros de validação respondem 422 com { "errors": { field: message } } (sessions, subscriptions) ou { "errors": [messages] } (gateways). Uma falha do gateway responde 502 com a mensagem do provider.

Connect

O ponto de entrada. Uma request cria o que o app cobra (um pagamento ou uma subscription) no gateway que as rotas dele escolhem, e responde para onde enviar o cliente.

Sessions

Pagamentos avulsos. Crie uma session, envie o cliente para a redirect_url dela e depois confie no retorno assinado e no webhook session.paid.

Config

O tenant e as configurações de gateway ativas.

Tem certeza?

Atalhos de teclado

⌘ KBuscar e navegar⌘ JAbrir e fechar o Workbenchg hIníciog pPagamentosg cClientesg sSubscriptionsg aAppsg gGateways?Esta listaEscFechar