Dashboard API

Last Updated: 21.02.2025 13:04

Navigation

General Information
Getting a List of Orders Requests
Editing Order Status
Deleting Order
Writing Data to Order Storage
Reading data from Order Storage
Getting a List of Blocked Payment Details
Editing Blocked Payment Detail Status
Deleting Blocked Payment Detail
Blocking Payment Detail
Getting a List of Reviews
Editing Review Status
Deleting Review
Getting a List of Reserve Requests
Editing Reserve Request Status
Deleting Reserve Request
Getting Verification Requests
Editing Verification Request Status
Deleting Verification Request
Getting a List of Investments
Deleting Investment
Getting a List of Users
Editing User Status
Deleting User
Editing User
Getting a List of Currencies
Editing Currency Status
Deleting Currency
Editing Currency
Getting a List of Exchange Directions
Editing Exchange Direction Status
Editing Exchange Direction
Deleting Exchange Direction
Editing Operator Status
Getting Technical Maintenance Mode Status
Editing Technical Maintenance Mode Status

General Information

To work with the Dashboard API, you need to generate a secret key in the "Application Settings" - "Dashboard API Settings".

Example request:

curl -X POST 'https://YOUR.DOMAIN/dashboard-api-set-order-status' \

    --header 'X-Authorization: SECRET_KEY' \

    --header 'Content-Type: application/x-www-form-urlencoded' \

    --data-urlencode 'id=1081' \

    --data-urlencode 'status=4' \

    --data-urlencode 'txn=8577890003'

API Introduction

You can specify multiple IDs separated by commas for all methods that modify or delete data.

Getting a List of Orders

/dashboard-api-get-orders

Optional search parameters: "id", "token", "status", "exchange_id", "user_id", "referral_id", "ip", "country", "browser", "send_merchant", "receive_merchant", "send_currency_id", "receive_currency_id".

Returns an order object.

Editing Order Status

/dashboard-api-set-order-status

Parameter	Description
id	ID or Token
status	Status ID
txn	Payment or Payout Transaction ID (optional)
reward	Referral Reward % (optional)
reason	Reason for the order suspension (optional)

API IDs

Deleting Order

/dashboard-api-delete-order

Parameter	Description
id	ID or Token

Writing Data to Order Storage

/dashboard-api-set-order-var

Parameter	Description
id	ID or Token
key	Key
value	Value

Reading data from Order Storage

/dashboard-api-get-order-var

Parameter	Description
id	ID or Token
key	Key

Getting a List of Blocked Payment Details

/dashboard-api-get-details-banned

Optional search parameters: "id", "active", "currency_id".

Returns a blocked payment detail object.

Editing Blocked Payment Detail Status

/dashboard-api-set-detail-banned-status

Parameter	Description
id	ID
active	Blocked (yes: 1, no: 0)

Deleting Blocked Payment Detail

/dashboard-api-delete-detail-banned

Parameter	Description
id	ID

Blocking Payment Detail

/dashboard-api-create-detail-banned

Parameter	Description
currency_id	Currency ID
detail	Payment Details
reason	Blocking Reason (optional)

Returns a blocked payment detail object.

Getting a List of Reviews

/dashboard-api-get-reviews

Optional search parameters: "active", "name", "email", "ip", "country".

Returns a review object.

Editing Review Status

/dashboard-api-set-review-status

Parameter	Description
id	ID
active	Under Moderation (no: 1, yes: 0)

Deleting Review

/dashboard-api-delete-review

Parameter	Description
id	ID

Getting a List of Reserve Requests

/dashboard-api-get-reserves-request

Optional search parameters: "id", "active", "token", "currency_id", "email", "ip", "country".

Returns a reserve request object.

Editing Reserve Request Status

/dashboard-api-set-reserve-request-status

Parameter	Description
id	ID
active	Processed (no: 1, yes: 0)

Deleting Reserve Request

/dashboard-api-delete-reserve-request

Getting Verification Requests

/dashboard-api-get-verifications

Optional search parameters: "id", "active", "token", "user_id", "id_type".

Returns a verification request object.

Editing Verification Request Status

/dashboard-api-set-verification-status

Parameter	Description
id	ID
active	Verified (yes: 1, no: 0)

Removing Verification Request

/dashboard-api-delete-verification

Parameter	Description
id	ID

Getting a List of Investments

/dashboard-api-get-investments

Optional search parameters: "id", "active", "token", "user_id".

Returns an investment object.

Deleting an Investment

/dashboard-api-delete-investment

Parameter	Description
id	ID

Getting a List of Users

/dashboard-api-get-users

Optional search parameters: "id", "active", "verified", "ip", "country", "login", "email", "password", "referral_id", "api_token".

Returns a user object.

Editing User Status

/dashboard-api-set-user-status

Parameter	Description
id	ID
active	Blocked (no: 1, yes: 0)

Deleting a User

/dashboard-api-delete-user

Parameter	Description
id	ID

Editing a User

/dashboard-api-update-user

Parameter	Description
id	ID
verified	Verified (yes: 1, no: 0)
balance	Balance
registration_token	Registration Confirmation Token (32 Latin characters or digits)
password_reset_token	Password Reset Confirmation Token (32 Latin characters or digits)
api_token	API Token (32 Latin characters or digits)
authorization_token	2FA Token (16 uppercase Latin characters or digits)

Getting a List of Currencies

/dashboard-api-get-currencies

Optional search parameters: "id", "active", "slug", "iso", "round", "label", "detail".

Returns a currency object.

Editing Currency Status

/dashboard-api-set-currency-status

Parameter	Description
id	ID
active	Active (yes: 1, no: 0)

Deleting Currency

/dashboard-api-delete-currency

Parameter	Description
id	ID

Editing Currency

/dashboard-api-update-currency

Parameter	Description
id	ID
reserve	Reserve
detail	Payment Details

Getting a List of Exchange Directions

/dashboard-api-get-exchanges

Optional search parameters: "id", "active", "slug", "send_merchant", "receive_merchant", "send_currency_id", "receive_currency_id", "parser".

Returns an exchange direction object.

Editing Exchange Direction Status

/dashboard-api-set-exchange-status

Parameter	Description
id	ID
active	Active (yes: 1, no: 0)

Editing Exchange Direction

/dashboard-api-update-exchange

Parameter	Description
id	ID
send_rate	Exchange Rate of the Sending Currency
receive_rate	Exchange Rate of the Receiving Currency
min_amount	Minimum Exchange Amount
max_amount	Maximum Exchange Amount
fee_amount	Additional Fee Amount
parser_amount	Rate Parser Correction Amount
parser	Rate Parser ID
send_merchant	Payment Merchant ID
receive_merchant	Payout Merchant ID