www.assist.ru

Versions Compared

Old Version 55

changes.mady.by.user Oksana Chizhikova

Saved on

compared with

New Version Current

changes.mady.by.user Oksana Chizhikova

Saved on

Key

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

Web Service Description

URL for HTTP POST: https://<SERVER-NAME>/cancel/cancel.cfm.URL for SOAP: https://<SERVER-NAME>/cancel/wscancel.cfm

...

titleIf the merchant makes use of the "THANK YOU" Sberbank Bonus Program

...

, when sending parameters in JSON format, see swagger description: https://docs.assist.ru/swagger/. 

List of request parameters:

Parameter

Mandatory field

Adopted values

Default value

Description

Billnumber

Yes

15 or 16 digits; extended format


Unique number of payment corresponding to the order number in IPS Assist; extended payment number can be passed only if the cheque is not transferred in the order.

Merchant_ID

Yes

Number


The enterprise identifier in IPS Assist

Login

Yes

8-20 character string


Login (Latin letters, digits and symbol _)

Password

Yes

8-20 character string


Password (Latin letters and digits)

Amount

No*1

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

Authorization amount

Refund amount

Currency

No*1

3 characters

Authorization currency code

Cancellation and refund currency code. Only the authorization currency code can be used

CancelReason

No

1 – Declined by shop
2 – Declined by customer
3 – Fraud operation

2

Reason of cancellation or refund

Language

No

RU – Russian
EN – English

RU

Language of the results output

ClientIP

No



IP-address of the operator performing the cancellation/refund

Format

No

1 – CSV
3 – XML
4 – SOAP
5 - JSON

Format of input data4

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.

Externalrefundid

No**2

10 to 100 characters (allowed characters are [A-Za-z0-9\-_]


External refund ID (unique value within one order)

Anchor
1
1


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

Anchor
2
2


2** The parameter is used only for the wscancel service and JSON and for JSON and SOAP formats.

Multiexcerpt include
MultiExcerptNameval
PageWithExcerptDoc blocks

...

Interface for HTTP POST - format (cancel)format 

An example of HTTP POST request for the payment cancellation by bankcard:

Code Block
languagexml
<FORM ACTION="https://<SERVER-NAME>/cancel/cancelwscancel.cfm" method="POST">
<INPUT TYPE="hidden" NAME="BillNumber" VALUE="511111100000001">
<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="amount">
<INPUT TYPE="hidden" NAME="Currency" VALUE="Currency">
<INPUT TYPE="hidden" NAME="ClientIP" VALUE="IP-address">
<INPUT TYPE="hidden" NAME="Language" VALUE="Language of result output">
<INPUT TYPE="hidden" NAME="Format" VALUE="Result output format">
<INPUT TYPE="Submit"></FORM>

...

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 status

processingname

Processing

operationtype

Operation type

billnumber

Extended format of Billnumber

orderamount

Original amount of operation

ordercurrency

Original currency of operation

slipno

Financial transaction identifier

packetdate

Request issue date

of operation

slipno

Financial transaction identifier

packetdate

Request issue date

signature

Signature. Signature. It is generated according to the following algorithm:

1) A combined string is created from the parameters (in their string representation, in the format as they are passed in the response): billnumber, ordernumber, responsecode, orderamount, ordercurrency, meannumber, approvalcode, orderstate, packetdate (without delimiters).
2) The received string is signed with IPS Assist private key.
3) The resulting byte sequence is encoded in BASE64.

signature

Signature. Signature. It is generated according to the following algorithm:

An example of request result of payment cancellation or refund in XML format

...

Parameter

Value

Order parameters (section <order>)

billnumber

Unique order number in IPS Assist

ordernumber

Order number

testmode

Test mode

ordercomment

Comment

orderamount

Original amount of order

ordercurrency

Original currency of order

rate

Currency rate

orderdate

Date of order (GMT)

orderstate

Order status

Payer data (section <customer>)

firstname

Payer's first name

lastname

Payer's last name

middlename

Payer's middle name

email

Payer's e-mail

Operation parameters (repeated section <operation>)

billnumber

Extended format of Billnumber: billnumber.<operation number>

operationtype

Operation type

operationstate

Operation status

amount

Operation amount

currency

Currency of operation

ipaddress

Payer's IP-address

meantype_id

Payment means ID

meansubtype

Payment  means subtype

meannumber

Number of payment means

cardholder

Payment means holder

cardexpirationdate

Card expired date

issuebank

Name of issue bank

bankcountry

Country of issue bank

responsecode

Response code

message

Operation result message

customermessage

Result message for a customer

recommendation

Recommendations

approvalcode

Authorization code

protocoltypename

Protocol

processingname

Processing

operationdate

Operation date and time (GMT)

slipno

Financial transaction identifier

Data packet properties (in section <result>)

packetdate

Request issue date (GMT)

signature

Signature. Signature is calculated by . It is generated according to the following algorithm:

1. The following order ) A combined string is created from the parameters (in their string representations representation, in the format as they are provided passed in the replayresponse): billnumber, ordernumber, responsecode, amountorderamount, currencyordercurrency, meannumber, approvalcode, orderstate, packetdate are joined in one string without any delimiter (without delimiters).
2. Resulting ) The received string is signed by the with IPS Assist private RSA key of IPS Assist.
3. Resulting bit ) The resulting byte sequence is transferred as BASE64 coded string in signature fieldencoded in BASE64.

Multiexcerpt include
MultiExcerptNameslipno
PageWithExcerptDoc blocks

...

Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.paysecure.ru/ws/">
    <soapenv:Body><ws:WSCancelResponseParams>
        <order>
            <billnumber>500000210031071</billnumber>
            <ordernumber>14092012-002</ordernumber>
            <testmode>0</testmode>
            <ordercomment>тестовый<ordercomment>test платеж<payment</ordercomment>
            <orderamount>4010.00</orderamount>
            <ordercurrency>RUB</ordercurrency>
            <rate>1</rate>
            <orderdate>14.09.2012 09:29:38</orderdate>
            <orderstate>Canceled</orderstate>
            <customer>
                <firstname>Testov</firstname>
                <lastname>Test</lastname>
                <middlename>T</middlename>
                <email>test@test.ru</email>
            </customer>
            <operation>
                <billnumber>500000210031071.3</billnumber>
                <operationtype>300</operationtype>
                <operationstate>Завершено успешно.<<operationstate>Success</operationstate>
                <amount>4010.00</amount>
                <currency>RUB</currency>
                <ipaddress>10.10.10.10</ipaddress>
                <meantype_id>1</meantype_id>
                <meansubtype></meansubtype>
                <meannumber>411111****1111</meannumber>
                <cardholder>TEST</cardholder>
                <cardexpirationdate>12/20</cardexpirationdate>
                <issuebank>Bank T</issuebank>
                <bankcountry>Россия</bankcountry>
                <responsecode>AS000</responsecode>
                <message></message>
                <customermessage>Завершено успешно<<customermessage>Success</customermessage>
                <recommendation></recommendation>
                <approvalcode>X34209</approvalcode>
                <protocoltypename></protocoltypename>
                <processingname>Fake</processingname>
                <operationdate>14.09.2012 09:33:51</operationdate>
                <slipno>112211</slipno>
            </operation>
        </order>
        <packetdate>14.09.2012 09:33:57</packetdate>
        <signature>kA0DAAIRzfHw5YyCW...bQnThrGPVGBK6gh9bxUl1w==</signature>
    </ws:WSCancelResponseParams></soapenv:Body>
</soapenv:Envelope>

...