Request Authorization#

This page describes the request authorization methods for Merchant API and the common error format.

Every request to the API must include the HTTP header: Authorization: Bearer <YOUR-API-KEY>.

<YOUR-API-KEY> is your personal merchant token, which will be provided during integration (see the "Integration Process" page).

Error Format#

The error response body is flat JSON without a human-readable field:

{
  "errorCode": "order_limits_exceeding",
  "params": {
    "min": "100",
    "max": "10000"
  }
}

Field	Type	Required	Description
`errorCode`	string	yes	Error code
`params`	object	no	Error parameters

Code	Situation
400	Invalid parameters or business failure (clarified by `errorCode`)
401	Token missing or invalid
403	Access denied
404	Order not found
409	Duplicate `merchantOrderID`
5xx	Internal server error

`errorCode`	HTTP	Meaning
`unauthorized`	401	Token missing or invalid
`forbidden`	403	Access denied
`order_not_found`	404	Order not found
`invalid_request_parameters`	400	Parameters failed validation
`no_active_merchant_method`	400	Method is not activated for the merchant
`no_payment_details_available`	400	Failed to issue payment details
`order_limits_exceeding`	400	Amount is outside the method limits
`turnover_limits_exceeding`	400	Merchant turnover limits exceeded
`client_id_in_blacklist`	400	Client is blacklisted
`not_enough_money_on_balance`	400	Not enough USDT (PayOut)
`duplicate_merchant_order_id`	409	`merchantOrderID` is already used
`internal_error`	500	Internal error