Payments (payment)

Function: payment

Result: the list of elements

Payments

Access level: admin user

Parameter	Value
id	Id. Unique identifier
number	Number. Payment number according to the company's numbering system, or payment method
create_date	Date. Date when the payment was placed
sender_name	Payer. Payer who made this payment
recipient_name	Recipient. Payee. It is not present, if the payment method is not associated with any company
subaccountamount_iso	Amount. Amount credited to the client's account
paymethodamount_iso	Amount in payment currency. Payment amount in currency of the selected payment method
status	Status. Payment status. Possible values: 1 — new 2 — payment in progress 3 — pledged payment 4 — credited 5 — pending return 6 — returned to client in full 7 — fraudulent
createdatestart	start date of the period to be filtered
createdatestart	end date of the period for filtering

An example of API request to get the list of payments with the "New" status over the period:

https://<BILLmamager IP-address>?authinfo=username:password&func=payment&filter=on&status=1&createdate=other&createdateend=2020-07-03&createdatestart=2020-06-03&out=xml

Comments to request

Set a filter by the selected client

Function: payment.setfilter

Set a filter by the selected client

Access level: admin

Set filter

Function: payment.filter

Payment

Function: payment.add.redirect

Access level: user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Parameters:
- elid — unique identifier (id element of payment function)
Result: object parameters list

Create an object:

Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
Result: successful operation or error message

Change an object:

Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of payment function)
- additional query parameters ...
Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Parameter	Value
amount_currency	Payment amount. Total

Creating a payment

Function: payment.add.pay

Access level: admin, user

Result: creation of payment

This function is used to pay only the old cart. In the web-interface of the platform it is a wizard of payment and replenishment.

When using this API, it is recommended to go through the entire path of the payment wizard and focus on what request is sent to the server with its completion (payment.add.pay call). Calling only this function separately may cause errors.

The set of parameters used in the request depends on the availability of other parameters. The necessity of some fields depends on the selected payment method.

Parameter	Value
amount	payment amount
payment_currency	elid (unique identifier) of the payment currency (must match the currency of the selected payment method)
customer_account	client id
paymethod	payment module id
plid	client id (from payment.add function)
profile	payer id (if required by payment method)
profiletype	payer type
project	provider. The value must not be equal to 0
billorder	cart id

The article was last updated on 04.22.2025. The article was prepared by technical writers of ISPsystem.