Basic Information¶

Universal Parameters¶

Parameter	Type	Format	Description
X-Api-Key	string	max: 255	API key
sign_key	string	max: 255	Symmetric key for signing The following value is used in examples: " your_secret_key_here "
merchant	string		Your merchant name
order_id	string	max: 255	Payment/payout request ID

Standard Signature Generation Method (standart_sign)¶

The standard signature is generated by calculating the SHA256 hash of the following string:

order_id : sign_key

Response Parameters¶

Name	Type	Format	Description
ok*	boolean		Response status
error	string	max: 2056	Error description

Getting Merchant Status¶

Request¶

GET example.com/api/merchant/"merchant"/status/

Headers¶

Name	Value
Content-Type*	application/json
X-Api-Key*	X-Api-Key

Response Parameters¶

Name	Type	Format	Description
balance*	number	double	Your balance in USDT
hold*	number	double	Your hold in USDT (calculated based on pending payout requests)
available*	number	double	Your available funds in USDT
payment_ecom_statuses*	object		Object containing payment gateway operation statuses
payment_ecom_statuses.russian*	boolean		Payment gateway status for Russian payments (enabled/disabled)
payment_ecom_statuses.international*	boolean		Payment gateway status for international payments (enabled/disabled)
payment_methods	array		Array containing information about available payment and payout method statuses for each currency (geo)
payment_methods[].currency	string		Currency code
payment_methods[].statuses	object		Object with payment/payout method statuses
payment_methods[].statuses.pay_in_sbp	boolean		SBP payment status (enabled/disabled)
payment_methods[].statuses.pay_in_card	boolean		Card payment status (enabled/disabled)
payment_methods[].statuses.pay_in_score	boolean		Bank account payment status (enabled/disabled)
payment_methods[].statuses.pay_in_iban	boolean		IBAN payment status (enabled/disabled)
payment_methods[].statuses.pay_out_sbp	boolean		SBP payout status (enabled/disabled)
payment_methods[].statuses.pay_out_card	boolean		Card payout status (enabled/disabled)
payment_methods[].statuses.pay_out_score	boolean		Bank account payout status (enabled/disabled)
payment_methods[].statuses.pay_out_iban	boolean		IBAN payout status (enabled/disabled)

Note: Please note that in the payment_methods objects, only the parameters that are specified for the available pay_in and pay_out methods are returned for each currency.

Response Example¶

200Error 400 and other 4xx

{
  "ok": true,
  "balance": 3000.45,
  "hold": 1354.35,
  "available": 1646.1,
  "payment_ecom_statuses": {
    "russian": true,
    "international": true
  },
  "payment_methods": [
    {
      "currency": "rub",
      "statuses": {
        "pay_in_sbp": true,
        "pay_in_card": true,
        "pay_in_score": true,
        "pay_out_sbp": false,
        "pay_out_card": true,
        "pay_out_score": false
      }
    },
    {
      "currency": "uzs",
      "statuses": {
        "pay_in_score": true,
        "pay_out_score": true
      }
    },
    {
      "currency": "kzt",
      "statuses": {
        "pay_in_card": true,
        "pay_out_card": true
      }
    }
  ]
}

{
  "ok": false,
  "error": "message"
}