Versions Compared

Key

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

...

Parameter

Mandatory field

Adopted values

Default values

Description

Billnumber

Yes

15 or 16 digits, extended payment number


Unique number of payment corresponding to the order number in IPS Assist; extended payment number can be passed

Merchant_ID

Yes

Number


The enterprise identifier in IPS Assist

Login

Yes

20 characters


Login (Latin letters, digits and symbol _)

Password

Yes

30 characters


Password (Latin letters and digits)

Amount

No*

15 digits, two digits after the delimiter (delimiter '.')


The amount of financial confirmation

Currency

No*

3 characters


Confirmation currency code. Only the currency code of the payment operation can be used.

ClientIP

No



IP-address of the operator's computer that confirms the payment 

Language

No

RU – Russian
EN – English

RU

Language of the results output

Format

No

1 – CSV (delimited fields)
3 – XML
4 – SOAP
5 - JSON

1

Format of the results output. Format of the results output. If the request is sent in SOAP or in JSON format, then the response will also be in SOAP or in JSON respectively, in other cases, in accordance with the passed format value.

AutoDepositNo1 – flag on
0 – flag off

Online deposit flag. It is used in cases when it is necessary to immediately unblock the unconfirmed part of the order amount.

Note
titleNote

It is necessary to find out whether the merchant can work with online deposit, please, contact the support service (support@belassist.by) for this.

 

* The parameters Amount and Currency can be passed or missed in the request only simultaneously. If the above parameters are missing, the full amount confirmation operation will be performed.

...

Parameter

Value

ordernumber

Order number

responsecode

Response code

recommendation

Recommendations

message

Message

ordercomment

Comment

orderdate

Date of order

amount

Operation amount

currency

Currency of operation

meantypename

Type of payment means

meannumber

Number of payment means

lastname

Payer's last name

firstname

Payer's first name

middlename

Payer's middle name

issuebank

Name of issue bank

Email

Payer's e-mail

bankcountry

Country of issue bank

rate

Currency rate

approvalcode

Authorization code

meansubtype

Payment means subtype

cardholder

Payment means holder

cardexpirationdate

Card expired date

ipaddress

Payer's IP-address

protocolname

Protocol

testmode

Test mode

customermessage

Result message for a customer

orderstate

Order state

processingname

Processing

operationtype

Operation type

billnumber

Billnumber extended format

orderamount

Original amount of operation

ordercurrency

Original currency of operation

slipno

Financial transaction identifier

packetdate

Request issue date

signature

The X value without delimiters, signed with IPS Assist private key, encoded in BASE64, where X - billnumber,ordernumber,responsecode,orderamount,ordercurrency,meannumber,approvalcode,orderstate,packetdate 

Examples

Request example for HTTP POST format:

Code Block
languagexml
<FORM ACTION="https://<SERVER-NAME>/charge/charge.cfm" METHOD="POST">
<INPUT TYPE="HIDDEN" NAME="BillNumber" VALUE="545000000000001">
<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="Amount" VALUE="100">
<INPUT TYPE="HIDDEN" NAME="Currency" VALUE="BYN">
<INPUT TYPE="HIDDEN" NAME="Language" VALUE="0">
<INPUT TYPE="HIDDEN" NAME="Format" VALUE="3">
<INPUT TYPE="SUBMIT" NAME="Submit" VALUE="Execute">
</FORM>

The result of payment financial confirmation request in CSV format:

Code Block
languagexml
ordernumber: 0001-01 responsecode: AS000 recommendation: message: Completed. ordercomment: test payment orderdate: 01.01.2011 09:00:05 amount: 100.00 currency: BYN meantypename: VISA meannumber: 411111****1111 lastname: Testov firstname: Test middlename: Testovich issuebank: BANK email: test@testpost.by bankcountry: Russia rate: 1 approvalcode: meansubtype: Corporate Purchasing Card cardholder: TEST cardexpirationdate:12/20 ipaddress: 111.23.11.23 protocoltypename: testmode: 1 customermessage: Completed. orderstate: Approved processingname: Name operationtype: 200 billnumber: 511111100000001.2 orderamount: 100.00 ordercurrency: RUB slipno: 111111 packetdate: 01.01.2011 09:01:47 signature:

In XML format:

Code Block
languagexml
<?xml version='1.0' encoding='utf-8' standalone='yes'?>
<!DOCTYPE result [
<!ATTLIST result
          firstcode CDATA #REQUIRED
          secondcode CDATA #REQUIRED
          count CDATA #REQUIRED>
<!ELEMENT result (orders?)>
<!ELEMENT orders (order)>
<!ELEMENT order (ordernumber?, responsecode?, recommendation?, message?, ordercomment?, orderdate?, amount?, currency?, meantypename?, meannumber?, lastname?, firstname?, middlename?, issuebank?, email?, bankcountry?, rate?, approvalcode?, meansubtype?, cardholder?, cardexpirationdate?, ipaddress?, protocoltypename?, testmode?, customermessage?,  orderstate?, processingname?, operationtype?, billnumber?, orderamount?, ordercurrency?, slipno?, packetdate?, signature?, pareq?, acsurl?)>
<!ELEMENT ordernumber (#PCDATA)>
<!ELEMENT responsecode (#PCDATA)>
<!ELEMENT recommendation (#PCDATA)>
<!ELEMENT message (#PCDATA)>
<!ELEMENT ordercomment (#PCDATA)>
<!ELEMENT orderdate (#PCDATA)>
<!ELEMENT amount (#PCDATA)>
<!ELEMENT currency (#PCDATA)>
<!ELEMENT meantypename (#PCDATA)>
<!ELEMENT meannumber (#PCDATA)>
<!ELEMENT lastname (#PCDATA)>
<!ELEMENT firstname (#PCDATA)>
<!ELEMENT middlename (#PCDATA)>
<!ELEMENT issuebank (#PCDATA)>
<!ELEMENT email (#PCDATA)>
<!ELEMENT bankcountry (#PCDATA)>
<!ELEMENT rate (#PCDATA)>
<!ELEMENT approvalcode (#PCDATA)>
<!ELEMENT meansubtype (#PCDATA)>
<!ELEMENT cardholder (#PCDATA)>
<!ELEMENT cardexpirationdate (#PCDATA)>
<!ELEMENT ipaddress (#PCDATA)>
<!ELEMENT protocoltypename (#PCDATA)>
<!ELEMENT testmode (#PCDATA)>
<!ELEMENT customermessage (#PCDATA)>
<!ELEMENT orderstate (#PCDATA)>
<!ELEMENT processingname (#PCDATA)>
<!ELEMENT operationtype (#PCDATA)>
<!ELEMENT billnumber (#PCDATA)>
<!ELEMENT orderamount (#PCDATA)>
<!ELEMENT ordercurrency (#PCDATA)>
<!ELEMENT slipno (#PCDATA)>
<!ELEMENT packetdate (#PCDATA)>
<!ELEMENT signature (#PCDATA)>
<!ELEMENT pareq (#PCDATA)>
<!ELEMENT acsurl (#PCDATA)>]>
 <result firstcode="0" secondcode="0" count="1">
<orders> <order>
<ordernumber> 0001-01 </ordernumber>
<responsecode> AS000 </responsecode>
<recommendation>  </recommendation>
<message> Completed. </message>
<ordercomment> test payment </ordercomment>
<orderdate> 06.07.2016 10:51:53 </orderdate>
<amount> 100.00 </amount>
<currency> BYN </currency>
<meantypename> VISA </meantypename>
<meannumber> 411111****1111 </meannumber>
<lastname> Testov </lastname>
<firstname> Test </firstname>
<middlename> Testovich </middlename>
<issuebank> BANK </issuebank>
<email> test@testpost.by </email>
<bankcountry> Russia </bankcountry>
<rate> 1 </rate>
<approvalcode>  </approvalcode>
<meansubtype> Corporate Purchasing Card </meansubtype>
<cardholder> TEST </cardholder>
<cardexpirationdate> 12/20 </cardexpirationdate>
<ipaddress> 10.23.10.23 </ipaddress>
<protocoltypename>  </protocoltypename>
<testmode> 1 </testmode>
<customermessage> Completed. </customermessage>
<orderstate> Approved </orderstate>
<processingname> Name </processingname>
<operationtype> 200 </operationtype>
<billnumber> 511111100000001.2 </billnumber>
<orderamount> 100.00 </orderamount>
<ordercurrency> BYN </ordercurrency>
<slipno>111111</slipno>
<packetdate> 06.07.2016  10:53:45 </packetdate>
<signature> </signature>
</order> </orders>
</result>

Six first and last four digits of the card number are returned as the field <cardnumber> value here and after in all Web services; the remaining figures being hidden under * symbol.

If the payment is successfully confirmed, the field "orderstate" will contain the value Approved or PartialDelayed, the confirmation operation response_code is AS000. If the payment confirmation is not confirmed, the response_code will adopt the values AS100- AS998.

If the payment confirmation request cannot be processed, the request will return non-zero values of the firstcode, secondcode parameters.

An example of a result request in XML format which returned an error (wrong password):

Code Block
languagexml
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<!DOCTYPE result (View Source for full doctype...)>
<result firstcode="7" secondcode="102" count="0"></result>

For description of the first and second codes of the automated interfaces refer to table "Error codes".

In SOAP format:

Code Block
languagexml
<?xml version='1.0' encoding='utf-8' standalone='no'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/' 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:MakeChargeResponse xmlns:ASS-NS='http://www.paysecure.ru/message/'> 
<return xmlns:si='http://www.paysecure.ru/type/' xsi:type='si:SOAPStruct'>
<ordernumber xsi:type='xsd:string'>0001-01</ordernumber>
<responsecode xsi:type='xsd:string'>AS000</responsecode>
<recommendation xsi:type='xsd:string'></recommendation>
<message xsi:type='xsd:string'>Completed.</message>
<ordercomment xsi:type='xsd:string'>test payment</ordercomment>
<orderdate xsi:type='xsd:string'>06.07.2016 11:23:13</orderdate>
<amount xsi:type='xsd:string'>100.00</amount>
<currency xsi:type='xsd:string'>BYN</currency>
<meantypename xsi:type='xsd:string'>VISA</meantypename>
<meannumber xsi:type='xsd:string'>411111****1111</meannumber>
<lastname xsi:type='xsd:string'>Testov</lastname>
<firstname xsi:type='xsd:string'>Test</firstname>
<middlename xsi:type='xsd:string'>Testovich</middlename>
<issuebank xsi:type='xsd:string'>New Bank</issuebank>
<email xsi:type='xsd:string'>test@testpost.by</email>
<bankcountry xsi:type='xsd:string'>Russia</bankcountry>
<rate xsi:type='xsd:string'>1</rate>
<approvalcode xsi:type='xsd:string'></approvalcode>
<meansubtype xsi:type='xsd:string'>Classic</meansubtype>
<cardholder xsi:type='xsd:string'>TEST</cardholder>
<cardexpirationdate xsi:type='xsd:string'>12/20</cardexpirationdate>
<ipaddress xsi:type='xsd:string'>11.23.11.23</ipaddress>
<protocoltypename xsi:type='xsd:string'></protocoltypename>
<testmode xsi:type='xsd:string'>1</testmode>
<customermessage xsi:type='xsd:string'>Completed.</customermessage>
<orderstate xsi:type='xsd:string'>Approved</orderstate>
<processingname xsi:type='xsd:string'>Name</processingname>
<operationtype xsi:type='xsd:string'>200</operationtype>
<billnumber xsi:type='xsd:string'>511111100000001.2</billnumber>
<orderamount xsi:type='xsd:string'>100.00</orderamount>
<ordercurrency xsi:type='xsd:string'>BYN</ordercurrency>
<slipno xsi:type='xsd:string'>111111</slipno>
<packetdate xsi:type='xsd:string'>06.07.2016 11:28:26</packetdate>
<signature xsi:type='xsd:string'></signature>
</return>
</ASS-NS:MakeChargeResponse></SOAP-ENV:Body>  </SOAP-ENV:Envelope>
Warning
titleAttention!

The following root certificates have to be installed on the requester side in the Trusted Root Certification Authorities Store for correct work with WEB-services via secure communication over TLS:

Before to start, check the presence of these certificates in the trust store and add tit if necessary.

Back on top