Path parameters
-
merchant string Required
Merchant name to payment company, e.g. wechat.sh_smk
Body
-
outOrderId string
The payout number of the merchant, shall be generated by the merchant when initiating the payout request
-
transactionId string
Payment company transaction number
-
paymentMethod string
Payment method, must be wechatpay or alipay
Values are
wechatpay
oralipay
. -
amount integer
Amount of RMB to be payout, unit is cent
-
foreignCurrency string
Currency of overseas payment. Note: The currency field is related to Payment company payee ID
-
goodsInfo array[object]
Goods information, the number cannot exceed 10
-
sellerInfo object
-
expressInfo object
-
payeeInfo object
POST /payout/abroad/{merchant}
curl \
-X POST https://nomad.samarkand-global.cn/broker/v1/payout/abroad/wechat.sh_smk \
-H "app-api-key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"outOrderId":"string","transactionId":"transaction_id_123","paymentMethod":"wechatpay","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"}}'
Request example
{
"outOrderId": "string",
"transactionId": "transaction_id_123",
"paymentMethod": "wechatpay",
"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"
}
}
Response example (200)
{
"code": 200,
"message": "success",
"outOrderId": "string",
"transactionId": "42000000000_123123",
"payoutOrderId": "string",
"result": "SUCCESS",
"failReason": "BALANCE_NOT_ENOUGH",
"amount": 88,
"foreignAmount": 88,
"foreignCurrency": 88,
"rate": 88,
"exchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"estimateExchangeRateTime": "2015-05-20T13:29:35.120+08:00",
"availableAbroadAmount": 88
}
Response example (400)
{
"code": 200,
"message": "success"
}
Response example (401)
{
"code": 200,
"message": "success"
}
Response example (500)
{
"code": 200,
"message": "success",
"errors": "Something wrong when making the service."
}