Pagamentos

Método e rota: GET /api/payments. Devolve uma lista paginada de pagamentos.

Método e rota: POST /api/payments. Cria um pagamento no gateway. Use o corpo do pedido para escolher o tipo de pagamento, como GPO mobile/QR ou PPR.

Tipos de pagamento:

• GPO é usado para fluxos de pagamento mobile money e QR Code. O pedido normalmente inclui metadados específicos de GPO, como método de pagamento, número de telefone ou configurações QR Code, provedor, ID do comerciante e ID do POS.
• O PPR (Pagamento por Referência) é utilizado para fluxos de referências de pagamento. Utilize referenceType: Dynamic para referências de montante fixo. Pode deixar o campo reference vazio para que a API gere automaticamente a referência, ou indicar o seu próprio número de referência quando o comerciante necessitar de o definir. Utilize referenceType: Charging para referências de montante aberto, normalmente com amount: 0, permitindo que o montante seja definido no momento do pagamento. As referências do tipo Charging podem receber múltiplas transações utilizando a mesma referência.

Método e rota: GET /api/payments/{paymentId}. Consulta os detalhes atuais de um pagamento.

Para pagamentos PPR, envie a reference devolvida (por exemplo, 584923109). Também pode utilizar o internalId do pagamento quando disponível. O UUID devolvido como id na resposta compacta de criação PPR identifica o registo da referência PPR e não é o valor de consulta deste endpoint.

Método e rota: POST /api/payments/{paymentId}/sync. Atualiza o estado do pagamento junto do provedor.

Método e rota: POST /api/payments/{internalPaymentId}/cancel. Cancela uma autorização usando o GUID interno do pagamento.

Endpoint de Callback do Comerciante

O endpoint de callback é um URL HTTPS hospedado pelo comerciante e fornecido à equipa de desenvolvimento da IZI Pay durante a configuração. Este é o endpoint para onde a IZI Pay envia atualizações de estado do pagamento e notificações.

Juntamente com o URL de callback, o comerciante também deve fornecer um Access-Key. A IZI Pay inclui esta chave nos cabeçalhos de todos os pedidos de callback para que o comerciante possa autenticar e validar as notificações recebidas.

O comerciante é responsável por garantir que o endpoint de callback está publicamente acessível e é capaz de receber e processar pedidos da IZI Pay.

Este callback aplica-se a pagamentos GPO QR Code criados através da API de Pagamentos.

Resumo

Durante o onboarding, o comerciante deve fornecer os seguintes dados à equipa de desenvolvimento da IZI Pay:

• Callback URL: O endpoint HTTPS para onde a IZI Pay enviará notificações de estado do pagamento.
• Access-Key: Um valor secreto escolhido e fornecido pelo comerciante. A IZI Pay inclui este valor nos cabeçalhos de todos os pedidos de callback, permitindo ao comerciante verificar que a notificação teve origem na IZI Pay.