Query Scopes

API used to view the scopes enabled.
*This API is only available for Technical Service Provider (TSP), for more information please contact us at: merchant@binance.com

EndPoint

POST /binancepay/openapi/service/provider/config/query

Response Parameters

Attributes	Type	Required	Limitation	Description
status	string	Y	"SUCCESS" or "FAIL"	status of the API request
code	string	Y	-	request result code, refer to
data	DataObject	N	-	response body, refer to
errorMessage	string	N	maximum length 256

Child Attribute

DataObject

Attributes	Type	Required	Limitation	Description
allowFeeShare	boolean	N		is this merchant allow share transaction fee
allowScopes	list[string]	Y		Allow scopes list, List of scopes: CONVERT, REFUND, DIRECT_DEBIT, PROFIT_SHARING, SUB_MERCHANT, CHECKOUT, PAYOUT, REPORT, INTERNAL_TRANSFER, BALANCE

Sample Response

{
  "status": "SUCCESS",
  "code": "000000",
  "data": {
    "allowFeeShare": false,
    "allowScopes": [
      "CONVERT",
      "REFUND",
      "CHECKOUT",
      "PAYOUT",
      "REPORT",
      "INTERNAL_TRANSFER",
      "BALANCE"
    ]
  }
}

{
  "status": "FAIL",
  "code": "400003",
  "errorMessage": "Timestamp for this request is outside of the recvWindow."
}

Result Code

Name	Code	Reason	Solution
UNKNOWN_ERROR	400000	An unknown error occurred while processing the request.	Try again later
INVALID_REQUEST	400001	Parameter format is wrong or parameter transferring doesn't follow the rules.	Please check whether the parameters are correct.
INVALID_SIGNATURE	400002	Incorrect signature result	Check whether the signature parameter and method comply with signature algorithm requirements.
INVALID_TIMESTAMP	400003	Timestamp for this request is outside of the time window.	Sync server clock
INVALID_API_KEY_OR_IP	400004	API identity key not found or invalid.	Check API identity key
BAD_API_KEY_FMT	400005	API identity key format invalid.	Check API identity key.
BAD_HTTP_METHOD	400006	Request method not supported.	Check Request method.
MEDIA_TYPE_NOT_SUPPORTED	400007	Media type not supported.	Check Request Media type.
INVALID_REQUEST_BODY	400008	Request body is not a valid json object.	Check Request body
MANDATORY_PARAM_EMPTY_OR_MALFORMED	400100	A parameter was missing/empty/null, or malformed.
INVALID_PARAM_WRONG_LENGTH	400101	A parameter was not valid, was empty/null, or too long/short, or wrong format.
INVALID_PARAM_WRONG_VALUE	400102	A parameter was not valid, the value is out of range.
INVALID_PARAM_ILLEGAL_CHAR	400103	A parameter was not valid, contains illegal characters
INVALID_REQUEST_TOO_LARGE	400104	Invalid request, content length too large