Your API
Description
Your payment system (balance, by default VU-Money USD) supports work through its own API.
The same goes for any additional balance currencies you create.
Available functions
Invoice - invoicing operation. The user receives a link to pay for the generated invoice.
Callback - invoice payment notification function. Sends details of a paid invoice to the url specified when the invoice was created.
Withdraw - operation on payments. Automatically transfers from the user's balance to the specified details.
Details - An operation to obtain details of a transaction or invoice.
Balances - an operation to obtain the user's current balances.
Ticker - A public operation (not requiring API keys) that outputs courses for all active destinations in json format.
Code create - code creation operation.
Code apply - code redemption operation.
Code get - the operation of obtaining the details of the code.
Settings
The first thing to do is to enable the API itself. This can be done here: Currency exchange - Module settings - API balance status
Next to this setting there is a second one: "Invoice function status". If it is disabled, the Invoice operation will be unavailable in the API.
The second is group settings. It is necessary to activate the option "Allow use of API" for all the user groups you want to allow it for.
Further - balances and directions. Add and configure all required balance currencies (adding a payment system with "balance" API).
Define the "System Code" for all payment systems (including balances) that will work through the API.
Customize exchange types: automatic mandatory for withdrawals, invoicing for invoice.
Include all desired destinations, types in them and customize the courses.
You can customize referrals between the same payment system for invoice operations.
API takes into account all of fees.
If you use destinations that require card verification - the withdrawal transaction will generate errors when attempting to pay to an unverified card (Card is not verified).
You can disable verification checking for a specific group of users (Option: "Mandatory payment card verification").
API operation
Documentation of your API is available at: https://your_site/api/docs
The documentation automatically substitutes addresses to your API and payment system codes.
Check the "Payment System Codes" section of the documentation to make sure they are set up correctly.
If the payment system is not displayed - one or more reasons: it is disabled, there are no active destinations, there are no destinations with the required exchange types, the system code is not entered.
If the invoice transaction is not displayed - the invoice type is not enabled in the payment system or it has no active referrals with this type.
If no transaction is displayed - the auto-exchange type is not enabled in the payment system or it has no active referrals with this type.
To use your API, users must generate API keys. This can only be done in the user panel.
Through the admin, you can only view the list of public keys (secret keys are always hidden and encoded) and delete them (Advanced - API keys).
Logs are written for all API requests. If there are problems with its operation, use the logs to find the cause (Advanced - API Logs).
Last updated