Nomad Broker API documentation

PostAbroadPayout

POST /payout/abroad/{merchant}

Create a payout order

Path parameters

merchant string Required

Merchant name to payment company, e.g. wechat.sh_smk

application/json

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 or alipay.
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
Hide goodsInfo attributes Show goodsInfo attributes
- goodsName string Required
  
  Goods name.
- goodsCategory string | null
  
  The merchant's own classification， for example, with/interval.
- goodsUnitPrice integer(int32) Required
  
  Goods unit price, unit is cent
- goodsQuantity integer(int32) Required
  
  Goods quantity
sellerInfo object
Hide sellerInfo attributes Show sellerInfo attributes
- overseaBusinessName string
  
  Name of operator of overseas seller
- overseaShopName string
  
  Name of the overseas seller's shop
- sellerId string
  
  The ID of the seller inside the merchant system
expressInfo object
Hide expressInfo attributes Show expressInfo attributes
- courierNumber string
  
  Logistics order number
- expressCompanyName string
  
  Name of logistics provider
payeeInfo object
Hide payeeInfo attribute Show payeeInfo attribute
- payeeId string
  
  The payee ID assigned by Payment company when accessing the outbound service of Pay.

Responses

• 200

Create funds to abroad order successfully.
Hide response attributes Show response attributes object
- code integer(int32)
- message string | null
  
  Response message
- outOrderId string | null
  
  The payout number of the merchant, shall be generated by the merchant when initiating the payout request
- transactionId string | null
  
  Payment company payout number
- payoutOrderId string | null
  
  The payout number of the merchant, shall be generated by the merchant when initiating the payout request
- result string | null
  
  Payout order result state
  
  Values are ACCEPT, SUCCESS, or FAIL.
- failReason string | null
  
  Payout order failed reason. Request status that can be retried: BALANCE_NOT_ENOUGH
- amount integer | null
  
  Amount of RMB to be payout, unit is cent
- foreignAmount integer | null
  
  Foreign amount to be payout, minimum unit of money
- foreignCurrency string | null
  
  Foreign currency of amount
- rate integer | null
  
  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
- exchangeRateTime string | null
  
  Exchange rate time，east 8 regional time
- estimateExchangeRateTime string | null
  
  Estimate exchange rate time，east 8 regional time
- availableAbroadAmount integer | null
  
  Available abroad amounts, unit is cent
• 400

Request validation failure
Hide response attributes Show response attributes object
- code integer(int32)
- message string | null
  
  Response message
• 401

Not Authenticated.
Hide response attributes Show response attributes object
- code integer(int32)
- message string | null
  
  Response message
• 500

Something wrong when query the payout.
Hide response attributes Show response attributes object
- code integer(int32)
- message string | null
  
  Response message
- errors string | null

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 examples (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 examples (400)

{
  "code": 200,
  "message": "success"
}

Response examples (401)

{
  "code": 200,
  "message": "success"
}

Response examples (500)

{
  "code": 200,
  "message": "success",
  "errors": "Something wrong when making the service."
}