Function: payment

Result: the list of elements

Payments

Access level: admin user

  • 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
  • account_name — Client. Client who made the payment
  • paymethod_name — Payment method. Payment method associated with this payment
  • 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

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
CODE

createdatestart — the start date of the filter period

createdateend — the end date of the filter period.

In the example above, in return to the function request, the list of payments with the “New” status will be provided over the period from June 3, 2020 to July 3, 2020.

Set a filter by the selected client

Function: payment.setfilter

Set a filter by the selected client

Access level: admin

Set filter.

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):

  • amount_currency — Payment amount. Total

Drill down to User panel

Function: payment.su

Drill down to User panel

Access level: admin user