API connection
The connection to the PayByMail API is a secure connection that is protected by IP address (optional), an Extended Validation SSL certificate and a username and password combination that must be supplied as ‘basic authentication’ header. To create a connection, the following things must be arranged:
| SUBJECT | DESCRIPTION |
|---|---|
| IP Address | The IP address(es) of the server that connects to the PayByMail system must be supplied to the PayByMail or Entity administrator. He can enter these addresses in the system so that connections that are created from other IP addresses will be refused. |
Username | An API user must be created within the PayByMail system with its own unique username and corresponding password. These values must be used to create a secure connection. |
Connection URL's
The URLs to connect to the PayByMail system for payments:
- Test environment: https://testpbmapi.icepay.com/payment/<command>
- Production environment: https://pbmapi.icepay.com/payment/<command>
The URLs to connect to the PayByMail system for mandates:
- Test environment: https://testpbmapi.icepay.com/mandate/<command>
- Production environment: https://pbmapi.icepay.com/mandate/<command>
The URLs to connect to the PayByMail system for direct collects:
- Test environment: https://testpbmapi.icepay.com/collect/<command>
- Production environment: https://pbmapi.icepay.com/collect/<command>
The <command> value can be replaced by any trusted command that are described next.
Date updated: 2022-10-31
