Integração da API via POST:


URL do EndPoint:

https://ifthenpay.com/api/gateway/paybylink/[GATEWAY_KEY]


* Substituir a [GATEWAY_KEY] pela enviada pela Ifthenpay. 


Formato do pedido em Json (Body)

{

  "id": "1234",

  "amount": "21.50",

  "description": "Encomenda 123",

  "lang": "en",

  "expiredate": "",

  "accounts": "MBWAY|XXX-000000;11686|000;MB|BEM-700700;...",

  "selected_method": "2",

  "btnCloseUrl": "http://url.com",

  "btnCloseLabel": "Texto do Botão",

  "success_url": "https://empresa.com/sucess",
  "error_url": "https://empresa.com/error",

  "cancel_url":"https://empresa.com/cancel"

}


id: (obrigatório) Máximo 15 caracteres numéricos que identifiquem o número da encomenda/fatura/documento/cliente. Caso a sua gateway PayByLink utilize referências Multibanco por algoritmo / Offline, apenas poderá utilizar no máximo de 4 caracteres numéricos.

amount: (obrigatório) Separador decimal "." (ex: "21.50")

description: (opcional) Breve descrição do pagamento. Máximo 200 caracteres.

lang: (opcional) Idioma apresentado ao cliente no momento do checkout (pt, en, es, fr). Default "pt". 

expiredate: (opcional) Data de expiração do url no formato AAAAMMDD (20211203) *

accounts: (opcional) Métodos disponíveis para pagamento. (ex: ENTIDADE|SUBENTIDADE;MB|MB-KEY;MBWAY|MBWAY-KEY;PAYSHOP|PAYSHOP-KEY;CCARD|CCARD-KEY). Poderá utilizar o * (asterisco) na vez do | (pipe) (exemplo: CCARD*CCARD-KEY;PAYSHOP*PAYSHOP-KEY)

selected_method: (opcional) Método de pagamento selecionado ou "aberto". (Valores: 1,2,3 ou 4. Correspondências 1-Multibanco, 2-MBWay, 3-Payshop e 4-Cartão de Crédito)
btnCloseUrl : (opcional) URL para o botão de Fechar.

btnCloseLabel : (opcional) Para definir outro texto para o botão de Fechar

success_url: (opcional) URL de redirecionamento em caso de pagamento efetuado com sucesso.

error_url: (opcional) URL de redirecionamento em caso de erro a processar o pagamento.

cancel_url: (opcional) URL de redirecionamento em caso de cancelamento do processamento do pagamento por parte do utilizador.


O resultado do EndPoint é o url para pagamento:

Exemplo: https://gateway.ifthenpay.com/url/cdLsAl5z76


* As referências multibanco por algoritmo não têm validade ou seja, são sempre válidas e caso o cliente registe as mesmas pode usar as mesmas posteriormente. Caso integre referências multibanco a pedido por API, se a validade solicitada para o link for superior a 31 dias, a validade da referencia multibanco vai ser de 45, 60, 90, 120, 180, 365 ou 730 Dias, o sistema irá aplicar por excesso o valor aproximo.

Exemplo: Caso gere um Link com referência multibanco a pedido por API com 42 dias de validade, esta vai ter 45 dias de validade.


Integração da API via GET:


URL do EndPoint:

https://ifthenpay.com/api/gateway/paybylink/get?gatewaykey=[GATEWAY_KEY]&id=[ORDER_ID]&amount=[AMOUNT]&description=[DESCRIPTION]&lang=[LANGUAGE]&expiredate=[EXPIRE_DATE]&accounts=[ACCOUNTS]&selected_method=[SELECTEDMETHOD]


gatewaykey: (obrigatório) Gateway Key enviada pela ifthenpay.

id: (obrigatório) Máximo 15 caracteres numéricos que identifiquem o v/número da encomenda/fatura/documento/cliente. Caso a sua gateway PayByLink utilize referências Multibanco por algoritmo / Offline, apenas poderá utilizar no máximo 4 caracteres numéricos.

amount: (obrigatório) Separador decimal "." (ex: "21.50")

description: (opcional) Breve descrição que aparece. Máximo 200 caracteres.

lang: (opcional) Idioma apresentado ao cliente no momento do checkout (pt, en, es, fr). Default "pt". 

expiredate: (opcional) Data de expiração do url no formato AAAAMMDD (20211203) 

accounts: (opcional) Métodos disponíveis para pagamento. (ex: ENTIDADE|SUBENTIDADE;MB|MB-KEY;MBWAY|MBWAY-KEY;PAYSHOP|PAYSHOP-KEY;CCARD|CCARD-KEY;MB|MB-KEY) Poderá utilizar o * (asterisco) na vez do | (pipe) (exemplo: CCARD*CCARD-KEY;PAYSHOP*PAYSHOP-KEY)

selected_method: (opcional) Metódo de Pagamento selecionado ou "aberto". (Valores: 1,2,3 ou 4. Correspondências 1-Multibanco, 2-MBWay, 3-Payshop e 4-Cartão de Crédito)

btnCloseUrl : (opcional) URL para o botão de Fechar

btnCloseLabel : (opcional) Para definir outro texto para o botão de Fechar.    


O resultado do EndPoint é o url para pagamento:

Exemplo: https://gateway.ifthenpay.com/url/cdLsAl5z76


CALLBACK (Webhook)


Pode definir um url de callback e uma chave antiphishing com a ifthenpay. Sempre que ocorrer um pagamento esse url será invocado e poderá ler as informações do pagamento no mesmo:


Exemplo de URL de Callback:  

http://www.yoursite.com/callback.php?key=[ANTI_PHISHING_KEY]&id=[ID]&amount=[AMOUNT]&payment_datetime=[PAYMENT_DATETIME]&payment_method=[PAYMENT_METHOD]


Exemplo de URL de Callback invocado (após pagamento confirmado):  

http://www.yoursite.com/callback.php?key=my_anti_phishing_key&id=1234&amount=21.50&payment_datetime=28-10-2021 10:55:21&payment_method=CCARD


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 suporte@ifthenpay.com

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

- Através da abertura de um ticket aqui