Request for order extended status (getOrderStatusExtended.do)

The request used for getting the status of a registered order is getOrderStatusExtended.do. To get the order status it's necessary to use the value of the orderNumber parameter (order number in the store's system).

In this document, the following data type conventions are used when describing request and response parameters:

A<n> – a sequence of Latin letters of length <n>;
A..<n> – a sequence of Latin letters with a length not exceeding <n>;
N<n> – a sequence of digits of length <n>;
N..<n> – a sequence of digits with a length not exceeding <n>;
AN<n> – a sequence of Latin letters and numbers of fixed length <n>;
AN.. <n> – a sequence of Latin letters and numbers with a length not exceeding <n>;
ANS<n> – a sequence of Latin letters, numbers and characters of fixed length <n>
ANS.. <n> – a sequence of Latin letters, numbers and characters with a length not exceeding <n>;
UTC – date and time, in this case: the date must be passed without specifying the time zone, Moscow time, for the SOAP protocol, the standard encoding xs: dateTime is used.

Request parameters

The request parameters are given in table below.

Name	Type	Mandatory	Description
`userName`	AN..30	Yes	Login of the service account of the merchant. If login and password are used for authentication during token registration, then the `token` parameter does not need to be passed.
`password`	AN..30	Yes	Merchant's service account password. If login and password are used for authentication during token registration, then the `token` parameter does not need to be passed.
`token`	AN..30	no (either login/password or token must be specified)	Merchant's service account password. If login and password are used for authentication during token registration, then the `token` parameter does not need to be passed.
`orderId`	ANS36	The request should include either orderId or orderNumber. If both parameters are present in the request, orderId has priority.	Identifier of the order in the payment system. It is unique within the system. Missing if order registration failed due to an error detailed in ErrorCode.
`orderNumber`	ANS..32	The request should include either orderId or orderNumber. If both parameters are present in the request, orderId has priority.	Order number in the store system. This is optional only if the automatic generation of the order number is enabled on the gateway (for this, contact technical support).
`language`	A2	No	Language in the ISO 639-1 encoding. If the language is not specified, the default language defined in the store settings is used.

Either orderId or orderNumber must be present in the request. If both parameters are present in the request, orderId has priority.

Response parameters

There are three sets of response parameters. The exact sets of parameters to be returned depend on the version of getOrderStatusExtended specified in the merchant settings. These parameters will be returned in the response regardless of the version getOrderStatusExtended.

Name	Type	Mandatory	Description	Version of getOrderStatusExtended
`orderNumber`	ANS..32	Yes	Order identifier in the Store system.	All versions.
`orderStatus`	N1	No	The order status in the payment system is defined by the value of this parameter. It is missing if the order has not been found. See description of statuses below.	All versions.
`actionCode`	N..5	Yes	Processing code Full list of processing response codes and description of these codes is available on a separate page.	All versions.
`actionCodeDescription`	AN..512	Yes	Description of the response code in the language that is passed in language parameter of the request.	All versions.
`errorCode`	ANS..3	No	Error code. Can be missing if the result has not caused an error. See error codes description below.	All versions.
`errorMessage`	AN..512	No	Error description in the language passed in the `language` parameter in the request.	All versions.
`amount`	N..12	Yes	The refund amount in minimum currency units.	All versions.
`currency`	N3	No	ISO 4217 code of the payment currency. If not specified, default value is used.	All versions.
`date`	ANS	Yes	Date of order registration in Unix-time format (POSIX-time).	All versions.
`depositedDate`	N	No	Date of order payment in Unix-time format (POSIX-time).	10 and higher.
`orderDescription`	ANS..600	No	Order description passed upon its registration.	All versions.
`refundedDate`	ANS	No	Date and time of the refund.	13 and higher.
`paymentWay`	AS..14	yes	The method in which the payment is made. Value: `IPOS` - iPOS payment;	09 and higher.
`avsCode`	A1	No	AVS Response Code – AVS response code (verification of cardholder's registration address and postal code). The possible values are: A – Both address and postal code match; B – Address matches, postal code does not match; C – Postal code matches, address does not match; D – Neither address nor postal code match; E – Verification requested but not available; F – Transaction improperly requests verification.	19 and higher.
The `attributes` element contains information about the order number in the payment gateway system. Passed in the `name` parameter is the value of `mdOrder`, and in the `value` parameter – the order number in the payment gateway system
Name `name` Type AN..20 Type2 ANS..255 Type3 A7 Type4 ANS..100 Description REST Name of the additional parameter. REST Online Lending The attribute name, always takes the value of mdOrder. WS Name of the additional parameter. Spasibo Name or the description of an item in any format. Spasibo2 Name of the parameter describing the details of a line item	A7	No	The attribute name, always takes the value of mdOrder.	All versions.
`value`	ANS36	No	Attribute value is the order number in the payment system (is unique within the system).	All versions.
The `merchantOrderParams` element is present in a response if an order contains additional parameters of the merchant. Each additional order parameter is contained in a separate `merchantOrderParams` element.
Name `name` Type AN..20 Type2 ANS..255 Type3 A7 Type4 ANS..100 Description REST Name of the additional parameter. REST Online Lending The attribute name, always takes the value of mdOrder. WS Name of the additional parameter. Spasibo Name or the description of an item in any format. Spasibo2 Name of the parameter describing the details of a line item	AN..20	No	Name of the additional parameter.	All versions.
`value`	AN..1024	No	The value of the additional parameter is up to 1024 characters.	All versions.
In element `merchantOrderParams` the following parameters are passed: registerOrderId – order identifier in the Online Lending proxy. The following parameters are passed as well:
Name	Type	Mandatory	Description
`rightTerms`	ANS…255	No	Desired loan term in months. Is returned the response, if the `rightTerms` parameter was passed upon order registration.
`term`	N..2	Yes	Real loan term in months.
The `paymentAmountInfo` element consists of the following parameters.
`approvedAmount`	N..12	No	The amount in the minimum currency units (for example, in kopecks) withheld on the card. Used only for two-phase payments.	03 and higher.
`depositedAmount`	N..12	No	The amount in the minimum currency units (for example, in kopecks), confirmed to be debited from the card.	03 and higher.
`refundedAmount`	N..12	No	The refund amount in minimum currency units.	03 and higher.
`paymentState`	A..10	No	Order status; the parameter can take the following values: `CREATED` – order is created; APPROVED – order is approved; DEPOSITED – order is completed; `DECLINED` – the order is declined; REVERSED – order is reversed; `REFUND` – there has been a refund for this order;	03 and higher.
`feeAmount`	N..12	No	Commission amount in minimum currency units.	11 and higher.
`totalAmount`	N..12	No	Order amount + fee (if applicable to the order).	18 and higher.
The `bankInfo` element contains the following parameters.
`bankName`	ANS..50	No	Name of the issuing bank.	03 and higher.
`bankCountryCode`	AN..7	No	Country codes of the issuing bank.	03 and higher.
`bankCountryName`	AN..160	No	Name of the country of the issuing bank passed in the language parameter of the request or in the language of the user who has called the method if the language has not been specified in the request.	03 and higher.
The payerData element contains the following parameters.
`email`	ANS..40	No	Customer's email address.	13 and higher.

Order state statuses

	Name in the user interface (English)	Name in the user interface (Russian)	Internal name	Description
`1`	Created	Created	started	The order is created
`4`	Reversed	Reversed	payment_void	The order is reversed
`6`	Refunded	Refund	refunded	Funds for the order have been refunded

Error codes

Error code	Error text
0	The request has been processed without system errors.
1	Expected [orderId] or [orderNumber].
5	Access denied.
5	The user must change the password.
6	Order not found.
7	System error.

Examples

POST request example

orderNumber=ORDER_NAMBER_IN_STORE_SYSTEM&language=ru

Пример ответа

{errorCode: "0",
errorMessage: "Success",
orderNumber: "1542618252",
orderStatus: 6,
actionCode: -2007,
actionCodeDescription: "Data input timed out",
amount: 3003799,
currency: "643",
date: 1542618252944,
orderDescription: "description 1",
merchantOrderParams: [{name: "email",
value: "32345678901234567890123456789012345678901234567890123456@test.ru"
}
],
attributes: [{name: "mdOrder",
value: "4fbc0be8-a29d-7462-b11d-3d8404b0d0be"
}
],
terminalId: "10465249",
paymentAmountInfo: {paymentState: "DECLINED",
approvedAmount: 0,
depositedAmount: 0,
refundedAmount: 0
},
bankInfo: {bankCountryCode: "UNKNOWN",
bankCountryName: "<Unknown>"
},
chargeback: false
}

Инструменты страницы

Request for order extended status (getOrderStatusExtended.do)

Request parameters

Response parameters

Name

Type

Type2

Type3

Type4

Description

REST

REST Online Lending

WS

Spasibo

Spasibo2