Make payments, and customs declaration for orders.
This is the documentation for version 1.4.8-alpha
of the API. Last update on Jan 13, 2022.
https://nomad.samarkand-global.cn/brokerMerchant queries customs clearance information by order number
Merchant name to payment company, e.g. wechat.prod
Customs code, available options: GUANGZHOU_ZS, HANGZHOU_ZS, NINGBO, ZHENGZHOU_BS, CHONGQING, SHANGHAI_ZS, SHENZHEN, ZHENGZHOU_ZH_ZS
Values are GUANGZHOU_ZS, HANGZHOU_ZS, NINGBO, ZHENGZHOU_BS, CHONGQING, SHANGHAI_ZS, SHENZHEN, ZHENGZHOU_ZH_ZS, or TIANJIN. Default value is GUANGZHOU_ZS.
The internal order number of the merchant system
Payment system internal order number
The internal sub-order number of the merchant system
The internal sub-order number of the WeChat payment system
Redirect url for payment.
Response message
The third party response code
Order number returned by wechat Pay
Request validation failure
Response message
The third party response code
Status code, UNDECLARED: not declared (If the order has been sent to the customs, the merchant resubmits and the customs still has the modification interface); PROCESSING: reporting; SUCCESS: Declaration is successful; FAIL: failed to declare; EXCEPT: The customs interface is abnormal
Order number returned by wechat Pay
The internal order number of the merchant system
The last update time, time zone is GMT+8 beijing
UNCHECKED: did not check the identity information of the order; SAME: consistent with the identity information of the payer; DIFFERENT: inconsistent with the identity information of the payer
The verification agencies
Transaction serial number, from the verification agency, such as the transaction serial number recorded by UnionPay, for merchants to report to the customs
Not Authenticated.
Response message
The third party response code
Status code, UNDECLARED: not declared (If the order has been sent to the customs, the merchant resubmits and the customs still has the modification interface); PROCESSING: reporting; SUCCESS: Declaration is successful; FAIL: failed to declare; EXCEPT: The customs interface is abnormal
Order number returned by wechat Pay
The internal order number of the merchant system
The last update time, time zone is GMT+8 beijing
UNCHECKED: did not check the identity information of the order; SAME: consistent with the identity information of the payer; DIFFERENT: inconsistent with the identity information of the payer
The verification agencies
Transaction serial number, from the verification agency, such as the transaction serial number recorded by UnionPay, for merchants to report to the customs
Something wrong when declaring the payment.
Response message
The third party response code
Status code, UNDECLARED: not declared (If the order has been sent to the customs, the merchant resubmits and the customs still has the modification interface); PROCESSING: reporting; SUCCESS: Declaration is successful; FAIL: failed to declare; EXCEPT: The customs interface is abnormal
Order number returned by wechat Pay
The internal order number of the merchant system
The last update time, time zone is GMT+8 beijing
UNCHECKED: did not check the identity information of the order; SAME: consistent with the identity information of the payer; DIFFERENT: inconsistent with the identity information of the payer
The verification agencies
Transaction serial number, from the verification agency, such as the transaction serial number recorded by UnionPay, for merchants to report to the customs
curl \
-X GET https://nomad.samarkand-global.cn/broker/customs/payment/wechat.prod?customs=GUANGZHOU_ZS&app-api-key=api_token_value{
"code": 200,
"message": "success",
"resultCode": "success",
"transactionId": "1000320306201511078440737890",
"": [
[
{}
]
]
}{
"code": 200,
"message": "success",
"resultCode": "success",
"state": "UNDECLARED",
"transactionId": "1000320306201511078440737890",
"subOrderNo": "1000320306201511078440737890",
"modifyTime": "20091227091010",
"certCheckResult": "UNCHECKED",
"verifyDepartment": "OTHERS",
"verifyDepartmentTradeId": "OTHERS"
}{
"code": 200,
"message": "success",
"resultCode": "success",
"state": "UNDECLARED",
"transactionId": "1000320306201511078440737890",
"subOrderNo": "1000320306201511078440737890",
"modifyTime": "20091227091010",
"certCheckResult": "UNCHECKED",
"verifyDepartment": "OTHERS",
"verifyDepartmentTradeId": "OTHERS"
}{
"code": 200,
"message": "success",
"resultCode": "success",
"state": "UNDECLARED",
"transactionId": "1000320306201511078440737890",
"subOrderNo": "1000320306201511078440737890",
"modifyTime": "20091227091010",
"certCheckResult": "UNCHECKED",
"verifyDepartment": "OTHERS",
"verifyDepartmentTradeId": "OTHERS"
}Merchant name to payment company, e.g. wechat.prod
Customs codes
Values are GUANGZHOU_ZS, HANGZHOU_ZS, NINGBO, ZHENGZHOU_BS, CHONGQING, SHANGHAI_ZS, SHENZHEN, ZHENGZHOU_ZH_ZS, or TIANJIN. Default value is GUANGZHOU_ZS.
The merchant’s record number registered in the customs
The internal order number of the merchant system requires 32 characters, only numbers, uppercase and lowercase letters, and it is unique under the same merchant number.
Order number returned by WeChat Pay
Do not fill in the sub-order number. The internal order number of the merchant system
Do not fill in the sub-order number. Order number returned by WeChat Pay
Payment response.
Response message
The third party response code
Status code, UNDECLARED: not declared (If the order has been sent to the customs, the merchant resubmits and the customs still has the modification interface); PROCESSING: reporting; SUCCESS: Declaration is successful; FAIL: failed to declare; EXCEPT: The customs interface is abnormal
Order number returned by wechat Pay
The internal order number of the merchant system
The last update time, time zone is GMT+8 beijing
UNCHECKED: did not check the identity information of the order; SAME: consistent with the identity information of the payer; DIFFERENT: inconsistent with the identity information of the payer
The verification agencies
Transaction serial number, from the verification agency, such as the transaction serial number recorded by UnionPay, for merchants to report to the customs
Request validation failure
Response message
The third party response code
Status code, UNDECLARED: not declared (If the order has been sent to the customs, the merchant resubmits and the customs still has the modification interface); PROCESSING: reporting; SUCCESS: Declaration is successful; FAIL: failed to declare; EXCEPT: The customs interface is abnormal
Order number returned by wechat Pay
The internal order number of the merchant system
The last update time, time zone is GMT+8 beijing
UNCHECKED: did not check the identity information of the order; SAME: consistent with the identity information of the payer; DIFFERENT: inconsistent with the identity information of the payer
The verification agencies
Transaction serial number, from the verification agency, such as the transaction serial number recorded by UnionPay, for merchants to report to the customs
Not Authenticated.
Response message
The third party response code
Status code, UNDECLARED: not declared (If the order has been sent to the customs, the merchant resubmits and the customs still has the modification interface); PROCESSING: reporting; SUCCESS: Declaration is successful; FAIL: failed to declare; EXCEPT: The customs interface is abnormal
Order number returned by wechat Pay
The internal order number of the merchant system
The last update time, time zone is GMT+8 beijing
UNCHECKED: did not check the identity information of the order; SAME: consistent with the identity information of the payer; DIFFERENT: inconsistent with the identity information of the payer
The verification agencies
Transaction serial number, from the verification agency, such as the transaction serial number recorded by UnionPay, for merchants to report to the customs
Something wrong when redeclare the payment.
Response message
The third party response code
Status code, UNDECLARED: not declared (If the order has been sent to the customs, the merchant resubmits and the customs still has the modification interface); PROCESSING: reporting; SUCCESS: Declaration is successful; FAIL: failed to declare; EXCEPT: The customs interface is abnormal
Order number returned by wechat Pay
The internal order number of the merchant system
The last update time, time zone is GMT+8 beijing
UNCHECKED: did not check the identity information of the order; SAME: consistent with the identity information of the payer; DIFFERENT: inconsistent with the identity information of the payer
The verification agencies
Transaction serial number, from the verification agency, such as the transaction serial number recorded by UnionPay, for merchants to report to the customs
curl \
-X PUT https://nomad.samarkand-global.cn/broker/customs/payment/wechat.prod?app-api-key=api_token_value \
-H "Content-Type: application/json" \
-d '{"customs":"GUANGZHOU_ZS","mchCustomsNo":"31123452K0","outTradeNo":"test2021101901","transactionId":"4200001306202110500000000000.0","subOrderNo":"1000320306201511078440737890","subOrderId":"4200001306202110500000000000.0"}'{
"customs": "GUANGZHOU_ZS",
"mchCustomsNo": "31123452K0",
"outTradeNo": "test2021101901",
"transactionId": "4200001306202110500000000000.0",
"subOrderNo": "1000320306201511078440737890",
"subOrderId": "4200001306202110500000000000.0"
}{
"code": 200,
"message": "success",
"resultCode": "success",
"state": "UNDECLARED",
"transactionId": "1000320306201511078440737890",
"subOrderNo": "1000320306201511078440737890",
"modifyTime": "20091227091010",
"certCheckResult": "UNCHECKED",
"verifyDepartment": "OTHERS",
"verifyDepartmentTradeId": "OTHERS"
}{
"code": 200,
"message": "success",
"resultCode": "success",
"state": "UNDECLARED",
"transactionId": "1000320306201511078440737890",
"subOrderNo": "1000320306201511078440737890",
"modifyTime": "20091227091010",
"certCheckResult": "UNCHECKED",
"verifyDepartment": "OTHERS",
"verifyDepartmentTradeId": "OTHERS"
}{
"code": 200,
"message": "success",
"resultCode": "success",
"state": "UNDECLARED",
"transactionId": "1000320306201511078440737890",
"subOrderNo": "1000320306201511078440737890",
"modifyTime": "20091227091010",
"certCheckResult": "UNCHECKED",
"verifyDepartment": "OTHERS",
"verifyDepartmentTradeId": "OTHERS"
}{
"code": 200,
"message": "success",
"resultCode": "success",
"state": "UNDECLARED",
"transactionId": "1000320306201511078440737890",
"subOrderNo": "1000320306201511078440737890",
"modifyTime": "20091227091010",
"certCheckResult": "UNCHECKED",
"verifyDepartment": "OTHERS",
"verifyDepartmentTradeId": "OTHERS"
}Merchant name to payment company, e.g. wechat.prod
The internal order number of the merchant system requires 32 characters, only numbers, uppercase and lowercase letters, and it is unique under the same merchant number.
Order number returned by WeChat Pay
Customs codes
Values are GUANGZHOU_ZS, HANGZHOU_ZS, NINGBO, ZHENGZHOU_BS, CHONGQING, SHANGHAI_ZS, SHENZHEN, ZHENGZHOU_ZH_ZS, or TIANJIN. Default value is GUANGZHOU_ZS.
The merchant’s record number registered in the customs
Tariff, divided into units
ADD New customs declaration application, MODIFY modification. Default is ADD
Values are ADD or MODIFY. Default value is ADD.
Merchant's sub-order number, must be passed if there is a split order
The currency used for payment of WeChat Pay orders is currently only supported in RMB CNY. If there is an order split, it must be sent.
Default value is CNY.
The amount of the sub-order, in cents, cannot exceed the amount of the original order, order_fee=transport_fee+product_fee (amount payable = logistics fee + product price), if there is a split order, it must be passed.
The logistics cost is divided into units, and must be passed if there is a split order.
Commodity costs, in units of cents, must be passed if there is a split order.
Only mainland ID cards are supported temporarily.
Default value is IDCARD.
The user's mainland ID number, the ID number ending in the letter X, please capitalize the letter X.
User name.
Payment response.
Response message
The third party response code
Status code, UNDECLARED: not declared (If the order has been sent to the customs, the merchant resubmits and the customs still has the modification interface); PROCESSING: reporting; SUCCESS: Declaration is successful; FAIL: failed to declare; EXCEPT: The customs interface is abnormal
Order number returned by wechat Pay
The internal order number of the merchant system
The last update time, time zone is GMT+8 beijing
UNCHECKED: did not check the identity information of the order; SAME: consistent with the identity information of the payer; DIFFERENT: inconsistent with the identity information of the payer
The verification agencies
Transaction serial number, from the verification agency, such as the transaction serial number recorded by UnionPay, for merchants to report to the customs
Request validation failure
Response message
The third party response code
Status code, UNDECLARED: not declared (If the order has been sent to the customs, the merchant resubmits and the customs still has the modification interface); PROCESSING: reporting; SUCCESS: Declaration is successful; FAIL: failed to declare; EXCEPT: The customs interface is abnormal
Order number returned by wechat Pay
The internal order number of the merchant system
The last update time, time zone is GMT+8 beijing
UNCHECKED: did not check the identity information of the order; SAME: consistent with the identity information of the payer; DIFFERENT: inconsistent with the identity information of the payer
The verification agencies
Transaction serial number, from the verification agency, such as the transaction serial number recorded by UnionPay, for merchants to report to the customs
Not Authenticated.
Response message
The third party response code
Status code, UNDECLARED: not declared (If the order has been sent to the customs, the merchant resubmits and the customs still has the modification interface); PROCESSING: reporting; SUCCESS: Declaration is successful; FAIL: failed to declare; EXCEPT: The customs interface is abnormal
Order number returned by wechat Pay
The internal order number of the merchant system
The last update time, time zone is GMT+8 beijing
UNCHECKED: did not check the identity information of the order; SAME: consistent with the identity information of the payer; DIFFERENT: inconsistent with the identity information of the payer
The verification agencies
Transaction serial number, from the verification agency, such as the transaction serial number recorded by UnionPay, for merchants to report to the customs
Something wrong when declaring the payment.
Response message
The third party response code
Status code, UNDECLARED: not declared (If the order has been sent to the customs, the merchant resubmits and the customs still has the modification interface); PROCESSING: reporting; SUCCESS: Declaration is successful; FAIL: failed to declare; EXCEPT: The customs interface is abnormal
Order number returned by wechat Pay
The internal order number of the merchant system
The last update time, time zone is GMT+8 beijing
UNCHECKED: did not check the identity information of the order; SAME: consistent with the identity information of the payer; DIFFERENT: inconsistent with the identity information of the payer
The verification agencies
Transaction serial number, from the verification agency, such as the transaction serial number recorded by UnionPay, for merchants to report to the customs
curl \
-X POST https://nomad.samarkand-global.cn/broker/customs/payment/wechat.prod?app-api-key=api_token_value \
-H "Content-Type: application/json" \
-d '{"outTradeNo":"test2021101901","transactionId":"4200001306202110500000000000.0","customs":"GUANGZHOU_ZS","mchCustomsNo":"31123452K0","duty":88,"actionType":"ADD","subOrderNo":20150806125346,"feeType":"CNY","orderFee":88,"transportFee":88,"productFee":88,"certType":"IDCARD","certId":330821198809085200,"name":"Zhangsan"}'{
"outTradeNo": "test2021101901",
"transactionId": "4200001306202110500000000000.0",
"customs": "GUANGZHOU_ZS",
"mchCustomsNo": "31123452K0",
"duty": 88,
"actionType": "ADD",
"subOrderNo": 20150806125346,
"feeType": "CNY",
"orderFee": 88,
"transportFee": 88,
"productFee": 88,
"certType": "IDCARD",
"certId": 330821198809085200,
"name": "Zhangsan"
}{
"code": 200,
"message": "success",
"resultCode": "success",
"state": "UNDECLARED",
"transactionId": "1000320306201511078440737890",
"subOrderNo": "1000320306201511078440737890",
"modifyTime": "20091227091010",
"certCheckResult": "UNCHECKED",
"verifyDepartment": "OTHERS",
"verifyDepartmentTradeId": "OTHERS"
}{
"code": 200,
"message": "success",
"resultCode": "success",
"state": "UNDECLARED",
"transactionId": "1000320306201511078440737890",
"subOrderNo": "1000320306201511078440737890",
"modifyTime": "20091227091010",
"certCheckResult": "UNCHECKED",
"verifyDepartment": "OTHERS",
"verifyDepartmentTradeId": "OTHERS"
}{
"code": 200,
"message": "success",
"resultCode": "success",
"state": "UNDECLARED",
"transactionId": "1000320306201511078440737890",
"subOrderNo": "1000320306201511078440737890",
"modifyTime": "20091227091010",
"certCheckResult": "UNCHECKED",
"verifyDepartment": "OTHERS",
"verifyDepartmentTradeId": "OTHERS"
}{
"code": 200,
"message": "success",
"resultCode": "success",
"state": "UNDECLARED",
"transactionId": "1000320306201511078440737890",
"subOrderNo": "1000320306201511078440737890",
"modifyTime": "20091227091010",
"certCheckResult": "UNCHECKED",
"verifyDepartment": "OTHERS",
"verifyDepartmentTradeId": "OTHERS"
}ID used for refund
Payment method of the order - wechatpay or alipay
Order transection ID from payment
Sub order reference
Products in this sub order
In CNY. Total amount of this sub order excluding logistics fee, which uses the base unit of the currency.
In CNY. Logistics fee of this sub order, which uses the base unit of the currency.
curl \
-X POST https://nomad.samarkand-global.cn/broker/declare?app-api-key=api_token_value \
-H "Content-Type: application/json" \
-d '{"reportId":"A0987654321","paymentMethod":"wechatpay","trxId":"TX1234567890","subOrder":[{"subOrderRef":"O123456789S1","product":[{"name":"Everyday Hair Conditioner","url":"https://myshop.com/everyday-hair-conditioner"}],"totalFee":1050,"logsiticsFee":50}]}'{
"reportId": "A0987654321",
"paymentMethod": "wechatpay",
"trxId": "TX1234567890",
"subOrder": [
{
"subOrderRef": "O123456789S1",
"product": [
{
"name": "Everyday Hair Conditioner",
"url": "https://myshop.com/everyday-hair-conditioner"
}
],
"totalFee": 1050,
"logsiticsFee": 50
}
]
}{
"status": "SUCCESS"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success",
"errors": "Something wrong when making the service."
}Declare an order after successful payment on youzan platform
In RMB fen. Total amount of order
Order ID
Sub order ID (optional)
Payment transaction number from youzan payment response
Successfully submitted the customs declaration.
Youzan store ID
Sub order ID (if subOrderId is included in request)
Status code from customs (1. processing, 2. successful, 3. failed, 4. rejected by customs, 5. in customs warehouse, 6. something wrong, please try again)
Customs declaration ID of the payment
Order ID
Payment transaction number from youzan payment response
Failure
Request validation failure
Failure
curl \
-X POST https://nomad.samarkand-global.cn/broker/declare-order/youzan?app-api-key=api_token_value \
-H "Content-Type: application/json" \
-H "X-Youzan-Token: string" \
-d '{"amount":19300,"orderId":"E20200206101847089000001","subOrderId":"E202002061018470890000019610GZ","youzanTrxId":200206101849000130}'# Headers
X-Youzan-Token: string
# Payload
{
"amount": 19300,
"orderId": "E20200206101847089000001",
"subOrderId": "E202002061018470890000019610GZ",
"youzanTrxId": 200206101849000130
}{
"storeId": 41261615,
"subOrderId": "E202002061018470890000019610GZ",
"customsStatus": 2,
"paymentCustomsId": "200206101849000125961003",
"orderId": "E20200206101847089000001",
"youzanTrxId": "200206101849000125"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success",
"errors": "Something wrong when making the service."
}Must be wechatpay or alipay
Order reference
Order total amount, which uses the base unit of current currency
Must be CNY or GBP
This url is notified when the payment succeeds
All products in this order
curl \
-X POST https://nomad.samarkand-global.cn/broker/pay?app-api-key=api_token_value \
-H "Content-Type: application/json" \
-d '{"paymentMethod":"wechatpay","orderRef":"O123456789","total":2200,"currency":"CNY","orderSuccessUrl":"https://notify.order.success","product":[{"name":"Everyday Hair Conditioner","url":"https://myshop.com/everyday-hair-conditioner"}]}'{
"paymentMethod": "wechatpay",
"orderRef": "O123456789",
"total": 2200,
"currency": "CNY",
"orderSuccessUrl": "https://notify.order.success",
"product": [
{
"name": "Everyday Hair Conditioner",
"url": "https://myshop.com/everyday-hair-conditioner"
}
]
}{
"payUrl": "https://payment.page.for.the.order",
"trxId": "TX1234567890"
}{
"errors": "Not Authenticated."
}{
"field": "orderRef",
"msg": "cannot be empty"
}{
"errors": "Something wrong when making the payment."
}Merchant name to payment company, e.g. weixinpay.test
Merchant order no.
Redirect url for payment.
Response message
Merchant order no
Paymer amount currency
Amount currency
Payer total amount, unit is fen
Total amount, unit is fen
Bank type
Payment time
Transaction ID
Trade state
Trade state description
Trade type
Not Authenticated.
Something wrong when making the payment.
curl \
-X GET https://nomad.samarkand-global.cn/broker/payment/wechat.test?order_ref=test202101&app-api-key=api_token_value{
"code": 200,
"message": "success",
"orderRef": "test202103",
"payerCurrency": "CNY",
"currency": "CNY",
"payerTotal": 10,
"total": 10,
"bankType": "string",
"Timing": "2021-11-02T17:03:38+08:00",
"transactionId": "4200001148202111020556019250",
"tradeState": "SUCCESS",
"tradeStateDesc": "支付成功",
"tradeType": "MWEB"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success",
"errors": "Something wrong when making the service."
}Merchant name to payment company, e.g. weixinpay.test
Payment method, must be wechatpay or alipay
Values are wechatpay or alipay.
Payment companies have different payment types
Values are NATIVE, H5, or JSAPI.
Order reference
Order total amount, which uses the base unit of current currency
Must be CNY or GBP
Whether the order is going to share profit
Default value is true.
Subsidy amount, only works when profitSharing is True
All products in this order
Product description
curl \
-X POST https://nomad.samarkand-global.cn/broker/payment/wechat.test?app-api-key=api_token_value \
-H "Content-Type: application/json" \
-d '{"paymentMethod":"wechatpay","paymentType":"H5","orderRef":"O123456789","total":2200,"currency":"CNY","profitSharing":true,"subsidyAmount":0,"product":[{"name":"Everyday Hair Conditioner","url":"https://myshop.com/everyday-hair-conditioner"}],"description":"面膜 mask"}'{
"paymentMethod": "wechatpay",
"paymentType": "H5",
"orderRef": "O123456789",
"total": 2200,
"currency": "CNY",
"profitSharing": true,
"subsidyAmount": 0,
"product": [
{
"name": "Everyday Hair Conditioner",
"url": "https://myshop.com/everyday-hair-conditioner"
}
],
"description": "面膜 mask"
}{
"code": 200,
"message": "success",
"prePayUrl": "https://payment.page.for.the.order",
"payUrl": "weixin://wap/pay?prepayid%3Dwx27132822987960ddbf8532d86857e50000&package=1570653087&noncestr=1635312518&sign=356e4d9aec18f77f9084af1295bc255e",
"payPage": "string"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success",
"errors": "Something wrong when making the service."
}curl \
-X POST https://nomad.samarkand-global.cn/broker/payment/close/wechat.test/wechat.test?app-api-key=api_token_value{
"code": 200,
"message": "success",
"paymentMessage": "success"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success",
"errors": "Something wrong when making the service."
}Merchant name to payment company, e.g. weixinpay.test
Payment method, must be wechatpay or alipay
Values are wechatpay or alipay.
Payment companies have different payment types
Values are NATIVE, H5, or JSAPI.
This url is notified when the payment succeeds
curl \
-X POST https://nomad.samarkand-global.cn/broker/payment/invocation/wechat.test?app-api-key=api_token_value \
-H "Content-Type: application/json" \
-d '{"paymentMethod":"wechatpay","paymentType":"H5","invocationUrl":"https://wx.tenpay.com/cgi-bin/mmpayweb-bin/checkmweb?prepay_id=wx2711083228719406a31dfe004d2b0c0000\u0026package=3754039013"}'{
"paymentMethod": "wechatpay",
"paymentType": "H5",
"invocationUrl": "https://wx.tenpay.com/cgi-bin/mmpayweb-bin/checkmweb?prepay_id=wx2711083228719406a31dfe004d2b0c0000&package=3754039013"
}{
"code": 200,
"message": "success",
"prePayUrl": "https://payment.page.for.the.order",
"payUrl": "weixin://wap/pay?prepayid%3Dwx27132822987960ddbf8532d86857e50000&package=1570653087&noncestr=1635312518&sign=356e4d9aec18f77f9084af1295bc255e",
"payPage": "string"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success",
"errors": "Something wrong when making the service."
}Merchant name to payment company, e.g. wechat.prod
The payout number of the merchant, shall be generated by the merchant when initiating the payout request
Payment system internal order number
Query payout order successful.
Response message
The payout number of the merchant, shall be generated by the merchant when initiating the payout request
Wechat payout number
Wechat payout number
Payout order result state
Values are ACCEPT, SUCCESS, or FAIL.
Payout order failed reason. Request status that can be retried: BALANCE_NOT_ENOUGH
Amount of RMB to be payout, unit is cent
Foreign amount to be payout, minimum unit of money
The ratio of the quoted currency to the payment currency multiplied by 10 to the eighth Value, for example, if the ratio of USD to RMB is 6.5, rate=650000000
Exchange rate time，east 8 regional time
Estimate exchange rate time，east 8 regional time
Available abroad amounts, unit is cent
Request validation failure
Response message
The payout number of the merchant, shall be generated by the merchant when initiating the payout request
Wechat payout number
Wechat payout number
Payout order result state
Values are ACCEPT, SUCCESS, or FAIL.
Payout order failed reason. Request status that can be retried: BALANCE_NOT_ENOUGH
Amount of RMB to be payout, unit is cent
Foreign amount to be payout, minimum unit of money
The ratio of the quoted currency to the payment currency multiplied by 10 to the eighth Value, for example, if the ratio of USD to RMB is 6.5, rate=650000000
Exchange rate time，east 8 regional time
Estimate exchange rate time，east 8 regional time
Available abroad amounts, unit is cent
Not Authenticated.
Response message
The payout number of the merchant, shall be generated by the merchant when initiating the payout request
Wechat payout number
Wechat payout number
Payout order result state
Values are ACCEPT, SUCCESS, or FAIL.
Payout order failed reason. Request status that can be retried: BALANCE_NOT_ENOUGH
Amount of RMB to be payout, unit is cent
Foreign amount to be payout, minimum unit of money
The ratio of the quoted currency to the payment currency multiplied by 10 to the eighth Value, for example, if the ratio of USD to RMB is 6.5, rate=650000000
Exchange rate time，east 8 regional time
Estimate exchange rate time，east 8 regional time
Available abroad amounts, unit is cent
Something wrong when query the payout.
Response message
The payout number of the merchant, shall be generated by the merchant when initiating the payout request
Wechat payout number
Wechat payout number
Payout order result state
Values are ACCEPT, SUCCESS, or FAIL.
Payout order failed reason. Request status that can be retried: BALANCE_NOT_ENOUGH
Amount of RMB to be payout, unit is cent
Foreign amount to be payout, minimum unit of money
The ratio of the quoted currency to the payment currency multiplied by 10 to the eighth Value, for example, if the ratio of USD to RMB is 6.5, rate=650000000
Exchange rate time，east 8 regional time
Estimate exchange rate time，east 8 regional time
Available abroad amounts, unit is cent
curl \
-X GET https://nomad.samarkand-global.cn/broker/payout/abroad/wechat.prod?out_order_id=string&transaction_id=string&app-api-key=api_token_value{
"code": 200,
"message": "success",
"outOrderId": "string",
"transactionId": "42000000000_123123",
"result": "SUCCESS",
"failReason": "BALANCE_NOT_ENOUGH",
"amount": 88,
"foreignAmount": 88,
"rate": 88,
"exchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"estimateExchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"availableAbroadAmount": 88
}{
"code": 200,
"message": "success",
"outOrderId": "string",
"transactionId": "42000000000_123123",
"result": "SUCCESS",
"failReason": "BALANCE_NOT_ENOUGH",
"amount": 88,
"foreignAmount": 88,
"rate": 88,
"exchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"estimateExchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"availableAbroadAmount": 88
}{
"code": 200,
"message": "success",
"outOrderId": "string",
"transactionId": "42000000000_123123",
"result": "SUCCESS",
"failReason": "BALANCE_NOT_ENOUGH",
"amount": 88,
"foreignAmount": 88,
"rate": 88,
"exchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"estimateExchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"availableAbroadAmount": 88
}{
"code": 200,
"message": "success",
"outOrderId": "string",
"transactionId": "42000000000_123123",
"result": "SUCCESS",
"failReason": "BALANCE_NOT_ENOUGH",
"amount": 88,
"foreignAmount": 88,
"rate": 88,
"exchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"estimateExchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"availableAbroadAmount": 88
}Merchant name to payment company, e.g. wechat.prod
The payout number of the merchant, shall be generated by the merchant when initiating the payout request
Wechat transaction number
Amount of RMB to be payout, unit is cent
Currency of overseas payment. Note: The currency field is related to wechat Pay payee ID
Goods information, the number cannot exceed 10
Goods name.
The merchant's own classification， for example, with/interval.
Goods unit price, unit is cent
Goods quantity
Name of operator of overseas seller
Name of the overseas seller's shop
The ID of the seller inside the merchant system
Logistics order number
Name of logistics provider
The payee ID assigned by wechat Pay when accessing the outbound service of wechat Pay.
Query payout order successful.
Response message
The payout number of the merchant, shall be generated by the merchant when initiating the payout request
Wechat payout number
Wechat payout number
Payout order result state
Values are ACCEPT, SUCCESS, or FAIL.
Payout order failed reason. Request status that can be retried: BALANCE_NOT_ENOUGH
Amount of RMB to be payout, unit is cent
Foreign amount to be payout, minimum unit of money
The ratio of the quoted currency to the payment currency multiplied by 10 to the eighth Value, for example, if the ratio of USD to RMB is 6.5, rate=650000000
Exchange rate time，east 8 regional time
Estimate exchange rate time，east 8 regional time
Available abroad amounts, unit is cent
Request validation failure
Response message
The payout number of the merchant, shall be generated by the merchant when initiating the payout request
Wechat payout number
Wechat payout number
Payout order result state
Values are ACCEPT, SUCCESS, or FAIL.
Payout order failed reason. Request status that can be retried: BALANCE_NOT_ENOUGH
Amount of RMB to be payout, unit is cent
Foreign amount to be payout, minimum unit of money
The ratio of the quoted currency to the payment currency multiplied by 10 to the eighth Value, for example, if the ratio of USD to RMB is 6.5, rate=650000000
Exchange rate time，east 8 regional time
Estimate exchange rate time，east 8 regional time
Available abroad amounts, unit is cent
Not Authenticated.
Response message
The payout number of the merchant, shall be generated by the merchant when initiating the payout request
Wechat payout number
Wechat payout number
Payout order result state
Values are ACCEPT, SUCCESS, or FAIL.
Payout order failed reason. Request status that can be retried: BALANCE_NOT_ENOUGH
Amount of RMB to be payout, unit is cent
Foreign amount to be payout, minimum unit of money
The ratio of the quoted currency to the payment currency multiplied by 10 to the eighth Value, for example, if the ratio of USD to RMB is 6.5, rate=650000000
Exchange rate time，east 8 regional time
Estimate exchange rate time，east 8 regional time
Available abroad amounts, unit is cent
Something wrong when query the payout.
Response message
The payout number of the merchant, shall be generated by the merchant when initiating the payout request
Wechat payout number
Wechat payout number
Payout order result state
Values are ACCEPT, SUCCESS, or FAIL.
Payout order failed reason. Request status that can be retried: BALANCE_NOT_ENOUGH
Amount of RMB to be payout, unit is cent
Foreign amount to be payout, minimum unit of money
The ratio of the quoted currency to the payment currency multiplied by 10 to the eighth Value, for example, if the ratio of USD to RMB is 6.5, rate=650000000
Exchange rate time，east 8 regional time
Estimate exchange rate time，east 8 regional time
Available abroad amounts, unit is cent
curl \
-X POST https://nomad.samarkand-global.cn/broker/payout/abroad/wechat.prod?app-api-key=api_token_value \
-H "Content-Type: application/json" \
-d '{"outOrderId":"string","transactionId":"transaction_id_123","amount":88,"foreignCurrency":"USD","goodsInfo":[{"goodsName":"Orange","goodsCategory":"health-beauty/fragrance","goodsUnitPrice":12,"goodsQuantity":1}],"sellerInfo":{"overseaBusinessName":"香港 xxxx 公司","overseaShopName":"香港 xxx 公司 xxx 店铺","sellerId":"id2123123123"},"expressInfo":{"courierNumber":"SF1341558741234","expressCompanyName":"国际 xxx 物流"},"payeeInfo":{"payeeId":"id123112312"}}'{
"outOrderId": "string",
"transactionId": "transaction_id_123",
"amount": 88,
"foreignCurrency": "USD",
"goodsInfo": [
{
"goodsName": "Orange",
"goodsCategory": "health-beauty/fragrance",
"goodsUnitPrice": 12,
"goodsQuantity": 1
}
],
"sellerInfo": {
"overseaBusinessName": "香港 xxxx 公司",
"overseaShopName": "香港 xxx 公司 xxx 店铺",
"sellerId": "id2123123123"
},
"expressInfo": {
"courierNumber": "SF1341558741234",
"expressCompanyName": "国际 xxx 物流"
},
"payeeInfo": {
"payeeId": "id123112312"
}
}{
"code": 200,
"message": "success",
"outOrderId": "string",
"transactionId": "42000000000_123123",
"result": "SUCCESS",
"failReason": "BALANCE_NOT_ENOUGH",
"amount": 88,
"foreignAmount": 88,
"rate": 88,
"exchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"estimateExchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"availableAbroadAmount": 88
}{
"code": 200,
"message": "success",
"outOrderId": "string",
"transactionId": "42000000000_123123",
"result": "SUCCESS",
"failReason": "BALANCE_NOT_ENOUGH",
"amount": 88,
"foreignAmount": 88,
"rate": 88,
"exchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"estimateExchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"availableAbroadAmount": 88
}{
"code": 200,
"message": "success",
"outOrderId": "string",
"transactionId": "42000000000_123123",
"result": "SUCCESS",
"failReason": "BALANCE_NOT_ENOUGH",
"amount": 88,
"foreignAmount": 88,
"rate": 88,
"exchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"estimateExchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"availableAbroadAmount": 88
}{
"code": 200,
"message": "success",
"outOrderId": "string",
"transactionId": "42000000000_123123",
"result": "SUCCESS",
"failReason": "BALANCE_NOT_ENOUGH",
"amount": 88,
"foreignAmount": 88,
"rate": 88,
"exchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"estimateExchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"availableAbroadAmount": 88
}Merchant name to payment company, e.g. wechat.prod
Bill date. Query format YYYY-MM-DD, for example, 2021-01-01
Merchant ID of wechat merchant.
curl \
-X GET https://nomad.samarkand-global.cn/broker/payout/bill/abroad/{merchant}?bill_date=string&app-api-key=api_token_value{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success"
}Merchant name to payment company, e.g. wechat.prod
Abroad payout bill operations, available: GetAvailableAbroadAmounts
Wechat transaction number
Payout funds transactions operation execute successfully.
Response message
The payout number of the merchant, shall be generated by the merchant when initiating the payout request
Wechat payout number
Payout order result state
Values are ACCEPT, SUCCESS, or FAIL.
Payout order failed reason. Request status that can be retried: BALANCE_NOT_ENOUGH
Amount of RMB to be payout, unit is cent
Foreign amount to be payout, minimum unit of money
The ratio of the quoted currency to the payment currency multiplied by 10 to the eighth Value, for example, if the ratio of USD to RMB is 6.5, rate=650000000
Exchange rate time，east 8 regional time
Estimate exchange rate time，east 8 regional time
Available abroad amounts, unit is cent
Request validation failure
Not Authenticated.
Something wrong when download the payout bill.
curl \
-X POST https://nomad.samarkand-global.cn/broker/payout/bill/abroad/{merchant}?app-api-key=api_token_value \
-H "Content-Type: application/json" \
-d '{"operation":"GetAvailableAbroadAmounts","transactionId":"transaction_id_123"}'{
"operation": "GetAvailableAbroadAmounts",
"transactionId": "transaction_id_123"
}{
"code": 200,
"message": "success",
"outOrderId": "string",
"transactionId": "42000000000_123123",
"result": "SUCCESS",
"failReason": "BALANCE_NOT_ENOUGH",
"amount": 88,
"foreignAmount": 88,
"rate": 88,
"exchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"estimateExchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"availableAbroadAmount": 88
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success"
}{
"code": 200,
"message": "success"
}Merchant name to payment company, e.g. wechat.prod
The profit sharing number of the merchant, shall be unique within merchant system
Payment system internal order number
Query payout order successful.
Response message
The profit sharing number of the merchant
Wechat transaction number
Payment system order number, the unique identifier returned by the payment system
Profit sharing order status
Values are PROCESSING or FINISHED.
Receivers of the profit sharing
Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available
Values are MERCHANT_ID or PERSONAL_OPENID.
The receiver account.
The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation
The description of profit sharing.
Merchant ID of receiver.
Profit sharing order result
Values are PENDING, SUCCESS, REFUND, or CLOSED.
The finish time of profit sharing with the rfc3339 standard format.
The failed reason of profit sharing.
Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.
Profit sharing detailed order number, which can be used for reconciliation with the fund bill.
Description of the end of the profit sharing
The amount of the end of the profit sharing, in cent
Request validation failure
Response message
The profit sharing number of the merchant
Wechat transaction number
Payment system order number, the unique identifier returned by the payment system
Profit sharing order status
Values are PROCESSING or FINISHED.
Receivers of the profit sharing
Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available
Values are MERCHANT_ID or PERSONAL_OPENID.
The receiver account.
The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation
The description of profit sharing.
Merchant ID of receiver.
Profit sharing order result
Values are PENDING, SUCCESS, REFUND, or CLOSED.
The finish time of profit sharing with the rfc3339 standard format.
The failed reason of profit sharing.
Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.
Profit sharing detailed order number, which can be used for reconciliation with the fund bill.
Description of the end of the profit sharing
The amount of the end of the profit sharing, in cent
Not Authenticated.
Response message
The profit sharing number of the merchant
Wechat transaction number
Payment system order number, the unique identifier returned by the payment system
Profit sharing order status
Values are PROCESSING or FINISHED.
Receivers of the profit sharing
Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available
Values are MERCHANT_ID or PERSONAL_OPENID.
The receiver account.
The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation
The description of profit sharing.
Merchant ID of receiver.
Profit sharing order result
Values are PENDING, SUCCESS, REFUND, or CLOSED.
The finish time of profit sharing with the rfc3339 standard format.
The failed reason of profit sharing.
Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.
Profit sharing detailed order number, which can be used for reconciliation with the fund bill.
Description of the end of the profit sharing
The amount of the end of the profit sharing, in cent
Something wrong when query the payout.
Response message
The profit sharing number of the merchant
Wechat transaction number
Payment system order number, the unique identifier returned by the payment system
Profit sharing order status
Values are PROCESSING or FINISHED.
Receivers of the profit sharing
Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available
Values are MERCHANT_ID or PERSONAL_OPENID.
The receiver account.
The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation
The description of profit sharing.
Merchant ID of receiver.
Profit sharing order result
Values are PENDING, SUCCESS, REFUND, or CLOSED.
The finish time of profit sharing with the rfc3339 standard format.
The failed reason of profit sharing.
Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.
Profit sharing detailed order number, which can be used for reconciliation with the fund bill.
Description of the end of the profit sharing
The amount of the end of the profit sharing, in cent
curl \
-X GET https://nomad.samarkand-global.cn/broker/profit/sharing/wechat.prod?out_order_no=string&transaction_id=string&app-api-key=api_token_value{
"code": 200,
"message": "success",
"outOrderNo": "string",
"transactionId": "transaction_id_123",
"orderId": "string",
"status": "FINISHED",
"receivers": [
{
"type": "MERCHANT_ID",
"receiverAccount": "1900000109",
"amount": 12,
"description": "分帐1900000110",
"receiverMchid": "Orange",
"result": "SUCCESS",
"finishTime": "2015-05-20T13:29:35.120+08:00",
"failReason": "NO_RELATION",
"detailId": "3601111111111111111111"
}
],
"finishDescription": "string",
"finishAmount": 88
}{
"code": 200,
"message": "success",
"outOrderNo": "string",
"transactionId": "transaction_id_123",
"orderId": "string",
"status": "FINISHED",
"receivers": [
{
"type": "MERCHANT_ID",
"receiverAccount": "1900000109",
"amount": 12,
"description": "分帐1900000110",
"receiverMchid": "Orange",
"result": "SUCCESS",
"finishTime": "2015-05-20T13:29:35.120+08:00",
"failReason": "NO_RELATION",
"detailId": "3601111111111111111111"
}
],
"finishDescription": "string",
"finishAmount": 88
}{
"code": 200,
"message": "success",
"outOrderNo": "string",
"transactionId": "transaction_id_123",
"orderId": "string",
"status": "FINISHED",
"receivers": [
{
"type": "MERCHANT_ID",
"receiverAccount": "1900000109",
"amount": 12,
"description": "分帐1900000110",
"receiverMchid": "Orange",
"result": "SUCCESS",
"finishTime": "2015-05-20T13:29:35.120+08:00",
"failReason": "NO_RELATION",
"detailId": "3601111111111111111111"
}
],
"finishDescription": "string",
"finishAmount": 88
}{
"code": 200,
"message": "success",
"outOrderNo": "string",
"transactionId": "transaction_id_123",
"orderId": "string",
"status": "FINISHED",
"receivers": [
{
"type": "MERCHANT_ID",
"receiverAccount": "1900000109",
"amount": 12,
"description": "分帐1900000110",
"receiverMchid": "Orange",
"result": "SUCCESS",
"finishTime": "2015-05-20T13:29:35.120+08:00",
"failReason": "NO_RELATION",
"detailId": "3601111111111111111111"
}
],
"finishDescription": "string",
"finishAmount": 88
}Merchant name to payment company, e.g. wechat.prod
The profit sharing number of the merchant
Wechat transaction number
Whether the account distribution is completed. If it is false, the remaining amount of this order will not be unfrozen and returned to the secondary merchants, and the order can be divided again.
Receivers of the profit sharing.
Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available
Values are MERCHANT_ID or PERSONAL_OPENID.
The receiver account.
The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation
The description of profit sharing.
Query payout order successful.
Response message
The profit sharing number of the merchant
Wechat transaction number
Payment system order number, the unique identifier returned by the payment system
Profit sharing order status
Values are PROCESSING or FINISHED.
Receivers of the profit sharing
Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available
Values are MERCHANT_ID or PERSONAL_OPENID.
The receiver account.
The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation
The description of profit sharing.
Merchant ID of receiver.
Profit sharing order result
Values are PENDING, SUCCESS, REFUND, or CLOSED.
The finish time of profit sharing with the rfc3339 standard format.
The failed reason of profit sharing.
Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.
Profit sharing detailed order number, which can be used for reconciliation with the fund bill.
Description of the end of the profit sharing
The amount of the end of the profit sharing, in cent
Request validation failure
Response message
The profit sharing number of the merchant
Wechat transaction number
Payment system order number, the unique identifier returned by the payment system
Profit sharing order status
Values are PROCESSING or FINISHED.
Receivers of the profit sharing
Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available
Values are MERCHANT_ID or PERSONAL_OPENID.
The receiver account.
The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation
The description of profit sharing.
Merchant ID of receiver.
Profit sharing order result
Values are PENDING, SUCCESS, REFUND, or CLOSED.
The finish time of profit sharing with the rfc3339 standard format.
The failed reason of profit sharing.
Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.
Profit sharing detailed order number, which can be used for reconciliation with the fund bill.
Description of the end of the profit sharing
The amount of the end of the profit sharing, in cent
Not Authenticated.
Response message
The profit sharing number of the merchant
Wechat transaction number
Payment system order number, the unique identifier returned by the payment system
Profit sharing order status
Values are PROCESSING or FINISHED.
Receivers of the profit sharing
Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available
Values are MERCHANT_ID or PERSONAL_OPENID.
The receiver account.
The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation
The description of profit sharing.
Merchant ID of receiver.
Profit sharing order result
Values are PENDING, SUCCESS, REFUND, or CLOSED.
The finish time of profit sharing with the rfc3339 standard format.
The failed reason of profit sharing.
Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.
Profit sharing detailed order number, which can be used for reconciliation with the fund bill.
Description of the end of the profit sharing
The amount of the end of the profit sharing, in cent
Something wrong when query the payout.
Response message
The profit sharing number of the merchant
Wechat transaction number
Payment system order number, the unique identifier returned by the payment system
Profit sharing order status
Values are PROCESSING or FINISHED.
Receivers of the profit sharing
Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available
Values are MERCHANT_ID or PERSONAL_OPENID.
The receiver account.
The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation
The description of profit sharing.
Merchant ID of receiver.
Profit sharing order result
Values are PENDING, SUCCESS, REFUND, or CLOSED.
The finish time of profit sharing with the rfc3339 standard format.
The failed reason of profit sharing.
Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.
Profit sharing detailed order number, which can be used for reconciliation with the fund bill.
Description of the end of the profit sharing
The amount of the end of the profit sharing, in cent
curl \
-X POST https://nomad.samarkand-global.cn/broker/profit/sharing/wechat.prod?app-api-key=api_token_value \
-H "Content-Type: application/json" \
-d '{"outOrderNo":"string","transactionId":"transaction_id_123","finish":false,"receivers":[{"type":"MERCHANT_ID","receiverAccount":"1900000109","amount":12,"description":"分帐1900000110"}]}'{
"outOrderNo": "string",
"transactionId": "transaction_id_123",
"finish": false,
"receivers": [
{
"type": "MERCHANT_ID",
"receiverAccount": "1900000109",
"amount": 12,
"description": "分帐1900000110"
}
]
}{
"code": 200,
"message": "success",
"outOrderNo": "string",
"transactionId": "transaction_id_123",
"orderId": "string",
"status": "FINISHED",
"receivers": [
{
"type": "MERCHANT_ID",
"receiverAccount": "1900000109",
"amount": 12,
"description": "分帐1900000110",
"receiverMchid": "Orange",
"result": "SUCCESS",
"finishTime": "2015-05-20T13:29:35.120+08:00",
"failReason": "NO_RELATION",
"detailId": "3601111111111111111111"
}
],
"finishDescription": "string",
"finishAmount": 88
}{
"code": 200,
"message": "success",
"outOrderNo": "string",
"transactionId": "transaction_id_123",
"orderId": "string",
"status": "FINISHED",
"receivers": [
{
"type": "MERCHANT_ID",
"receiverAccount": "1900000109",
"amount": 12,
"description": "分帐1900000110",
"receiverMchid": "Orange",
"result": "SUCCESS",
"finishTime": "2015-05-20T13:29:35.120+08:00",
"failReason": "NO_RELATION",
"detailId": "3601111111111111111111"
}
],
"finishDescription": "string",
"finishAmount": 88
}{
"code": 200,
"message": "success",
"outOrderNo": "string",
"transactionId": "transaction_id_123",
"orderId": "string",
"status": "FINISHED",
"receivers": [
{
"type": "MERCHANT_ID",
"receiverAccount": "1900000109",
"amount": 12,
"description": "分帐1900000110",
"receiverMchid": "Orange",
"result": "SUCCESS",
"finishTime": "2015-05-20T13:29:35.120+08:00",
"failReason": "NO_RELATION",
"detailId": "3601111111111111111111"
}
],
"finishDescription": "string",
"finishAmount": 88
}{
"code": 200,
"message": "success",
"outOrderNo": "string",
"transactionId": "transaction_id_123",
"orderId": "string",
"status": "FINISHED",
"receivers": [
{
"type": "MERCHANT_ID",
"receiverAccount": "1900000109",
"amount": 12,
"description": "分帐1900000110",
"receiverMchid": "Orange",
"result": "SUCCESS",
"finishTime": "2015-05-20T13:29:35.120+08:00",
"failReason": "NO_RELATION",
"detailId": "3601111111111111111111"
}
],
"finishDescription": "string",
"finishAmount": 88
}Merchant name to payment company, e.g. wechat.prod
Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available
Values are MERCHANT_ID or PERSONAL_OPENID.
The receiver account.
The receiver name.
Relationship between sub-merchant and recipient.
Values are SUPPLIER, DISTRIBUTOR, SERVICE_PROVIDER, PLATFORM, or OTHERS.
Ciphertext of individual name(verify if value is passed)