Function: paymethod

Result: the list of elements

Payment methods

Access level: admin

  • id — Id
  • name — Name
  • module — Payment gateways
  • currency_name — Currency
  • projects — Providers
  • companies — Companies
  • note — Comment
  • orderpriority — Sorting (count forward)
  • status — Status

Set filter.

paymethod.filter

Move the selected payment order one line up

Function: paymethod.up

Move the selected payment order one line up

Access level: admin

Add

Function: paymethod.add

Add

Access level: admin

Move the selected payment order one line down

Function: paymethod.down

Move the selected payment order one line down

Access level: admin

Resume

Function: paymethod.resume

Resume

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod function.

Result: successful operation or error message

Payment method settings

Function: paymethod.edit

Access level: admin

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 paymethod 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 paymethod function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • name — Name. Enter the name for the payment method
  • minamount — Minimum payment amount. Enter the minimum payment amount for the selected payment method
  • maxamount — Maximum payment amount. Enter the maximum payment amount that can be made with this payment method
  • commissionamount — Fixed amount . This fixed amount will be debited from client's account after the payment is effected
  • commissionpercent — Commission % . Commission in % that will be debited from client's account after the payment is effected
  • doctmpl — Print template. Select a template for printing the document. If it is not specified, the one from the company edit form will be used
  • numtmpl_payment — Invoice number template. In the invoice template you can use the following macros: {id} — payment id and {num} — number of the payment generated with this payment method. If these macros are not present, the {num} macros will be added to the invoice template number
  • nextnum_payment — Next numerical number of the invoice. Next numerical order of the invoice that was created with this payment method. It is taken into account provided that invoice number template is specified
  • payment_description — Purpose of advance payment. Name of the advance payment in the Payments module
  • autoclearperiod — Period to delete due invoices. Period in days since the payment creation date, that will pass before a due payment will be deleted
  • orderpriority — Sorting (count forward). Set priority for the selected payment method
  • successpage — Successful payment return page. A payer will be redirected to this page if his payment is processed successfully
  • failpage — Failed payment return page . A payer will be redirected to this page if his payment fails
  • pendingpage — Pending payment return page. A payer will be redirected to this page if his automatic payment is pending.
  • note — Comment . Add your comment to the payment method
  • profiletype — Payer status. This payment method will be available to payers with the selected status
  • accountgroup — Client groups. Select the check box to allow users from the selected group to use this payment module
  • deny_accountgroup — Forbid for client groups . Enables to forbid clients from the selected groups to use this payment method
  • language — Client language. This payment method will be available if the interface language matches of the selected languages. If the language is not selected, this payment method will be available for all languages
  • recurring — . (Optional parameter. To enable the option click "on".) Enable recurrent payments
  • successpage_recurring — Successful autopayment return page. A payer will be redirected to this page if his automatic payment is processed successfully
  • failpage_recurring — Failed automatic payment return page . A payer will be redirected to this page if his automatic payment fails
  • pendingpage_recurring — Pending automatic payment return page. A payer will be redirected to this page if his payment is pending.
  • allowrefund — . (Optional parameter. To enable the option click "on".) Allow full or partial refunds using the selected payment method
  • description_markdown — Payment method description (markdown).
  • description — Payment method description . Description of the service method will be available to clients on the first payment step. You can use HTML

Name

Function: paymethod.company

Result: the list of elements

Activate the payment method for companies

Access level: admin

  • id — Id
  • name — Name
  • status — Status

Resume

Function: paymethod.company.resume

Resume

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod.company function.

Result: successful operation or error message

Suspend

Function: paymethod.company.suspend

Suspend

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod.company function.

Result: successful operation or error message

Delete

Function: paymethod.delete

Delete

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod function.

Result: successful operation or error message

Name

Function: paymethod.project

Result: the list of elements

Activate this payment method for providers — wire transfer

Access level: admin

  • id — Id
  • name — Name
  • status — Status

Resume

Function: paymethod.project.resume

Resume

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod.project function.

Result: successful operation or error message

Suspend

Function: paymethod.project.suspend

Suspend

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod.project function.

Result: successful operation or error message

Suspend

Function: paymethod.suspend

Suspend

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod function.

Result: successful operation or error message