Versions Compared

Key

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

...

To get the authorization results, send a request to IPS Assist server via HTTP POST or , SOAP method (in UTF-8 coding) or in JSON format (swagger description:  https://docs.assist.ru/swagger/).

The request URL for receiving the authorization results:

...

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)

TestMode

Yes

0

1

0

Mode (0 – operation mode,
1– test mode)

Language

No

RU

EN

EN

Language of the results output

Format

No

1 – CSV
2 – WDDX
3 – XML
4 – SOAP
45 - JSON

1

Format of the results output. Should be sent in POST request and shouldn’t be sent in SOAPPassed only for a request in POST format (by default, the response will be returned in CSV format). For other formats, the response is returned in the same format in which the request was made.

MeanType_ID

No

1 – VISA

2 – MasterCard

3 – DCL

4 – JCB

5 – AMEX

6 - MIR

30 – WebMoney

32 – YandexMoney

36 – QIWI

39 – QIWIBeeline

40 – QIWIMts

41 - QIWIMegafon

All values sampling by default

Sampling by types of payment means

Operationstate

No

N – created,

P – being processed,

S – completed,

F – failed

T – closed upon time expiration

All values sampling by default

Sampling by operation states. Use upper case only.

Operationtype

No

A – payment

C – payment confirmation

R – cancellation

All values sampling by default

Sampling by operation types. Use upper case only.

StartDay

No

dd

By default: minus three hours from the current time at the moment of sampling

Sampling start date (GMT)

StartMonth

No

mm

StartYear

No

yyyy

StartHour

No

hh

StartMin

No

mm

EndDay

No

dd

By default: current time at the moment of sampling

Sampling end date (GMT)

EndMonth

No

mm

EndYear

No

yyyy

EndHour

No

hh

EndMin

No

mm

DateTimeMode

No

0 – by order date;
1 – by start date;
2 – by end date.

0

Date type - target date for data sampling

ZipFlag

No 

"0" – browser
"1" – file
"2" - ZIP

0

Format of the results output

...

Parameter

Value 

ordernumber

Order number

billnumber

Extended format of billnumber

testmode

Test mode

ordercomment

Comment

orderamount

Original amount of order

ordercurrency

Original currency of order

amount

Operation amount

currency

Operation currency

rate

Currency rate

lastname

Payer's last name

firstname

Payer's first name

middlename

Payer's middle name

Email

Payer's e-mail

clientip

Transactor's IP-address

ipaddress

Payer's IP-address

meantype_id

Payment means ID

meantypename

Type of payment means

meansubtype

Payment  means subtype

meannumber

Number of payment means

cardholder

Payment means holder

issuebank

Name of issue bank

bankcountry

Country of issue bank

orderdate

Date of order

orderstate

Order state

responsecode

Response code

message

Message

customermessage

Result message for a customer

recommendation

Recommendations

approvalcode

Authorization code

protocolname

Protocol

processingname

Processing

operationtype

Operation type

operationdate

Operation date and time (GMT)

authresult

3Ds authorization result (Y – success, N - fail, A - Attempt, U – unknown)

authrequired

The card involvement in 3Ds check result (1 – involved, 0 – not involved, -1 – unknown, null – error appear during involvement check)

slipno

Financial transaction identifier

packetdate

Request issue date

checkvalue

uppercase(md5(uppercase(md5(SALT) + md5(Х)))), where SALT – secret word; Х –  is string generated according to determined rulesresult of the following parameters string concatenation: merchant_id, ordernumber, orderamount, ordercurrency, orderstate (without delimiters), + means string concatenation.


Card expired date

Warning

Attention! The testmode value of response has to be checked. If the payment was made in test mode (testmode = 1), then the shipment of goods or providing of services for the current request is not required.

...

Panel

"ordernumber";"billnumber";"testmode";"ordercomment";"orderamount";"ordercurrency";"amount";"currency";"rate";"firstname";"lastname";"middlename";"email";"clientip";"ipaddress";"meantype_id";"meantypename";"meansubtype";"meannumber";"cardholder";"issuebank";"bankcountry";"orderdate";"orderstate";"responsecode";"message";"customermessage";"recommendation";"approvalcode";"protocoltypename";"processingname";"operationtype";"operationdate";"authresult";"authrequired";"slipno";"packetdate";"checkvalue";"cardexpirationdate"; "001-1";"500000000000000.1";"0";"test payment";"70.00";"USD";"1 975.48";"RUB";"28.2212";"Testov";"упр";"S.";"test@testtest@test.ru";"10.20.10.00";"0.0.0.0";"1";"VISA";"Classic";"411111****1111";"TEST";"New Bank";"Russia";"18.04.2011 07:51:42";"Paid";"AS000";"Completed.";"Completed.";"";"X28577";"NET";"Fake";"100";"01.02.2012 06:39:42";"";"0";”111111”;"18.04.2011 12:27:32";"5189407747A5435E9E7A0C06A7BC18CD";"12/20";

...

The WEB-service description for SOAP format can be seen on page:

https://<SERVER-NAME>/resultbydate/resultbydate.wsdl .

Replay example in SOAP format:

...

Multiexcerpt include
MultiExcerptNameslipno
PageWithExcerptDoc blocks

...

Warning

...

title

...

Attention!

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