API Documentation
Overview
The ifthenpay API allows you to easily generate payment references, receive notifications and query payments data. In order to make requests to our endpoints in test mode, please contact us and ask us for test keys for your desired payment methods.
To subscribe ifthenpay services, please fill in the following form.
Multibanco REST
Multibanco is a widely used payment system in Portugal that allows customers to pay for goods and services through ATMs, online banking, or mobile banking apps. It provides a secure and convenient way to make payments using a unique entity and reference number generated for each transaction. This system supports various payment types and is commonly integrated into e-commerce platforms to offer an offline payment option for customers.
To integrate with this API you will need an MB KEY assigned by ifthenpay to the merchant. If you do not have this MB KEY, please contact ifthenpay.
Go to Multibanco documentation
MB WAY REST
MB WAY is a popular digital payment solution in Portugal that allows users to make payments, send money, and withdraw cash using just their mobile phones. It is integrated with the Multibanco network and enables quick and secure transactions through a mobile app, without the need for physical cards. MB WAY is widely used for online shopping, in-store payments, bill splitting, and even ATM withdrawals, offering a versatile and user-friendly alternative for digital payments.
To integrate with this API you will need an MBWAY KEY assigned by ifthenpay to the merchant. If you do not have this MBWAY KEY, contact ifthenpay.
Payshop REST
Payshop is a convenient payment method in Portugal that allows customers to pay for goods and services at various physical locations such as kiosks, convenience stores, and other authorized agents. This cash-based payment solution is ideal for those who prefer not to use digital payment methods or credit cards. It enables users to make payments by presenting a unique Payshop reference code generated during the checkout process.
To integrate with this API you will need an PAYSHOP KEY assigned by ifthenpay to the merchant. If you do not have this PAYSHOP KEY, contact ifthenpay.
Credit Card REST
Credit Card payments are a widely used and secure payment method that allows customers to make purchases using their Visa, MasterCard, or other credit cards. It offers convenience and flexibility, supporting both online and in-store transactions. To integrate credit card payments through this API, merchants will need a CCARD KEY provided by Ifthenpay. This key is essential for securely processing credit card transactions within your platform.
To integrate with this API you will need an CCARD KEY assigned by ifthenpay to the merchant. If you do not have this CCARD KEY, contact ifthenpay.
Go to Credit Card documentation
Google Pay & Apple Pay REST
Google Pay is a widely used digital wallet and payment platform that allows users to make payments, send money, and manage loyalty cards directly from their mobile devices. It provides a fast and secure way to complete transactions online, in apps, and at physical stores using NFC technology. With robust encryption and tokenization, Google Pay ensures a seamless and safe payment experience, eliminating the need for physical cards. It is compatible with both Android and iOS devices, making it a versatile solution for modern digital payments.
Apple Pay is a secure and convenient digital payment service designed for Apple devices, allowing users to make payments in stores, online, and within apps. Using NFC technology, biometric authentication (Touch ID or Face ID), and tokenization, Apple Pay ensures fast, private, and highly secure transactions. It works seamlessly with iPhones, iPads, Apple Watches, and Macs, offering a smooth and reliable payment solution for consumers and businesses alike.
To integrate with this Payment Methods you will need to use Pay by Link & Pinpay API and you will need an GATEWAY KEY, GOOGLE KEY and APPLE KEY assigned by ifthenpay to the merchant. If you do not have this KEYS, contact ifthenpay.
Go to Pay by Link & Pinpay documentation
Cofidis Pay REST
Cofidis Pay is a payment solution that offers customers the option to finance their purchases through installment payments, making it easier to manage larger transactions. This method provides flexibility and convenience, allowing buyers to spread the cost over time. For merchants, integrating Cofidis Pay can help increase conversion rates and average order values by offering an alternative payment method tailored for customers seeking financing options.
To integrate with these payment methods, you will need to use the Pay by Link & Pinpay API and obtain a GATEWAY KEY, GOOGLE KEY, and APPLE KEY assigned by ifthenpay to the merchant. If you do not have this COFIDIS KEY, contact ifthenpay.
Go to Cofidis Pay documentation
Direct Debit REST
Direct Debit is a payment solution that allows merchants to collect payments directly from customers' bank accounts on a scheduled basis. This method is ideal for recurring payments such as subscriptions, utilities, or installment plans, providing convenience for customers and predictable cash flow for businesses. By automating the payment process, Direct Debit reduces the risk of missed payments and ensures timely collection, helping businesses manage their finances more efficiently and improve customer retention through a seamless and reliable payment experience.
To integrate with this API you will need an DD KEY assigned by ifthenpay to the merchant. If you do not have this DD KEY, contact ifthenpay.
Go to Direct Debit documentation
Pix REST
PIX is an instant payment solution developed by the Central Bank of Brazil, allowing users to make secure and real-time transactions, 24/7, through their mobile devices. This convenient and fast payment method eliminates the need for traditional bank transfers or card transactions, offering seamless payments within seconds. For merchants, integrating PIX can enhance the customer experience, reduce cart abandonment, and streamline payment processing by providing an easy, cost-effective alternative that appeals to a broad range of customers seeking quick, flexible payment options.
To integrate with this API you will need an PIX KEY assigned by ifthenpay to the merchant. If you do not have this PIX KEY, contact ifthenpay.
Pay by Link & Pinpay REST
PAY BY LINK is a simple and secure payment method where a merchant generates a unique payment link and shares it with a customer via email, SMS, or any messaging platform. The customer clicks the link, which directs them to a secure payment page where they can complete the transaction using their preferred payment method, such as a credit card, MB WAY, or others. This method is particularly useful for remote sales, customer support transactions, or any scenario where direct payment on a website is not feasible. It provides convenience for both customers and merchants, offering a seamless payment experience without the need for direct integration into an e-commerce platform.
PINPAY is an innovative service that simplifies and speeds up the payment process for invoices, services, purchases, and other transactions. The core of this service is the use of a unique PIN code that, once validated, guides the user to select their preferred payment method, providing all the necessary information to complete the payment securely. This solution is particularly useful for scenarios such as over-the-phone sales, on-site services, or other situations where a secure and efficient payment method is needed.
To integrate with this API you will need an GATEWAY KEY assigned by ifthenpay to the merchant. If you do not have this GATEWAY KEY, contact ifthenpay.
Go to Pay by Link & Pinpay documentation
List of Payments SOAP
As an alternative or in addition to the callback (webhook), you can get a list of payments using this API.
Go to List of Payments SOAP documentation
List of Payments REST new
As an alternative or in addition to the callback (webhook), you can get a list of payments using this API.
Go to List of Payments REST documentation
Refunds REST
This API only allows refunds of MB WAY and Credit Cards payments.
Guides
Callback & Notifications
To receive notifications when a payment is confirmed, you must provide ifthenpay with your callback URL (webhook) for each payment method.
Go to Callback & Notifications documentation
Simple Checkout new
A Simple Checkout Link is a straightforward way for businesses to accept online payments without needing extensive technical knowledge. By using this link, merchants can direct customers to a secure payment page hosted by ifthenpay, where they can easily complete their transactions.
The link can be customized with important details such as the order amount, description, and language preferences, allowing for a tailored checkout experience. This method is user-friendly, quick to set up, and requires no complex integrations or APIs, making it an ideal solution for small businesses and individuals looking to sell products or services online. Overall, Simple Checkout Links streamline the payment process, enhancing convenience for both merchants and customers.
Configure the simple checkout link to complete the payment without the need to use an API, adjusting only the necessary parameters.
Go to Simple Checkout documentation
Multibanco Offline Algorithm
To integrate through this process you will need an entity code (5 numeric digits) and a sub-entity code (3 numeric digits) assigned by ifthenpay to the merchant. If you do not have this entity and sub-entity, contact ifthenpay.
Go to Multibanco Offline Algorithm documentation
E-commerce Integrations
You can find e-commerce integrations, including those for Shopify, Magento, PrestaShop, BigCommerce, Joomla, OpenCart, and more, in our GitHub repository. If you need assistance, please contact ifthenpay.
FAQ
Need Help? Check Our FAQ Section!If you have any questions or need assistance with using the Ifthenpay API, our FAQ section is a great place to start. It provides answers to common questions about integration, supported payment methods, testing, security, and more.
Visit our FAQ section to find quick and helpful answers to make your integration process smoother and more efficient!
Support
ifthenpay offers free technical support to all customers through the following channels:- E-mail: suporte@ifthenpay.com
- Phone: +351 227 660 871 | 808 222 777
- Helpdesk: submit a ticket
- Site: ifthenpay.com
This document was updated on December 5, 2024.