Attention! The RichExchanger exchanger sсript can only be purchased on the richexchanger.com website. Payment via messengers and other websites does not exist.

v: 3.1
RichExchanger
Buy
Contacts
E-mail: richkeeper@gmail.com
Telegram: @richkeeper
Telegram-channel: go to
VK: go to

API documentation

To use the API, the API plugin must be enabled on the site. You must also have a valid API token, which allows the use of the necessary methods.

Parameters are passed using the usual POST method. Passing JSON parameters in the body of a POST request is prohibited.

Implementation examples: php, jquery.

URL address for use API
{SITEURL}/api/v1/{endpoint}/
Authorization by method GET
{SITEURL}/api/v1/{endpoint}/?api-token={YOURTOKEN}
Authorization by method Headers
{SITEURL}/api/v1/{endpoint}/
the token is passed in the header with the name "api-token"
Language is the language of the site. If you need to force the language, you must use the GET-parameter "lang"
{SITEURL}/api/v1/{endpoint}/?lang=en
language must be enabled for the site
Available methods
test
test method to check functionality API
/api/v1/test/
post-parametrs
partner_id
partner ID
result
error
0 - no errors
error_text
error description
data
ip
your IP
user_id
user ID
locale
language
partner_id
partner ID
token_type
0 - GET token, 1 - token in headers
get_currencies
list of currencies available for exchange
/api/v1/get_currencies/
post-parametrs
currency_id_give
currency id Give
currency_id_get
currency id Get
result
error
0 - no errors
error_text
error description
data
give
list currencies Give
get
list currencies Get
id
currency id
title
currency title
logo
currency logo
get_directions
list of exchange directions available for exchange
/api/v1/get_directions/
post-parametrs
currency_id_give
currency id Give
currency_id_get
currency id Get
result
error
0 - no errors
error_text
error description
data
direction_id
direction id
currency_give_id
currency id Give
currency_give_title
currency title Give
currency_give_logo
currency logo Give
currency_get_id
currency id Get
currency_get_title
currency title Get
currency_get_logo
currency logo Get
get_direction
get exchange direction
/api/v1/get_direction/
post-parametrs
direction_id
direction id (*)
currency_id_give
currency id Give
currency_id_get
currency id Get
result
error
0 - no errors
error_text
error description
data
id
direction id
url
direction url
currency_code_give
currency code Give
currency_code_get
currency code Get
currency_give
currency Give
currency_get
currency Get
currency_give_id
currency id Give
currency_get_id
currency id Get
reserve
reserve
course_give
course Give
course_get
course Get
sum_give
amount Give
sum_give_com
amount (add.com + comission PS) Give
sum_get
amount Get
sum_get_com
amount (add.com + comission PS) Get
com_give
text comission Give
com_get
text comission Get
min_give
min. amount Give
max_give
max. amount Give
min_get
min. amount Get
max_get
max. amount Get
pre_fields
fields required to be entered before exchange
give_fields
i give away additional currency fields
get_fields
i get away additional currency fields
dir_fields
additional fields for exchange direction
info
info
txt_timeline
Deadline
txt_description
Exchange description
txt_window
Popup text before order creation
txt_special
Special status text
get_calc
exchange direction calculator
/api/v1/get_calc/
post-parametrs
direction_id
direction id (*)
calc_amount
exchange amount (*)
calc_action
exchange amount ownership [ 1 - give amount, 2 - get amount ] (*)
cd
additional data [ urlencode(http_build_query(cd_data)) ]
result
error
0 - no errors
error_text
error description
data
currency_code_give
currency code Give
currency_code_get
currency code Get
currency_give
currency Give
currency_get
currency Get
currency_give_id
currency id Give
currency_get_id
currency id Get
reserve
reserve
course_give
course Give
course_get
course Get
sum_give
amount Give
sum_give_com
amount (add.com + comission PS) Give
sum_get
amount Get
sum_get_com
amount (add.com + comission PS) Get
com_give
text comission Give
com_get
text comission Get
min_give
min. amount Give
max_give
max. amount Give
min_get
min. amount Get
max_get
max. amount Get
changed
need to change the input amount
create_bid
create exchange order
/api/v1/create_bid/
post-parametrs
direction_id
direction id (*)
calc_amount
exchange amount (*)
calc_action
exchange amount ownership [ 1 - give amount, 2 - get amount ] (*)
clbk_url
callback url
api_id
id width api (unique value)
*
fields data with method "get_direction"
result
error
0 - no errors
error_text
error description
data
url
order url Give
id
order id Get
hash
order hash Give
bid_info
get information about the exchange application
/api/v1/bid_info/
post-parametrs
id
order id (*)
hash
order hash
result
error
0 - no errors
error_text
error description
data
id
order id
hash
order hash
url
order url
status
order status
status_title
order status title
status_descr
order status description
psys_give
payment system Give
psys_get
payment system Get
currency_code_give
currency code Give
currency_code_get
currency code Get
currency_give
currency Give
currency_get
currency Get
currency_give_id
currency id Give
currency_get_id
currency id Get
course_give
course Give
course_get
course Get
amount_give
amount Give
amount_get
amount Get
actions
actions
instruction
payment instruction
pay_amount
payment amount
address
payment account
info
payment account info
cancel
cancel method [default - default method, disabled - disabled canceled]
pay_type
payment method [default, disabled, form, myaction, mypaid, coupon, address, link]
pay_link
payment link data
cancel_bid
set the application status to "cancelled"
/api/v1/cancel_bid/
post-parametrs
id
order id (*)
hash
order hash
result
error
0 - no errors
error_text
error description
data
status
new order status
markpay_bid
set the application status to "marked paid"
/api/v1/markpay_bid/
post-parametrs
id
order id (*)
hash
order hash
result
error
0 - no errors
error_text
error description
data
status
new order status
success_bid
set the application status to "success"
/api/v1/success_bid/
post-parametrs
id
order id (*)
hash
order hash
result
error
0 - no errors
error_text
error description
data
status
new order status
get_exchanges
get exchanges
/api/v1/get_exchanges/
post-parametrs
start_time
unix start time
end_time
unix end time
ip
ip-address
id
oreder id
api_id
id width api
hash
order hash
status_history
show status history
status
order status
limit
number of output (max: 250)
result
error
0 - no errors
error_text
error description
data
id
order id
time
time
date
date
psys_give
payment system Give
psys_get
payment system Get
currency_code_give
currency code Give
currency_code_get
currency code Get
currency_give
currency Give
currency_get
currency Get
currency_give_id
currency id Give
currency_get_id
currency id Get
course_give
course Give
course_get
course Get
amount_give
amount Give
amount_get
amount Get
exchange_success
success status
user_hash
user hash
user_ip
user ip
status
order status
hash
order hash
api_id
id width api
statuses
status history
get_all_exchanges
get all exchanges
/api/v1/get_all_exchanges/
post-parametrs
start_time
unix start time
end_time
unix end time
status
order status
limit
number of output (max: 250)
result
error
0 - no errors
error_text
error description
data
orders data
get_partner_info
get information about the affiliate program
/api/v1/get_partner_info/
result
error
0 - no errors
error_text
error description
data
partner_id
partner id
perc
affiliate percentage
balance
affiliate balance
min_payout
minimum amount for payment
items
list of payment systems for payment
id
PS id
title
PS title
comission
PS comission
amount
amount in this payment system
get_partner_links
get affiliate referrals
/api/v1/get_partner_links/
post-parametrs
start_time
unix start time
end_time
unix end time
ip
ip-address
limit
number of output (max: 250)
result
error
0 - no errors
error_text
error description
data
id
link id
time
time
date
date
user_agent
user agent
ip
ip
referrer
referrer
user_hash
user hash
query_string
query string
get_partner_exchanges
get affiliate exchanges
/api/v1/get_partner_exchanges/
post-parametrs
start_time
unix start time
end_time
unix end time
ip
ip-address
id
oreder id
hash
order hash
status_history
show status history
status
order status
limit
number of output (max: 250)
result
error
0 - no errors
error_text
error description
data
id
link id
time
time
date
date
psys_give
payment system Give
psys_get
payment system Get
currency_code_give
currency code Give
currency_code_get
currency code Get
currency_give
currency Give
currency_get
currency Get
currency_give_id
currency id Give
currency_get_id
currency id Get
course_give
course Give
course_get
course Get
amount_give
amount Give
amount_get
amount Get
exchange_success
success status
user_hash
user hash
user_ip
user ip
status
order status
hash
order hash
accrued
accrual status
partner_reward
partner reward
get_partner_payouts
get affiliate payments
/api/v1/get_partner_payouts/
post-parametrs
start_time
unix start time
end_time
unix end time
id
payout id
limit
number of output (max: 250)
result
error
0 - no errors
error_text
error description
data
id
payout id
time
time
date
date
method_id
method id
account
account number
pay_amount
payment amount
pay_currency_code
payment currency code
original_amount
original amount
original_currency_code
original currency code
status
payout status
add_partner_payout
request for affiliate funds payment
/api/v1/add_partner_payout/
post-parametrs
amount
payment amount
account
account number
method_id
method id
result
error
0 - no errors
error_text
error description
data
payout_id
payout id

© 2025 RichExchanger - professional, reliable, secure currency exchange sсript.

E-mail: richkeeper@gmail.com
Telegram: @richkeeper
Telegram-channel: go to
VK: go to
Русский English

We use cookies to improve the functioning of the site and its interaction with users. By continuing to use the site, you consent to the use of cookies. You can always disable cookies in your browser settings.