Query Split
API used to query profit sharing orders.
EndPoint
POST /binancepay/openapi/profitsharing/v1/query-split
Request Parameters
Attributes | Type | Required | Limitation | Description |
---|---|---|---|---|
merchantRequestId | string | Y | 1 <= length <= 32 | The unique identifier from the merchant for this split request. |
prepayOrderId | string | Y | The unique order id generated by binance when you create the order. |
Sample Request Parameter
{
"merchantRequestId": "my_request_1234",
"prepayOrderId": "123456789"
}
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 | Response | N | - | response body, refer to |
errorMessage | string | N | maximum length 256 |
Child Attribute
Response
Attributes | Type | Required | Limitation | Description |
---|---|---|---|---|
splitOrderNo | string | Y | length = 18 | Split order ID |
merchantRequestId | string | Y | 1 <= size <= 32 | Merchant's request ID |
prepayOrderId | string | Y | Prepay order ID | |
status | int | Y | WAITING(0), PROCESSING(1), FINISHED(2) | |
receiverOrderDetails | List(SplitReceiverOrderDetail) | Y | Receiver split detail, refer to |
SplitReceiverOrderDetail
Attributes | Type | Required | Limitation | Description |
---|---|---|---|---|
account | string | Y | Account ID | |
amount | decimal | Y | Amount to split for this account | |
failReason | string | Y | max length = 128 | Failed reason (if any) |
detailId | string | Y | length = 18 | Split detail ID |
status | int | Y | PROCESSING(1), SUCCESS(2), FAIL(3) | |
finishTime | long | Y | Unix timestamp(seconds) when split order detail was processed |
Sample Response
{
"status": "SUCCESS",
"code": "000000",
"data": {
"splitOrderNo": "12345",
"merchantRequestId": "1234567",
"prepayOrderId": "123456789",
"status": 0,
"receiverOrderDetails": [
{
"account" : "12345678",
"amount": 2.5,
"detailId": 1000001,
"status": 2,
"finishTime": 1679044272
}
]
}
}
{
"status": "FAIL",
"code": "400209",
"errorMessage": "order not found or order status is not success"
}