Skip to main content
​
shop_order_id
string
required

Order ID in your system. Must be unique for each new invoice.

Maximum string length: 255
Example:

"389d4f2c-46b9-4164-bcc4-fbd51e00d445"

​
shop_id
integer
required

Unique shop identifier in the Avanor system.

Example:

202203

​
status
enum<string>
required

Invoice status:

  • success — paid and credited;
  • rejected — rejected by the client or the payment system;
  • hold — held.
Available options:
success,
hold,
rejected
Example:

"success"

​
payment_id
integer
required

Unique identifier of the issued invoice in Avanor system

Example:

12

​
ps_data
string
required

Additional information from the payment system in the JSON Lines format. Mandatory field - payer's account ps_payer_account. Other fields depend on the payment system.

In case of payment tokens, the payment_token parameter will also be represented in this field.

Example:

"{\"ps_payer_account\": \"411111XXXXXX1111\", \"bill_id\": \"7766\", \"amount\": \"190.99\", \"status\": \"success\"}"

​
ps_currency
number
required

Numeric currency identifier in accordance with ISO 4217. Example: 840

Example:

840

​
payway
string
required

Payway in Avanor system used by the user for payment

Maximum string length: 150
Pattern: ^[A-Za-z_,\[\]]+$
​
description
string
required

Payment description

Example:

"Invoice for user_id=7766"

​
created
string<date-time>
required

Invoice creation date and time

Example:

"2020-04-21T20:07:02"

​
updated
string<date-time>
required

Invoice status change date and time (payment or rejection)

Example:

"2020-04-21T20:09:02"

​
processed
string<date-time> | null
required

Date and time of invoice transfer to the final status

Example:

"2020-04-21T20:09:03"

​
shop_currency
number
required

Numeric currency identifier in accordance with ISO 4217. Example: 840

Example:

840

​
shop_amount
number<float>
required

Invoice amount, in the invoice currency

Example:

267

​
client_price
number<float>
required

Amount paid by the client, in the payment system currency.

Example:

272.34

​
error_code
number<integer>
required

Avanor API error code. 0 in cases there is no any error. Other codes can be found here: Description of error codes

Example:

0

​
shop_refund
number<float>
required

Amount credited to the shop's balance. If there is no transactional conversion, the balance currency is equal to the account currency (shop_currency).

In case of transactional conversion of turnover, the currency of the shop balance (settlement_currency) and the exchange rate (settlement_rate) will be sent in the notification additionally

​
addons
string
required

User parameters sent by the shop when creating an invoice in JSON Lines format.

​
sign
string
required

Request signature