User API
General Information

To work with the User API, you need to generate a secret key in the user profile.

Example request:

curl -X POST 'https://YOUR.DOMAIN/user-api-get-info' \

    --header 'X-Authorization: SECRET_KEY'

API Introduction

User Information
/user-api-get-info

Returns a user object.

Orders History
/user-api-get-orders

Optional search parameters: "id", "token", "status", "exchange_id", "send_currency_id", "receive_currency_id".

Returns an order object.

Referral Orders History
/user-api-get-referral-orders

Optional search parameters: "id", "token", "status", "exchange_id", "send_currency_id", "receive_currency_id".

Returns an order object.

Investments History
/user-api-get-investments

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

Returns an investment object.

Make Investments
/user-api-create-investments
Parameter Description
tariff Tariff ID
amount Amount
two_factor_authentication_password 2FA Password (if 2FA is enabled)

Returns an investment object.

List of Payment Details
/user-api-get-details

Optional search parameters: "currency_id", "value".

Returns the user payment details object.

Saving Payment Details
/user-api-create-details
Parameter Description
currency_id Currency ID
value Payment Details

Returns the user payment details object.

Deleting Payment Details
/user-api-delete-details
Parameter Description
ids[] ID or IDs
Verification Information
/user-api-get-verification

Returns a verification request object.

Verification Process
/user-api-submit-verification

For bank card verification, the required fields are card number, first name, last name, and photos.

Parameter Description
id_type Document ID
id_number Document Number
card_number Bank Card Number
first_name First Name
last_name Last Name
middle_name Middle Name
birth_date Date of Birth (format: dd.mm.yyyy)
phone Phone Number
country Country
city City
address Address
zip_code Postal Code
photos[] Photos (maximum: 9000 KB)

API Identifiers

Returns a verification request object.

Pay from Balance During Exchange
/user-api-spend-balance
Parameter Description
token Order Token
two_factor_authentication_password 2FA Password (if 2FA is enabled)
Password Change
/user-api-change-password
Parameter Description
password Current Password
new_password New Password
two_factor_authentication_password 2FA Password (if 2FA is enabled)
2FA Setup
/user-api-setup-two-factor-authentication
Parameter Description
two_factor_authentication_token Secret Key
two_factor_authentication_enable Status (1: enable, 0: disable)
two_factor_authentication_password 2FA Password
List of Filled Fields
/user-api-get-inputs

Returns an array with the exchange direction field ID as the key and its content.

We work without days off 10:00 - 20:00 (GMT+3)
© 2018 - 2024 Made with Exchanger CMS