Page History

Versions Compared

Old Version 76

changes.mady.by.user Oksana Chizhikova

Saved on Nov 18, 2022

compared with

New Version Current

changes.mady.by.user Oksana Chizhikova

Saved on Jun 02, 2025

Key

This line was added.
This line was removed.
Formatting was changed.

...

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/No¹	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/No²	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.
CheckvalueCardPayment	Yes	String	Request validation code. ³	CustomerNumber	No	String	Merchant's internal customer identification (for payments in OneClick program).

...

No	1 – pay using bankcard; 0 – without using bankcard	1	A customer can perform his/her payment using bankcard, if parameter value 1 has been sent, or the parameter is missing (and bankcard payments are enable for the enterprise)
ERIPPayment	No	1 – payment with using ERIP; 0 – without using ERIP	1	A customer can perform his/her payment using ERIP, if parameter value 1 has been sent, or the parameter is missing (and ERIP payments are enable for the enterprise).
GooglePayPayment	No	1; 0	1	Payment via Google Pay attribute (=1)
ApplePayPayment	No	1; 0	1	Payment via Apple Pay attribute (=1)
SamsungPayPayment	No	1; 0	1	Payment via Samsung Pay attribute (=1)
Checkvalue	Yes	String		Request validation code. ³
CustomerNumber	No	String		Merchant's internal customer identification (for payments in OneClick program).

Anchor

	1
	1

¹ parameter BILL is not mandatory in case when automatic bill numbering is switched on.

Anchor

	2
	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.

Anchor

	3
	3

³ Check value is calculated by following formula:

uppercase(md5(uppercase(md5(SALT) + md5(Х)))), where SALT – secret word; Х – result of string concatenation (with semicolon (;) as delimiter) of the request parameters in order as they located in table from top to bottom excluding DelayPayment, SendNotification, Checkvalue and CustomerNumber, '+' – string concatenation.

When bill with the same number is already exist then new bill is not created and an error is returned: "Bill with the specified number already exists".

If request doesn't contain mandatory parameters or wrong data format provided the new bill is not created and an error is returned (similar to the error of order creation with not enough or wrong parameters).

When unique payment token/ID cannot be created the new bill is not created and an error is returned: "Unique payment token/ID cannot be created".

Information about using the 3-D Secure 2.0 protocol when creating a payment.

Example of bill creation request (HTTP POST):

Code Block

language	xml

<FORM ACTION="https://<SERVER-NAME>/bill/createbill.cfm" method="POST">
<INPUT TYPE="hidden" NAME="Merchant_ID" VALUE="

...

¹ parameter BILL is not mandatory in case when automatic bill numbering is switched on.

...

³ Check value is calculated by following formula:

uppercase(md5(uppercase(md5(SALT) + md5(Х)))), where SALT – secret word; Х – result of string concatenation (with semicolon (;) as delimiter) of the request parameters in order as they located in table from top to bottom excluding DelayPayment, SendNotification, Checkvalue and CustomerNumber, '+' – string concatenation.

When bill with the same number is already exist then new bill is not created and an error is returned: "Bill with the specified number already exists".

When unique payment token/ID cannot be created the new bill is not created and an error is returned: "Unique payment token/ID cannot be created".

Information about using the 3-D Secure 2.0 protocol when creating a payment.

Example of bill creation request (HTTP POST):

Code Block

language	xml

<FORM ACTION="https://<SERVER-NAME>/bill/createbill.cfm" method="POST">
<INPUT TYPE="hidden" NAME="Merchant_ID" VALUE="Your Merchant_ID">
<INPUT TYPE="hidden" NAME="Login" VALUE="Your login">
<INPUT TYPE="hidden" NAME="Password" VALUE="Your password">
<INPUT TYPE="hidden" NAME="Bill" VALUE="Bill number">
<INPUT TYPE="hidden" NAME="Bill_amount" VALUE="Bill amount">
<INPUT TYPE="hidden" NAME="Bill_currency" VALUE="Bill currency">
<INPUT TYPE="hidden" NAME="Bill_comment" VALUE="Bill comment">
<INPUT TYPE="hidden" NAME="Customer_Name" VALUE="Customer name">
<INPUT TYPE="hidden" NAME="Customer_Lastname" VALUE="Customer lastname">
<INPUT TYPE="hidden" NAME="Customer_Middlename" VALUE="Customer middlename">
<INPUT TYPE="hidden" NAME="Customer_Email" VALUE="Customer Email">
<INPUT TYPE="hidden" NAME="Customer_Phone" VALUE="Customer phone">
<INPUT TYPE="hidden" NAME="Customer_Mobile" VALUE="Customer mobile phone">
<INPUT TYPE="hidden" NAME="Language" VALUE="Language of authorized pages">
<INPUT TYPE="hidden" NAME="Pay_until" VALUE="Expire date of bill payment">
<INPUT TYPE="hidden" NAME="SendNotification" VALUE="Bill sending flag">
<INPUT TYPE="hidden" NAME="Checkvalue" VALUE="Request validation code">
<INPUT TYPE="Submit"></FORM>

...

Code Block

language	xml

<?xml version="1.0" encoding="UTF-8"?>
<Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Header/>
    <Body>
        <WSBillStatus><BillStatus>
            <Bill>
                <merchant_id>423422</merchant_id>
                <login>login</login>
                <password>password</password>
                <bill>123456</bill>
                <billnumber></billnumber>
            </Bill>
        </WSBillStatus>BillStatus>
    </Body>
</Envelope>

Example of results:

Code Block

language	xml

<soapenv:Envelope
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
        <ASS-NS:BillResponse xmlns:ASS-NS="http://www.paysecure.ru/ws/">
            <return xsi:type="si:SOAPStruct" xmlns:si="http://www.paysecure.ru/type/">
                <merchant_id xsi:type="xsd:string">515089</merchant_id>
                <bill xsi:type="xsd:string">20150610115527</bill>
                <bill_amount xsi:type="xsd:string">100.00</bill_amount>
                <bill_currency xsi:type="xsd:string">BYN</bill_currency>
                <bill_comment xsi:type="xsd:string">testbill</bill_comment>
                <bill_date xsi:type="xsd:string">06.07.2016 09:03:07</bill_date>
                <bill_status xsi:type="xsd:string">Invoiced</bill_status>
                <billNumber xsi:type="xsd:string"/>
                <payment_date xsi:type="xsd:string"></payment_date>
                <payment_amount xsi:type="xsd:string">0.00</payment_amount>
                <payment_currency xsi:type="xsd:string"/>
                <payment_rrn xsi:type="xsd:string"/>
                <refund_amount xsi:type="xsd:string"/>
                <customer_name xsi:type="xsd:string">test</customer_name>
                <customer_lastname xsi:type="xsd:string">testov</customer_lastname>
                <customer_middlename xsi:type="xsd:string"/>
                <customer_email xsi:type="xsd:string">test@testpost.by</customer_email>
                <customer_phone xsi:type="xsd:string"/>
                <customer_mobile xsi:type="xsd:string"/>
                <language xsi:type="xsd:string">EN</language>
                <pay_until xsi:type="xsd:string">0150611T0903</pay_until>
                <sendnotification xsi:type="xsd:string">0</sendnotification>
                <checkValue xsi:type="xsd:string">D9F0E4933007B96BCC2594983F7A24E3</checkValue>
            </return>
        </ASS-NS:BillResponse>
    </SOAP-ENV:Body>

Bill revocation request (billrevoke)

The service allows to revoke a bill that was not yet payed. Call of this service change the bill status to Deleted if it was in status Inviced or Timed out on moment of the request.

URL for bill revocation request:

https://<SERVER-NAME>/bill/billrevoke.cfm

...

:BillResponse>
    </SOAP-ENV:Body>

Bill revocation request (billrevoke)

The service allows to revoke a bill that was not yet payed. Call of this service change the bill status to Deleted if it was in status Inviced or Timed out on moment of the request.

URL for bill revocation request:

https://<SERVER-NAME>/bill/billrevoke.cfm

List of request parameters:

Parameter	Mandatory field	Adopted values	Default value	Description
Merchant_ID	Yes	Number		The merchant 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	String		Bill number
SendNotification	No	Number	Depending on merchant settings	Flag of sending notice of bill revocation (when this parameter is not passed in the request then the default setting for the merchant in IPS Assist is used).
Checkvalue	Yes	String		Request validation code (is calculated the same way as by bill creation, excluding Sendnotification and CheckValue)

Request example in HTTP POST format:

Code Block

language	xml

<FORM ACTION="https://test.paysecure.ru/bill/billrevoke.cfm" method="POST">
<INPUT TYPE="hidden" NAME="Merchant_ID" VALUE="Your Merchant_ID">
<INPUT TYPE="hidden" NAME="Login" VALUE="Your login">
<INPUT TYPE="hidden" NAME="Password" VALUE="Your password">
<INPUT TYPE="hidden" NAME="Bill" VALUE="Bill number">
<INPUT TYPE="hidden" NAME="SendNotification" VALUE="Notice sending flag">
<INPUT TYPE="hidden" NAME="Checkvalue" VALUE="Request validation code">
<INPUT TYPE="Submit"></FORM>

List of response parameters:

Parameter	Value
Bill	Bill number
Bill_status	Bill status

Results example in CSV format:

Code Block

language	xml

bill:2015.06.30 11:17-81; bill_status:Revoked

In XML format:

Code Block

language	xml

<?xml version='1.0' encoding='utf-8' standalone='yes'?>
<result firstcode="0" secondcode="0" count="1">
      <return>
          <bill>20150630111985</bill>
          <bill_status>Revoked</bill_status>
      </return>
</result>

SOAP web-service description:

https://<SERVER_NAME>/bill/billrevoke.wsdl

Example of bill revocation request:

Code Block

language	xml

<?xml version="1.0" encoding="UTF-8"?>
<Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Header/>
    <Body>
        <BillRevoke>
            <Bill>
                <merchant_id>423422</merchant_id>
                <login>login</login>
                <password>password</password>
                <bill>123456</bill>
                <sendnotification>0</sendnotification>
                <checkvalue> AA3BC3F48B7FE23988044B53AA98F169</checkvalue>
            </Bill>
        </BillRevoke>
    </Body>
</Envelope>

Results example:

Code Block

language	xml

<soapenv:Envelope
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
        <ASS-NS:BillResponse xmlns:ASS-NS="http://www.paysecure.ru/ws/">
            <return xsi:type="si:SOAPStruct" xmlns:si="http://www.paysecure.ru/type/">
                <bill xsi:type="xsd:string">20150610115527</bill>
                <bill_status xsi:type="xsd:string">Revoked</bill_status>
            </return>
        </ASS-NS:BillResponse>
    </SOAP-ENV:Body>

Messages templates

After bill creation, the client will receive the E-mail message that looks like the following:

Subj

The bill has been invoiced for payment

Text

Hello Test Testov,

We inform you that bill # 1c362fd on amount of 88.80 BYN has beeninvoicedfor payment.

You can pay it till 25.07.2016 18:00 (MSK).

To view and pay the bill go by link below.

https://payments.belassist.by/bill/paybill.cfm?ID=c2RmZ2UzNXkyNXR5MjU0

Please address internet-shop #1 at shop1@testpost.byin case of any questions concerning about this bill.

_____________

With best regards,

ASSIST

Customer Service Team

www.belassist.by

In case when bill was revoked the client will be also notified via E-mail by message looks like:

Subj

The bill was annulled

Text

Hello Test Testov,

We inform you that bill # 1c362fd on amount of 88.80 BYN was annulled.

Please address internet-shop #1 at shop1@testpost.byin case of any questions concerning about this bill.

_____________

With best regards,

ASSIST

Customer Service Team

www.belassist.by

Note
If necessary, the customer can create his request by a simple reply to the received E-mail. If the merchant specified several addresses as the address for customer requests when connecting to the IPS Assist, then the E-mail will be sent to all these addresses.

Messages' templates can be tuned individually for the enterprise. Please, contact the Assist support team for it: support@belassist.by.

Back on top

Content

Space Tools

Versions Compared

Old Version 76

New Version Current

Key

Bill revocation request (billrevoke)

Bill revocation request (billrevoke)

Messages templates