Integração da API via POST: 


Nota: Para usar esta API necessita de uma mbKey fornecida pela Ifthenpay. Se ainda não tiver nenhuma mbKey solicite-nos uma.


URL do EndPoint Produção:

https://ifthenpay.com/api/multibanco/reference/init


URL do EndPoint Sandbox: (todos os testes devem ser efetuados através da sandbox) *

https://ifthenpay.com/api/multibanco/reference/sandbox


Para uma utilização responsável do serviço recomendamos SEMPRE a utilização da sandbox para testes. A utilização abusiva  da API de produção poderá gerar um bloqueio na conta utilizada.



Formato do pedido em Json (Body) 


{

    "mbKey": "MBK-000000",

    "orderId": "order-1234",

    "amount": "1234.56",

    "description": "DESCRICAO",

    "url": "URL_LOJA_SITE",

    "clientCode": "",

    "clientName": "",

    "clientEmail": "",

    "clientUsername": "",

    "clientPhone": "",

    "expiryDays" : 3

}


Definição dos parâmetros:


mbKey: (obrigatório) - Multibanco Key atribuída pela ifthenpay.

orderId: (obrigatório) -  Número da encomenda/fatura até ao máximo de 15 caracteres.

amount: (obrigatório) - Valor a cobrar na referência. Separador decimal "." (Ex: "1234.56")

description: (opcional) -  Breve descrição até ao máximo de 200 caracteres.

url: (opcional) - Endereço web até ao máximo de 200 caracteres.

clientCode: (opcional) - Código do vosso cliente até ao máximo de 200 caracteres.

clientName: (opcional) -  Nome do vosso cliente até ao máximo de 200 caracteres.

clientEmail: (opcional) -  Email do vosso cliente até ao máximo de 200 caracteres.

clientUsername: (opcional) - Username do vosso cliente até ao máximo de 200 caracteres.

clientPhone: (opcional) -  Telemóvel/telefone do vosso cliente até ao máximo de 200 caracteres.

expiryDays:  (opcional) - Número de dias de validade. Valores aceites em dias: 0, 1, 2, 3, 4, 5... até 31, 45, 60, 90, 120, 180, 365, 730                             


Exemplo do número de dias de validade:

expiryDays: 0 - validade até às 24h do próprio dia. Nas restantes opções a validade será a soma do número de dias indicados à data de geração da referência (até às 23:59h).


(Ex: expiryDays: 1 - Validade até às 23.59h do dia seguinte)


Notas Importantes:


Se o número de dias enviado for diferente dos indicados acima, será atribuído o dia imediatamente a seguir disponível. 

(Ex: 155 será atribuída a validade de 180 dias).


Se não pretender validade na referência deverá omitir o parâmetro "expiryDays" no pedido.


Formato da resposta (Json):


{

    "Amount": "1234.56",

    "Entity": "11990",

    "ExpiryDate": "30-10-2021",

    "Message": "Success",

    "OrderId": "order-1234 ",

    "Reference": "000000291",

    "RequestId": "5Qd8gtWLAEUJ6n0lkS5g",

    "Status": "0" 

}


Em caso do parâmetro "Status" <> "0", verificar o motivo no parâmetro "Message".


Para o exemplo acima a informação apresentar ao cliente seria:


Entidade: 11990

Referência: 000000291

Valor: 1234.56


Data limite de pagamento: 30-10-2021



CALLBACK (Webhook)

 

Aconselhamos sempre definir um url de callback e uma chave antiphishing com a ifthenpay, dessa forma, e 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]&orderId=[ORDER_ID]&amount=[AMOUNT]&requestId=[REQUEST_ID]&entity=[ENTITY]&reference=[REFERENCE]&payment_datetime=[PAYMENT_DATETIME]


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

http://www.yoursite.com/callback.php?key=my_anti_phishing_key&orderId=order-1234&amount=1234.56&requestId=5Qd8gtWLAEUJ6n0lkS5g&entity=11990&reference=075000291&payment_datetime=28-10-2021 10:55:21


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