Versions Compared

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)

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
3 – XML
4 – SOAP
5 - JSON

1

Format of the results output. Passed 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
5  – AMEX
33 – Mobicon
38 - ERIP

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

Note

All request parameters are automatically validated. The validation rules are given in the table "The validation rules for input parameters".