IP-address:1500
— IP address and port for connecting to the platform server;
status=1 — payment status. In the example, "New";
createdatestart=2020-06-03 — start date of the period for the filter;
createdateend=2020-07-03 — end date of the period for the filter.
In the example, when calling the function, the response will contain a list of payments with status "New" for the period from June 3, 2020 to July 3, 2020.
Edit payment parameters
Function: payment.edit
Result: successful operation or error message
UI Equivalent: go to Payments → click Edit in the payments list.
Used to edit payment parameters. Supports modification of number, dates, amounts, status, payment method, and other fields.
Access level: admin
Parameter
Type
Required
Value
elid
Positive integer
Yes
Unique payment identifier for editing.
number
String
No
Invoice number for payment. Maximum length: 64 characters.
createdate
Date and time
No
Date and time of invoice creation. Format: YYYY-MM-DD HH:MM:SS.
paydate
Date and time
No
Payment or crediting date. Format: YYYY-MM-DD HH:MM:SS.
documentnumber
String
No
Payment document number. Maximum length: 64 characters.
documentdate
Date
No
Payment document date. Format: YYYY-MM-DD.
description
String
No
Payment purpose.
sender
Positive integer
No
ID of the payer on whose behalf the payment was made.
recipient
Positive integer
No
ID of the recipient company of the payment.
subaccountamount
String
No
Amount credited to the client account.
paymethodamount
String
No
Amount in the payment system currency.
status
String (enumeration)
No
Payment status. Possible values:
1 — new;
2 — paid;
3 — promised payment;
4 — credited;
5 — awaiting refund;
6 — refunded;
7 — fraudulent;
9 — cancelled.
paymethod
Positive integer
No
ID of the payment method.
restrictrefund
Flag
No
Prohibit refunds from this payment. Possible values:
on — prohibit;
off — allow.
info
String
No
Additional information about the payment received from the payment system.
note
String
No
Staff comment.
sok
String
No
The value ok confirms saving changes.
Delete payments
Function: payment.delete
Result: successful operation or error message
UI Equivalent: go to Payments → click Delete in the payments list.
Deletes payments. Supports deletion of multiple payments separated by commas. Unavailable for payments with statuses: "Promised payment", "Credited", "Awaiting refund", "Refunded", "Fraudulent". Confirmation via the sok parameter is required.
Access level: admin
Parameter
Type
Required
Value
elid
String (list)
Yes
One or more payment id values separated by commas. For example, 123,456.
sok
String
Yes
The value ok confirms the operation. Without this parameter, changes will not be applied.
Credit payments
Function: payment.setpaid
Result: successful operation or error message
UI Equivalent: go to Payments → click Credit in the payments list.
Credits selected payments to the client account. Unavailable for payments with statuses: "Credited", "Refunded", "Cancelled", as well as if the refund flag is set. Confirmation via the sok parameter is required.
Access level: admin
Parameter
Type
Required
Value
elid
String (list)
Yes
One or more payment id values separated by commas.
sok
String
Yes
The value ok confirms the operation.
Refund funds for a payment
Function: payment.refund
Result: successful operation or error message
UI Equivalent: go to Payments → click Refund in the payments list.
Allows refunding all or part of the funds credited to the client account by the selected payment. Available only for credited payments if supported by the payment method. Confirmation via the sok parameter is required.
Access level: admin
Parameter
Type
Required
Value
elid
Positive integer
Yes
id of the payment for which the refund needs to be performed.
amount
String
No
Refund amount. If not specified, the full payment amount is refunded.
sok
String
Yes
The value ok confirms the operation.
Send payment document
Function: payment.docflow.send
Result: successful operation or error message
UI Equivalent: go to Payments → click Send invoice in the payments list.
Sends a document in PDF format via email.
Access level: admin
Parameter
Type
Required
Value
elid
Positive integer
Yes
id of the payment for which the document needs to be sent.
method
String (enumeration)
No
Method of sending documents to clients. Possible values:
email — via email.
sok
String
Yes
The value ok confirms the operation.
Print payments
Function: payment.print
Result: successful operation or error message
UI Equivalent: go to Payments → click Print in the payments list.
Returns a ready print form of selected payments with details, amounts, and tax data.
Access level: admin, user
Parameter
Type
Required
Value
elid
String (list)
Yes
One or more payment id values separated by commas.
Download payments in PDF format
Function: payment.print.pdf
Result: successful operation or error message
UI Equivalent: go to Payments → click Download in the payments list.
Returns a PDF document with details of selected payments.
Access level: admin, user
Parameter
Type
Required
Value
elid
String (list)
Yes
One or more payment id values separated by commas.
Display invoice contents
Function: payment.orderinfo
Result: list of items
UI Equivalent: go to Payments → click Details in the payments list.
Returns details of invoice items linked to the payment.
Access level: admin
Parameter
Type
Required
Value
elid
Positive integer
Yes
id of the payment for which invoice contents need to be displayed.
Display payment expense allocation
Function: payment.expense
Result: list of items
UI Equivalent: go to Payments → click Expenses in the payments list.
Returns a list of expenses linked to the payment. Available only for payments with statuses: "Promised payment", "Credited".
Access level: admin
Parameter
Type
Required
Value
elid
Positive integer
Yes
id of the payment for which expense allocation needs to be displayed.
Create an invoice for a payment
Function: payment.invoice_create
Result: successful operation or error message
UI Equivalent: go to Payments → click Invoice in the payments list.
Creates an invoice for the selected payment. Available only if invoice creation is allowed for the payment. Confirmation via the sok parameter is required.
Access level: admin
Parameter
Type
Required
Value
elid
String (list)
Yes
One or more payment id values separated by commas.
sok
String
Yes
The value ok confirms the operation.
Display payment change history
Function: payment.history
Result: list of items
UI Equivalent: go to Payments → click History in the payments list.
Returns a chronology of events related to payment parameter changes.
Access level: admin
Parameter
Type
Required
Value
elid
Positive integer
Yes
id of the payment for which change history needs to be displayed.
Write a ticket regarding a payment
Function: ticket.write.payment
Result: successful operation or error message
UI Equivalent: go to Payments → click Ticket in the payments list.
Creates a support ticket linked to the selected payment.
Access level: admin
Parameter
Type
Required
Value
elid
String (list)
Yes
One or more payment id values separated by commas.
subject
String
No
Ticket subject.
message
String
No
Ticket message text.
Set a client payment filter
Function: payment.setfilter
Result: successful operation or error message
UI Equivalent: go to Payments → click Bilter by client in the payments list.
Sets a client filter for the payment list. Filter conditions are saved and applied to all subsequent payment calls until the filter is changed or reset.
Access level: admin
Parameter
Type
Required
Value
account
Positive integer
No
Client ID for list filtering.
reset
Flag
No
The value on resets all set filters.
Apply advanced filter
Function: payment.filter
Result: successful operation or error message
UI Equivalent: go to Payments → click Filter in the payments list.
Applies advanced filtering conditions to the payment list. Supports filtering by number, dates, amounts, statuses, payment methods, and other parameters.
Access level: admin
Parameter
Type
Required
Value
id
Positive integer
No
Unique payment identifier for filtering.
account
String
No
Client name for filtering.
account_id
Positive integer
No
Client codes for filtering.
number
String
No
Payment number for filtering. Supports the wildcard character *.
sender
String
No
Search by payer name/full name. Supports the ~ symbol as a separator for multiple values.
sender_id
Positive integer
No
Payer codes for filtering.
recipient
String (list)
No
Recipient company IDs for filtering. Multiple selection is possible.
createdate
String (enumeration)
No
Creation period. Possible values:
nodate;
today;
currentweek;
currentmonth;
lastday;
lastweek;
lastmonth;
lastyear;
week;
month;
quarter;
halfyear;
year;
other.
createdatestart
Date
No
Start date of the creation range. Format: YYYY-MM-DD.
createdateend
Date
No
End date of the creation range. Format: YYYY-MM-DD.
payfromdate
Date
No
Payments credited from date. Format: YYYY-MM-DD.
paytodate
Date
No
Payments credited to date. Format: YYYY-MM-DD.
profiletype
String (enumeration)
No
Payer legal status. Accepts values:
1 — individual;
2 — legal entity;
3 — sole proprietor.
maildocs
String (enumeration)
No
Method of receiving documents. Possible values:
0 — in the personal account;
1 — by mail;
2 — via email;
3 — via electronic document flow system (EDF). Electronic document flow must be configured.
project
String (list)
No
Provider IDs for filtering.
paymethod
String (list)
No
Payment method IDs for filtering.
module
String (enumeration)
No
Payment systems. For example, pmwire or pmyandexcheckout.
status
String (enumeration)
No
Filter by payment status. Possible values:
1 — new;
2 — paid;
3 — promised payment;
4 — credited;
5 — awaiting refund;
6 — refunded;
7 — fraudulent;
8 — initiated;
9 — cancelled;
100 — being deleted.
docflow_pdf_status
String (enumeration)
No
EDF statuses. Possible values:
100 — awaiting sending;
101 — sent;
400 — completed.
saamount_from
String
No
Minimum payment amount credited to the account.
saamount_to
String
No
Maximum payment amount credited to the account.
pmamount_from
String
No
Minimum amount in the payment method currency.
pmamount_to
String
No
Maximum amount in the payment method currency.
restrictrefund
Flag
No
Filter by refund availability. Possible values:
on — prohibited;
off — allowed;
null — not set.
sendreport
Flag
No
Enable automatic report sending via email. Possible values:
on — enabled;
off — disabled.
sendreport_email
String
Yes
Email for sending the report. Required if sendreport=on.
sendreport_period
String (enumeration)
Yes
Sending frequency. Possible values:
daily — daily;
weekly — weekly;
monthly — monthly;
quarterly — quarterly;
annually — annually.
reset
Flag
No
The value on resets all set filters.
Log in to the panel with client rights
Function: payment.su
Result: successful operation or error message
UI Equivalent: go to Payments → click Log in in the payments list.
Performs login to the control panel with the rights of the selected client to view their data.
Access level: admin
Parameter
Type
Required
Value
elid
Positive integer
Yes
Unique identifier of the client whose rights are to be used for login.
Proceed to payment payment
Function: payment.add.redirect
Result: successful operation or error message
Performs redirection to the payment wizard for the selected payment. Used to complete payment via the web interface.
Access level: user
Parameter
Type
Required
Value
elid
Positive integer
Yes
id of the payment to be paid.
amount_currency
Positive integer
Yes
Payment amount.
sok
String
Yes
The value ok confirms the operation.
Create a payment directly (old cart)
Function: payment.add.pay
Result: successful operation or error message
UI Equivalent: go to payment and account top-up wizard.
Creates a payment directly, bypassing the cart. Used for payment only via the old cart.
When using this API, we recommend going through the entire payment wizard flow and focusing on which request is sent to the server upon its completion (calling payment.add.pay). Calling only this function separately may lead to errors.
The set of parameters depends on the selected payment method. The necessity of certain fields depends on the selected payment method, for example, for YooKassa you need to specify payment_method.
Access level: admin, user
Parameter
Type
Required
Value
amount
String
Yes
Payment amount.
payment_currency
Positive integer
Yes
ID of the payment currency. Must match the currency of the selected payment method.
customer_account
Positive integer
Yes
ID of the client for whom the payment is being created.
paymethod
Positive integer
Yes
ID of the payment module.
plid
Positive integer
No
Client ID from the payment.add function.
profile
Positive integer
No
Payer ID. Required if needed for the payment method.
En
Es