API
Methods of working with the API:
- test
A test method to verify API functionality.
user_id — user ID (if the systеm is querying, ID = 0)
locale — website language
partner_id — partner ID
- get_direction_currencies
Retrieve a list of currencies available for exchange.
- get_directions
Retrieve a list of exchange directions available for exchange.
- get_direction
Retrieve information about the exchange direction.
- get_calc
Calculator for amounts for exchange direction.
calc_amount — amount
calc_action — amount ownership: 1 — amount in "From" currency, 2 — amount in "To" currency, 3 — amount in "From" currency with commission, 4 — amount in "To" currency with commission
cd — fields from the exchange direction, marked cd = 1, in one field. The field is URL encoded.
currency_code_get — "To" currency code
reserve — "To" currency reserve
course_give — "From" currency course
course_get — "To" currency course
sum_give — amount in "From" currency
sum_give_com — amount in "From" currency with commission
sum_get — amount in "To" currency
sum_get_com — amount in "To" currency with commission
com_give — commission text of "From" currency
com_get — commission text of "To" currency
min_give — minimum amount of "From" currency, not set if "no"
max_give — maximum amount of "From" currency, not set if "no"
min_get — maximum amount of "To" currency, not set if "no"
max_get — maximum amount of "To" currency, not set if "no"
changed — flag indicating change in the entered amount: 0 — no change needed, 1 — Needs to be changed
- get_exchanges
Displaying orders created with this key
end_time — unix time until which to display orders (filter, optional parameter)
ip — IP address (filter, optional parameter)
id — order ID (filter, optional parameter)
api_id — ID passed in the API (filter, optional parameter)
status_history — whether to display status history: 0 — no, 1 — yes (filter, optional parameter)
limit — number of displayed orders (filter, optional parameter)
offset — how many orders to skip (filter, optional parameter)
id — order ID
api_id — ID passed in the API
time — time of status change
date — date of status change
psys_give — payment systеm of "From" currency
psys_get — payment systеm of "To"
currency currency_code_give — code of "From"
currency currency_code_get — code of "To"
currency course_give — course of "From"
currency course_get — course of "To"
currency amount_give — amount in "From"
currency amount_get — amount in "To"
currency exchange_success — 0 — order executed, 1 — order not executed
user_hash — user hash
user_ip — user IP
address status — order status
statuses — list of status changes
time — time of status change
date — date of status change
status — order status
- create_bid
Creating an order
partner_id — partner ID (optional parameter)
api_id — order ID in your systеm (optional parameter)
calc_amount — exchange
amount calc_action — amount ownership: 1 — amount in "From" currency, 2 — amount in "To" currency, 3 — amount in "From" currency with commission, 4 — amount in "To" currency with commission
callback_url — response URL when order status changes.
Received by POST method: bid_id — order ID,
status — order status (optional parameter)
account1 — from account
cfgive8 — cardholder’s name
account2 — to account
cf1-99 — custom fields
Field examples:
cf1 — First Name
cf2 — Middle Name
cf3 — Last Name
cf4 — Phone Number
cf5 — Skype
cf6 — E-mail
cf8 — Passport Number
cf10 — Region
cf11 — Telegram
id — order ID
hash — order hash
status — order status
status_title — order status title
psys_give — payment systеm of "From" currency
psys_get — payment systеm of "To" currency
currency_code_give — code of "From"
currency currency_code_get — code of "To" currency
amount_give — amount in "From"
currency amount_get — amount in "To" currency
api_actions — options
type — payment type
cancel — order cancellation method
api — API method
disabled — disabled cancel link
pay — payment method
api — API method
disabled — disabled
cancel link
instruction — payment instruction
pay_amount — amount to be paid
- cancel_bid
Cancel an order (method works only if the response to create_bid includes api_actions -> cancel = ‘api’)
- pay_bid
Mark an order as paid (method works only if the response to create_bid includes api_actions-> pay = ‘api’)
- bid_info
Payment information about the order
hash — Order hash (optional if ID is provided)
id — Order ID
hash — Order hash
status — Status
status_title — Status title
psys_give — Payment systеm for "From"
currency psys_get — Payment systеm for "To" currency
currency_code_give — Currency code for "From" currency
currency_code_get — Currency code for "To" currency
amount_give — Amount in "From"
currency amount_get — Amount in "To" currency
api_actions — Options
type — Payment type
cancel — Order cancellation method
api — Via API
disabled — Cancellation link disabled
pay — Payment method
api — Via API
disabled — Disabled payment
link instruction — Payment instruction
pay_amount — Amount to be paid
- get_partner_info
Partner information
balance — Balance
min_payout — Minimum payout amount
items — List of currencies for payout
id — Currency ID
title — Currency name
commission — Commission
amount — Balance in this currency
- get_partner_links
Information about partner links
end_time — Unix time until which to display (filter, optional parameter)
ip — IP address (filter, optional parameter)
limit — Number of displayed items (filter, optional parameter)
links time — Transition time
date — Transition date
browser — Browser
ip — Transitioning user’s IP address
referrer — Page from which the transition was made
user_hash — User hash
query_string — Query string
- get_partner_exchanges
Information about partner exchanges
end_time — Unix time until which to display orders (filter, optional parameter)
ip — IP address (filter, optional parameter)
id — Order ID (filter, optional parameter)
status_history — Whether to display status history: 0 — no, 1 — yes (filter, optional parameter)
limit — Number of displayed orders (filter, optional parameter)
id — Order ID time — Time of status change
date — Date of status change
psys_give — Payment systеm for "From" currency
psys_get — Payment systеm for "To" currency
currency_code_give — Currency code for "From"
currency currency_code_get — Currency code for "To" currency
course_give — Exchange rate for "From" currency
course_get — Exchange rate for "To" currency
amount_give — Amount in "From" currency
amount_get — Amount in "To" currency
exchange_success — 0 — order completed, 1 — order not completed
accrued — 0 — no reward accrued, 1 — reward accrued
partner_reward — Partner’s reward
user_hash — User hash
user_ip — User’s IP address
status — Order status
statuses — List of status changes
time — Time of status change
date — Date of status change
status — Order status
- get_partner_payouts
List of withdrawal requests from users for funds withdrawal
end_time — Unix time until which to display (filter, optional parameter)
limit — Number of displayed items (filter, optional parameter)
id — Request ID (filter, optional parameter)
id — Request ID
time — Time of payout
date — Date of payout
method_id — Payout currency
account — Payout account
pay_amount — Payout amount
pay_currency_code — Payout currency code
original_amount — Original payout amount
original_currency_code — Original payout currency code
status — Request status. 0 — pending, 1 — paid out, 2 — cancelled
- add_partner_payout
Creation of a withdrawal request
account — Account number for payout