API de Pagamentos
Integre os pagamentos pela ordem do seu fluxo: escolha um método em Pagamentos, consulte o estado em Consulta de Pagamentos e receba confirmações em Webhooks. Referências PPR explica as referências reutilizáveis e de montante fixo. Reembolsos reúne as consultas de reconciliação; as operações de terminal e de acesso ficam no final da navegação. Todos os exemplos de novos pedidos usam valores fictícios; substitua-os pelos dados da sua integração.
Tags
Pagamentos
Escolha um método, crie pagamentos e gira autorizações não utilizadas, com orientações antes do esquema do pedido.
Consulta de Pagamentos
Depois de criar um pagamento, consulte o estado, atualize-o junto do prestador ou encontre pagamentos com filtros. As operações estão limitadas ao comerciante autenticado.
Referências PPR
Criar e gerir referências de pagamento PPR.
Reembolsos
Reconcilie registos de reembolso e os seus estados. O estado do reembolso é diferente do estado do pagamento original.
Webhooks
Receba notificações no endpoint HTTPS do comerciante. São callbacks enviados à sua aplicação, não pedidos que envia ao gateway.
Operações de Terminal
Abrir, fechar e consultar o estado de terminais GPO.
Autenticação
Autentique os pedidos à API com o bearer token do comerciante. Consulte o guia de autenticação para obter um token. Os endpoints abaixo gerem quais utilizadores podem aceder a uma conta de comerciante.
Security Schemes
bearerAuth
Bearer token (JWT)
http
ApiKeyAuth
API Key in header (x-api-key)
apiKey
Webhooks
pprReferencePaymentNotification
Notificação de pagamento de referência PPR
POST
qrCodePaymentNotification
Notificação de pagamento QR Code
POST