PostAbroadPayoutBill

POST /payout/bill/abroad/{merchant}

Payout funds transactions operation

Path parameters

  • merchant string Required

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

application/json

Body

  • operation string Required

    Abroad payout bill operations, available: GetAvailableAbroadAmounts

  • transactionId string Required

    Payment company transaction number

  • paymentMethod string

    Payment method, must be wechatpay or alipay

    Values are wechatpay or alipay.

Responses

  • • 200

    Payout funds transactions operation execute 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
  • • 401

    Not Authenticated.

    Hide response attributes Show response attributes object
  • • 500

    Something wrong when download the payout bill.

    Hide response attributes Show response attributes object
POST /payout/bill/abroad/{merchant} 
curl \
 -X POST https://nomad.samarkand-global.cn/broker/v1/payout/bill/abroad/{merchant} \
 -H "app-api-key: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"operation":"GetAvailableAbroadAmounts","transactionId":"transaction_id_123","paymentMethod":"wechatpay"}'
Request example 
{
  "operation": "GetAvailableAbroadAmounts",
  "transactionId": "transaction_id_123",
  "paymentMethod": "wechatpay"
}
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"
}