Endpoints

O endereço da REST API do ambiente de testes é:

https://dev.lusopay.com:8444/web_dev/api

O endereço da REST API do ambiente produtivo é:

https://app.lusopay.com:8443/web/api

Antes de iniciar a integração, deverá pedir-nos as credenciais para o ambiente de testes. Após este passo, nas páginas da REST API do ambiente de testes, deve começar por autenticar-se, clicando no botão «Authorize». Insira o «username» e «password» fornecidos pela lusopay. Depois, clique em «Close» e baixe até à opção «Operations». Selecione o endpoint POST /{owner}/operations/{operation}/run. Clique em «Try it out».

O parâmetro «owner» deve sempre ser preenchido com o Identificador Público de Conta do seu cliente.

O parâmetro «operation» deve sempre ser preenchido com a expressão «paybylink_api_v3»

Se, ao correr a operação personalizada, se deparar com a mensagem de erro “missingAuthorization”, tal deve-se ao facto de não se ter autenticado.

Assim, supondo que o identificador do comerciante na lusopay fosse cliente1, o endpoint, em ambiente de testes, seria https://dev.lusopay.com:8444/web_dev/api/cliente1/operations/paybylink_api_v3/run

Response body:

{

"title": "Pay by link por API V3",

"content": "https://pay.lusopay.com/paybylink_test/v3/payment_form.php?data=VoojNVLo5z0GEpQdtsJ6LxWKRQGWEa7gqeGh1at10TV95T9eeSMfZlCvaSL51biM2Q%2F7COd597lk9TSuoC9EOqxUH4eVSb8Ar9wm74lQHeDmav6luR0TJf6kQBMPzJlIu4vbznz%2BGczpuUVK5BMxntpsMLDxSLS5q74K18%2FRYZtrfnM%2B8jk5etDNeCH%2FlCOl%2FgdOm9mRh%2BIVAYpgNS38Kri4Vyq0o7uY7AEZ5a6AinJbIKp0gCp7qhzrt8yK2QEc6TNePAbaWSQGpC4%2BN4ChvLomWO471F%2BJTzYy50KJXp8%3D",

"reRun": false,

"resultType": "richText"

}

Para assegurar a estabilidade e segurança das comunicações, disponibilizamos os nossos endereços IP para whitelisting. Se necessário, por favor, solicite-o à nossa equipa.

No caso de ser inserido, como no exemplo, o valor “true” para o campo “GMR”, será possível de obter logo uma referência e respetiva entidade para o pedido de pagamento gerado, se, e só se, as referências Multibanco estiverem ativas para o comerciante em questão. Estes dados serão posteriormente utilizados na plataforma “Pay by link” (exemplo ao lado).

Não obstante os valores das referências, é apresentado logo a data-limite para o referido pagamento.

No caso de ser passado o valor “false” no campo supramencionado, será devolvido somente o URL para o pagamento, sem as devidas referências.

Antes de testar em ambiente produtivo, certifique-se junto da lusopay que o cliente tem os diversos métodos de pagamento atribuídos.