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



Request for details of a receipt (getReceiptStatus.do)

The request used for getting information about order receipts is getReceiptStatus.do. The following data can be passed in the request:

  • order identifier – derId/orderNumber;
  • receipt identifier – uuid.

If the order identifier is passed (orderId or orderNumber), the response returns all the receipts of this order. On passing only the receipt identifier, the response returns only the data about this receipt. If both the order and receipt identifiers are passed, the response returns all the receipts of the order.

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

Name Type Mandatory Description FFD version

userName

AN..30

Yes

Login of the service account of the merchant.

All versions.

password

AN..30

Yes

Merchant's service account password.

All versions.

orderId

ANS36

No

Order identifier in the payment system. It is unique within the system. There is no, if the order registration failed due to an error.

To execute the request, the order number or its identifier in the fiscalizator must be specified.

All versions.

orderNumber

ANS..32

No

Order identifier in the Store system.

To execute the request, the order number or its identifier in the fiscalizator must be specified.

All versions.

uuid

AN..32

No

Receipt identifier in the fiscalizator.

To execute the request, the order number or its identifier in the fiscalizator must be specified.

All versions.

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.

All versions.

Response parameters

Some parameters to be returned may depend on the Fiscal Data Operator used.



Name Type Mandatory Description FFD version

errorCode

ANS..3

No

Error code. Can be missing if the result has not caused an error.

All versions.

errorMessage

AN..512

No

Error description in the language passed in the language parameter in the request.

All versions.

orderNumber

ANS..32

No

Number (identifier) of the order in the store system. It is unique for every store within the Payment Gateway. If the order number is generated on the Payment Gateway side, this parameter is not mandatory.

All versions.

orderId

ANS36

No

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.

All versions.

receipt

Not applicable

No

Block containing the receipt parameters.

See receipt block content below.

All versions.

receipt block content

The content of the receipt block is shown in the table below.

Name Type Mandatory Description FFD version

receiptStatus

N2

Yes

The status of the receipt is defined by the value of this parameter. The field can have the following values:

  • 0 – The payment is submitted;
  • 1 – The payment is delivered;
  • 2 – Payment error;
  • 3 – Refund submitted;
  • 4 – Refund delivered;
  • 5 – Refund error.

All versions.

uuid

AN..32

No

Receipt identifier in the fiscalizator.

All versions.

original_ofd_uuid

ANS..255

No

Receipt identifier in the OFD system.

1.05 and later versions.

shift_number

N

No

Shift number.

All versions.

fiscal_receipt_number

N

No

Receipt number in the shift.

All versions.

receipt_date_time

NS

No

Date and time of the receipt in the fiscal accumulating mechanism.

All versions.

fn_number

S..16

No

Fiscal accumulating mechanism number.

All versions.

fiscal_document_number

N

No

Fiscal number of the document.

All versions.

fiscal_document_attribute

S..10

No

Fiscal attribute of the document.

All versions.

amount_total

NS..11

No

Receipt total amount in rubles.

All versions.

serial_number

S..20

No

POS equipment manufacturing number.

All versions.

fnsSite

ANS

No

Site address of the Federal Tax Service.

1.05 and later versions.

ofd_receipt_url

ANS..1024

No

Receipt URL

Not all OFD systems return a link to the receipt, so the field may be empty.

1.05 and later versions.

OFD

Not applicable

No

Block containing parameters of the Fiscal Data Operator.

See OFD block content below.

All versions.

OFD block content

The content of the OFD block is shown in the table below.

Name Type Mandatory Description FFD version

Name

name

Type

S..256

Description

REST

Name of Fiscal Data Operator.

WS

Name of Fiscal Data Operator.

S..256

No

Name of Fiscal Data Operator.

All versions.

website

S..58

No

Website of Fiscal Data Operator.

All versions.

INN

S12

No

Taxpayer identification number of the Fiscal Data Operator.

All versions.

Error codes

The table below lists error codes with messages.

Error code Error text
1

Expected at least one of: orderId, orderNumber, uuid.

5

Access denied.

6

Receipt is not found.

7

System error.

Examples

Request example

language=ru&userName=login-api&password=123&uuid=574590d8-f004-41a6-9be6-45678b1626ff

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

{"errorCode":"0","orderNumber":"232002","orderId":"5b6ddd02-0974-77f3-bfbd-33be011b4f5b","receipt":[{"receiptStatus":4,"uuid":"574590d8-f004-41a6-9be6-45678b1626ff","original_ofd_uuid":"27c5a617-62a4-4f77-943e-53512c38f3e2","shift_number":"22","fiscal_receipt_number":"6543","receipt_date_time":1608215760000,"fn_number":"9999078900001823","ecr_registration_number":"0000000005039739","fiscal_document_number":"36178","fiscal_document_attribute":"4068500213","amount_total":141,"fnsSite":"www.nalog.ru","ofd_receipt_url":"https://lk.platformaofd.ru/web/noauth/cheque?fn=9999078900001823&fp=4068500213&i=36178"}]}