DocsIntrodução
API v1.0Produção

Introdução à API de Pagamentos

Integra pagamentos digitais na tua aplicação com uma única chamada à API. Gera referências Multicaixa e processa Multicaixa Expressa em Angola, com confirmação em tempo real via webhooks.

#O que é a API?

A API de pagamentos é uma interface REST baseada em JSON. Cada pedido é autenticado com a tua chave de API e devolve um objeto estruturado com o estado da transação e, para pagamentos por referência, a entidade, o número de referência e a respetiva validade.

A API é síncrona para a criação do pagamento: recebes a referência (ou a confirmação do pedido Expressa) imediatamente na resposta. A liquidização acontece depois, de forma assíncrona, e é comunicada através de webhooks.

#URL base

Todas as requisições de pagamento são feitas para o endpoint /api/pay do gateway, sobre HTTPS.

shellconfig
BASE_URL=https://paypay-gateway.gpaygo.com
# Ex.: POST https://paypay-gateway.gpaygo.com/api/pay

HTTPS obrigatório

O gateway só aceita ligações seguras. Não uses HTTP em produção — a chave de API viajaria em texto simples.

#O que podes fazer

Pagamentos por referência

Gera uma referência Multicaixa (entidade + referência + validade) que o cliente pode pagar em qualquer caixa ou canal Multicaixa.

Multicaixa Expressa

Inicia um pedido de pagamento direto para o telemóvel do cliente através do serviço Multicaixa Expressa.

Notificações em tempo real

O estado da transação é comunicado ao teu servidor via webhooks, além do redirecionamento para a tua URL de retorno.

Transações seguras

Cada pedido é autenticado com a tua chave de API e registado com um ID único gerado pelo teu lado (transaction_id).

#Fluxo de um pagamento

  1. 1

    Cliente inicia o pagamento

    Na tua aplicação, o cliente escolhe pagar por referência ou por Multicaixa Expressa.
  2. 2

    O teu servidor chama a API

    Envias um pedido POST para /api/pay com o valor, o método e os dados do cliente. A resposta devolve a referência gerada (ou inicia o pedido Expressa).
  3. 3

    O cliente paga

    Para referências: o cliente paga com a entidade e referência num canal Multicaixa. Para Expressa: o cliente confirma no telemóvel.
  4. 4

    Recebes a confirmação

    A transação muda de estado e recebes a notificação via webhook, podendo redirecionar o cliente para a redirect_url.

Pronto para começar?

Segue o início rápido para fazeres o primeiro pedido em menos de cinco minutos.