Purpose and main features of bills
Services for invoicing and payment of bills provides a simple way of processing a payment by link (URL) which client can use to follow and make a payment on order in IPS Assist. The merchant calls the service of bill creation (providing info about bill number, amount, payment timeout and etc.), IPS Assist makes a bill record and payment token associated to this bill. A bill also can be created manually within the personal account (https://account.paysec.by/). IPS Assist sends the link with the payment token to customer via E-mail or the enterprise generates an URL using the received payment token, and redirects the customer to the bill payment page. The enterprise also can send the payment link to customer via E-mail, SMS or via other means of communication from its own side. Payment link looks like the following:
https://<SERVER_NAME>/bill/paybill.cfm?ID=c2RmZ2UzNXkyNXR5MjU0
When the client follows by the link and agrees to pay the bill IPS Assist creates order. Next, the client enters his payment mean data and performs a payment similarly to the standard order payment.
This manual describes services for bill creation, cancellation of bill payment, bill information requests and process of payment. It also covers the questions of setting up of interaction with those services of IPS Assist.
Procedure of connection to bill invoicing and payment services for merchant
- send a request for connection to bill services to the Assist support team (support@belassist.by);
- receive the confirmation from Assist support team that all necessary settings are done for the merchant.
Bill creation service (createbill)
The service accepts the bill parameters in HTTP POST/SOAP or JSON (swagger specification: https://docs.belassist.by/swagger/) format and returns (in case of successful bill creation) a payment token/ID corresponding to that bill. The enterprise can make a payment link using this payment token/ID to redirect the customer to the bill payment page or send it to customer from its own side (E-mail, SMS or other type of communications), or IPS Assist can send it by E-mail customer's address specified in the parameters.
URL for the request:
https://<SERVER-NAME>/bill/createbill.cfm
List of request parameters:
Parameter | Mandatory field | Adopted values | Default value | Description |
Merchant_ID | Yes | Number | The enterprise identifier in IPS Assist | |
Login | Yes | 8 - 20 characters | Login (Latin letters, digits and symbol _) | |
Password | Yes | 8 - 20 characters | Password (Latin letters and digits) | |
Bill | Yes/No1 | String | Bill number (in creating order will be used as OrderNumber) | |
Bill_amount | Yes | 15 digits, two digits after the delimiter (delimiter '.') | Bill amount (OrderAmount in order) | |
Bill_currency | Yes | String | Bill currency (OrderCurrency) | |
Bill_comment | No | String | Comment (OrderComment in order) | |
Customer_Name | No | String | Customer's name (FirstName in order) | |
Customer_Lastname | No | String | Customer's last name (LastName in order) | |
Customer_Middlename | No | String | Customer's middle name (MiddleName in order) | |
Customer_Email | Yes/No2 | String | Customer's e-mail (Email in order) | |
Customer_Phone | No | String | Customer's phone number (HomePhone in order) | |
Customer_Mobile | No | String | Customer's mobile phone number (MobilePhone in order) | |
Language | No | RU EN | Setting of basic merchant account language | Language of authorized pages |
Pay_until | No | Date/time | 1 day | Expire date of bill payment (date and time in GMT): YYYYMMDDThhmm, when parameter is not passed then its value is calculated based on merchant settings |
DelayPayment | No | Number | 0 | Attribute of a credit card authorization for the double-stage operation mode (parameter delay in order): 0- one-stage operation, 1 - double-stage operation. |
SendNotification | No | Number | Depending on merchant settings | Bill sending by E-mail: 0 – not send, 1 – send by E-mail, 2 – send by SMS, 3 - send by E-mail and by SMS. |
| URL_RETURN | No | 256 characters | Page URL, to where a customer should return after performing his/her payment in the system (option "Go to the shop page" should be enabled in merchant's settings in Personal account). ). It is recommended to use HTTPS protocol for secure communication. | |
| URL_RETURN_OK | No | 256 characters | URL_RETURN parameter value, or, if none, return URL parameter after successful authorization, specified in Personal account | Page URL, to where a customer should return after successful performing his/her payment in IPS Assist (option "Go to the shop page" should be enabled in merchant's settings in Personal account)). It is recommended to use HTTPS protocol for secure communication. |
| URL_RETURN_NO | No | 256 characters | URL_RETURN parameter value, or, if none, return URL specified in Personal account | Page URL, to where a customer should return if the payment is not performed in IPS Assist or payment is still in progress (current payment status "In Progress"), see details. The option "Go to the shop using return URL" should be enabled in merchant's settings in Personal account. It is recommended to use HTTPS protocol for secure communication. |
Checkvalue | Yes | String | Request validation code. 3 | |
CustomerNumber | No | String | Merchant's internal customer identification (for payments in OneClick program). |
1 parameter BILL is not mandatory in case when automatic bill numbering is switched on.
2 If the value of the E-mail address is not sent, sending the bill by E-mail is not possible. If the value of phone number is not sent, sending the SMS is not possible. Note. For SendNotification= 3, if there is no phone number in the request, then the link to the bill will be sent only by E-mail; and if there is no E-mail address in the request, the notification will not be performed at all.
3 Check value is calculated by following formula: