ifthenpay | pagamentos digitais para a sua empresa

A ifthenpay integra com inúmeras plataformas de e-commerce, softwares de faturação e outros.

Antes de desenvolver, verifique se já existe integração com a plataforma que utiliza, desenvolvida pela ifthenpay, pelo fabricante da plataforma ou por terceiros.

Ver tópicos relacionados: 

• Plugins para plataformas de Ecommerce
• Integração com softwares de faturação
• API - Gerar URL PayByLink

Se necessitar de desenvolver a integração de raiz, de seguida a descrição do webservice para efetuar a solicitação de pagamento PAYSHOP e o callback de resposta quando o pagamento é efetuado.

A) Webservice para solicitação de pagamento PAYSHOP

O Webservice para pedidos de referências Payshop está disponível em 2 versões: POST e GET. 

Para pedidos POST utilizar o seguinte endpoint:

https://ifthenpay.com/api/payshop/reference/

Content-Type:application/json

Parâmetros a enviar no pedido:

• payshopkey - (Obrigatório) fornecido pela IFTHENPAY aquando da celebração do contrato 
• id - (Obrigatório) Identificador do pagamento a definir pelo cliente (ex. número da fatura, encomenda, etc…); Máximo 25 caracteres.
• valor - (Obrigatório) valor a pagar.
• validade – (Opcional) pode enviar em branco. Caso pretenda validade na referência payshop deverá passar a data no formato AAAAMMDD.

Todos os parâmetros são do tipo String.

Nos pedidos POST os parâmetros terão de ser enviados no corpo do pedido no formato Json:

{

"payshopkey" : "XXX-000000",

"id" : "12345",

"valor" : "5.00",

"validade" : "20191231"

}

Para pedidos GET utilizar o seguinte endpoint:

https://ifthenpay.com/api/payshop/get?payshopkey=XXX-000000&id=12345&valor=5.00&validade=

Resultado do pedido:

{

    "Code": "0",

    "Message": "Success",

    "Reference": "1021600051424",

    "RequestId": "3VcgFZrviWnSlTCJPLdz"

}

O exemplo acima representa um pedido efetuado com sucesso. 

Se o valor do parâmetro “Code” for “0” então a referência (“Reference”) constituída por 13 números foi colocada com sucesso na Payshop e encontra-se disponível para pagamento.

No caso de valor diferente de “0” no parâmetro “Code” os parâmetros “Reference” e “RequestId” não terão qualquer valor associado. 

Tabela com os possíveis Códigos (Code, Message):

Sandbox:

O WebService dispõe de endpoints para geração de referências de teste. Estas referências não são pagáveis.

POST:

https://ifthenpay.com/api/payshop/sandbox/

GET:

https://ifthenpay.com/api/payshop/getsandbox?payshopkey=SNB-000000&id=100&valor=15.00&validade=20200101

B) Callback PAYSHOP

O URL e Chave Anti-Phising deverá ser previamente definido por vós e configurado no backoffice Ifthenpay ou enviado por email para [email protected].  

Deverão também definir e enviar à IFTHENPAY uma chave “Anti-Phishing“ (uma string com o máximo de 50 caracteres) que será devolvida como parâmetro quando chamarmos o URL, para que possam verificar a autenticidade da mesma.

O URL indicado por vós deverá incluir os parâmetros que pretendem que sejam devolvidos (entre parêntesis retos []):

• [CHAVE_ANTI_PHISHING] – Token definido previamente pelo cliente para autenticarem a resposta;
• [ID_CLIENTE] – Identificador atribuído pelo comerciante (nº encomenda, nº fatura, etc.);
• [REFERENCIA] – Referência Payshop;
• [VALOR] – Montante pago;
• [DATA_HORA_PAGAMENTO] – Data/Hora de pagamento (devolve no formato dd-MM-yyyy HH:mm:ss);

Exemplo de URL:
 
http://www.yoursite.com/callback.php?chave=[CHAVE_ANTI_PHISHING]&id_cliente=[ID_CLIENTE]&referencia=[REFERENCIA]&valor=[VALOR]&datahorapag=[DATA_HORA_PAGAMENTO]

O vosso URL não terá de devolver qualquer valor. O sucesso do nosso pedido é determinado pelo código HTTP obtido: Caso devolva o código HTTP 200 a IFTHENPAY considera que a chamada foi efetuada com sucesso, caso devolva um código diferente (HTTP 400, 500 ou outro) então a IFTHENPAY considera que a chamada não teve sucesso e tentará novamente mais tarde (tentará 13 vezes sendo que as primeiras 8 serão de 5 em 5 minutos e as restantes de hora em hora). Caso nessas 13 tentativas não obtenha a resposta OK, não voltará a tentar.

Suporte:

A IFTHENPAY garante assistência técnica gratuita a todos os clientes e podem ser utilizados os seguintes canais:

- Através do e-mail [email protected]

- Através do telefone:  808 222 777  |  +351 227 660 871 

- Através da abertura de um ticket aqui