/user/info
Get general information about a user.
Query Params / Form Data
Contains your API key.
Get it from here.
The unique ID of the user whose information you wish to retrieve.
This ID is required.
A flag to indicate whether to include the user's logo in the response.
Set to "1" to include, or "0" to exclude the logo.
Response JSON
Indicates the result of the API request.
For more details about error handling, check here.
The unique ID of the user.
The name of the user's store.
Payment method data for a user.
The base64-encoded image string representing the user's logo.
/user/transactions
Get a users transactions.
Query Params / Form Data
Contains your API key.
Get it from here.
The unique ID of the user whose transactions you wish to retrieve.
This ID is required.
The number of transactions to return per page.
This parameter is optional. If provided, it must be used with the `page` parameter.
The page number to retrieve.
This parameter is optional. If provided, it must be used with the `rows` parameter.
Response JSON
Indicates the result of the API request.
For more details about error handling, check here.
A list of transactions associated with the user.
/user/funds
Get a users funds.
Query Params / Form Data
Contains your API key.
Get it from here.
The unique ID of the user whose funds you wish to retrieve.
This ID is required.
The number of funds records to return per page.
This parameter is optional. If provided, it must be used with the `page` parameter.
The page number to retrieve.
This parameter is optional. If provided, it must be used with the `rows` parameter.
Response JSON
Indicates the result of the API request.
For more details about error handling, check here.
A list of funds associated with the user.
/user/balances
Get a users balances.
Query Params / Form Data
Contains your API key.
Get it from here.
The unique ID of the user whose balances you wish to retrieve.
Response JSON
Indicates the result of the API request.
For more details about error handling, check here.
The currency in which the balance is denominated.
Can be configured here.
The total balance of the user, denominated in the users currency.
An object containing the balances for currencies the user owns.
The actual amount indicates the amount in the currency.
The converted amount indicates the amount converted to the users currency.
/user/stats
Retrieve statistics about a user's transactions, including revenue, transaction count, and completion rates.
Query Params / Form Data
Contains your API key.
Get it from here.
The unique ID of the user whose statistics you wish to retrieve.
The time period in seconds to filter the transactions.
Optional. Defaults to 24 hours (86400 seconds).
Response JSON
Indicates the result of the API request.
For more details about error handling, check here.
The currency in which the stats are reported.
Can be configured here.
The total revenue in the user's currency over the selected time period.
The percentage change in revenue compared to the previous period.
The total number of transactions in the user's account over the selected time period.
The percentage change in the transaction count compared to the previous period.
The percentage of transactions marked as completed over the selected time period.
The percentage change in the completion rate compared to the previous period.
/user/exchange
Perform an exchange from one currency to another for a user.
This endpoint allows users to exchange a specified amount of currency they hold for another currency based on the current exchange rate.
Query Params / Form Data
Contains your API key.
Get it from here.
The unique ID of the user performing the exchange.
The currency the user is exchanging from.
The currency the user is exchanging to.
The amount of the source currency (currency_from) the user wants to exchange.
Response JSON
Indicates the result of the API request.
For more details about error handling, check here.
The unique identifier for the exchange transaction.
/user/withdraw
Withdraw an amount of a specific currency to a designated recipient address.
This endpoint allows users to withdraw their funds to an external crypto address.
Query Params / Form Data
Contains your API key.
Get it from here.
The unique ID of the user requesting the withdrawal.
The currency the user wishes to withdraw.
The amount of the currency to be withdrawn.
This is the amount before any withdrawal fees are applied.
The recipient's crypto address where the funds will be sent.
Response JSON
Indicates the result of the API request.
For more details about error handling, check here.
The unique identifier for the withdrawal transaction.
/user/changesettings
Change various user settings such as username, currency, password, and other details.
This endpoint allows the user to update settings like their username, currency, password, store name, terms of service, privacy policy, logo, banner, theme color, and payment methods.
Query Params / Form Data
Your API key.
Get it from here.
The unique ID of the user whose settings are being updated.
The new username for the user.
The new currency for the user.
Whether to generate a new API key for the user.
The new password for the user.
The password confirmation.
The new store name for the user.
The URL for the updated terms of service.
The URL for the updated privacy policy.
The base64-encoded image for the user's logo.
The new theme color for the user.
A JSON object representing the user's payment methods and their statuses.
Response JSON
Indicates the result of the API request.
For more details about error handling, check here.
Contains additional data related to the update.
For example, if the API key is updated, this field may contain the new key.