Entrar no painel
Índice

(00) Começar

Visão geral

O que é o Spolly Payments, e como corre uma compra de ponta a ponta.

O que é

O Spolly Payments recebe pagamentos para a tua loja online, num checkout alojado por nós: o teu servidor cria uma sessão de pagamento, manda o comprador para a página do checkout, e o dinheiro fica no teu saldo, de onde o sacas para o banco. O comprador paga por Multicaixa Express, referência, BAI Paga ou cartão.

Não há formulários de pagamento para embutir nem cobranças diretas pela API: a sessão de checkout é a única porta de entrada do dinheiro. Isso quer dizer que a tua integração é pequena: uma chamada para criar a sessão, e um endpoint que recebe os eventos.

O percurso de uma compra

  1. O teu servidor chama POST /v1/checkout/sessions com a tua chave secreta, o valor e a moeda, e recebe o url do checkout.
  2. O comprador abre esse endereço, vê o nome e a marca da tua loja, e escolhe como paga.
  3. Quando o gateway confirma, nós confirmamos de novo junto dele, registamos o pagamento, e enviamos o evento payment.succeeded, assinado, para o endpoint que configuraste no painel.
  4. O comprador volta ao teu success_url. Esse regresso não prova o pagamento: quem prova é o webhook (ou um GET da sessão feito pelo teu servidor). Ver Confirmar o pagamento.
  5. O valor líquido (o pago menos a nossa taxa) entra no teu saldo, e pedes o saque no painel.

Os endereços

O quêOnde
A APIhttps://payments-api.spolly.ao
O painel e esta documentaçãohttps://payments.spolly.ao
O checkout, para onde vai o compradorhttps://checkout.payments.spolly.ao

A API fala JSON, com o dinheiro sempre em unidades menores inteiras (15.000,00 Kz é {"amount": 1500000, "currency": "AOA"}), e responde aos erros com um código estável e uma mensagem em português.

Teste e produção

Tudo existe em dois modos que não se misturam: teste e produção. O modo é o da chave: uma sk_test_ cria sessões de teste, que se pagam com os botões Aprovar e Recusar do checkout, sem dinheiro nenhum; uma sk_live_ cobra a sério, e só existe depois de a tua empresa estar verificada.

Integrar em menos de uma hora

O Início rápido leva-te da conta ao primeiro pagamento de teste confirmado pelo webhook, com o SDK em Go ou em JavaScript.

O que está nesta documentação

Começar

  • Início rápido

    Da conta ao primeiro pagamento de teste confirmado por webhook, com o SDK em Go ou em JavaScript.

  • Chaves e modos

    As chaves secretas, o modo teste e o modo produção, e como rodar e revogar.

Receber pagamentos

  • Sessões de checkout

    Criar a sessão, mandar o comprador para o checkout, e o que volta.

  • Métodos de pagamento

    Multicaixa Express, referência, BAI Paga e cartão: o que o comprador vê e quando o dinheiro entra.

  • Confirmar o pagamento

    O regresso ao teu site não prova pagamento. O webhook prova, e o GET da sessão também.

  • Modo teste

    Pagar sem dinheiro, com os botões aprovar e recusar do checkout.

  • Estornos

    Devolver todo ou parte de um pagamento, e o que acontece ao saldo.

  • Subscrições

    Cobrar todos os meses: a sessão em modo subscrição, as renovações e o cancelamento.

Webhooks

  • Webhooks

    Configurar o endpoint, verificar a assinatura, retentativas, reenvio e rotação do segredo.

Referência

  • Idempotência

    O cabeçalho Idempotency-Key, e como repetir um pedido sem cobrar duas vezes.

  • Erros

    A forma de um erro, os códigos HTTP e os códigos estáveis da API.

  • Referência da API

    Todas as rotas, com os campos, as respostas e os exemplos, geradas da especificação OpenAPI.

  • Referência dos eventos

    Todos os eventos, com o envelope, o objeto de cada um e um exemplo, gerados dos esquemas.