Version deployed on Jan 13, 2022. Back to the latest version

Nomad Broker

1.4.8-alpha

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.

Base URL
https://nomad.samarkand-global.cn/broker

Send an authentication token in the app-api-key query parameter to authenticate with the API.


GetCustomsPayment

GET /customs/payment/{merchant}

Merchant queries customs clearance information by order number

Path parameters
  • merchant Required / string

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

Query parameters
  • customs Required / string

    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.

  • out_trade_no string

    The internal order number of the merchant system

  • Payment system internal order number

  • sub_order_no string

    The internal sub-order number of the merchant system

  • sub_order_id string

    The internal sub-order number of the WeChat payment system

Responses
  • 200 object

    Redirect url for payment.

    • code integer(int32)
    • message string | null

      Response message

    • resultCode string | null

      The third party response code

    • transactionId string | null

      Order number returned by wechat Pay

    • array[array[object]]
  • 400 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

    • resultCode string | null

      The third party response code

    • state string | null

      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

    • transactionId string | null

      Order number returned by wechat Pay

    • subOrderNo string | null

      The internal order number of the merchant system

    • modifyTime string | null

      The last update time, time zone is GMT+8 beijing

    • certCheckResult string | null

      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

    • verifyDepartment string | null

      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

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message

    • resultCode string | null

      The third party response code

    • state string | null

      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

    • transactionId string | null

      Order number returned by wechat Pay

    • subOrderNo string | null

      The internal order number of the merchant system

    • modifyTime string | null

      The last update time, time zone is GMT+8 beijing

    • certCheckResult string | null

      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

    • verifyDepartment string | null

      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

  • 500 object

    Something wrong when declaring the payment.

    • code integer(int32)
    • message string | null

      Response message

    • resultCode string | null

      The third party response code

    • state string | null

      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

    • transactionId string | null

      Order number returned by wechat Pay

    • subOrderNo string | null

      The internal order number of the merchant system

    • modifyTime string | null

      The last update time, time zone is GMT+8 beijing

    • certCheckResult string | null

      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

    • verifyDepartment string | null

      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

GET /customs/payment/{merchant}
curl \
 -X GET https://nomad.samarkand-global.cn/broker/customs/payment/wechat.prod?customs=GUANGZHOU_ZS&app-api-key=api_token_value
Response example (200)
{
  "code": 200,
  "message": "success",
  "resultCode": "success",
  "transactionId": "1000320306201511078440737890",
  "": [
    [
      {}
    ]
  ]
}
Response example (400)
{
  "code": 200,
  "message": "success",
  "resultCode": "success",
  "state": "UNDECLARED",
  "transactionId": "1000320306201511078440737890",
  "subOrderNo": "1000320306201511078440737890",
  "modifyTime": "20091227091010",
  "certCheckResult": "UNCHECKED",
  "verifyDepartment": "OTHERS",
  "verifyDepartmentTradeId": "OTHERS"
}
Response example (401)
{
  "code": 200,
  "message": "success",
  "resultCode": "success",
  "state": "UNDECLARED",
  "transactionId": "1000320306201511078440737890",
  "subOrderNo": "1000320306201511078440737890",
  "modifyTime": "20091227091010",
  "certCheckResult": "UNCHECKED",
  "verifyDepartment": "OTHERS",
  "verifyDepartmentTradeId": "OTHERS"
}
Response example (500)
{
  "code": 200,
  "message": "success",
  "resultCode": "success",
  "state": "UNDECLARED",
  "transactionId": "1000320306201511078440737890",
  "subOrderNo": "1000320306201511078440737890",
  "modifyTime": "20091227091010",
  "certCheckResult": "UNCHECKED",
  "verifyDepartment": "OTHERS",
  "verifyDepartmentTradeId": "OTHERS"
}

PutCustomsPayment

PUT /customs/payment/{merchant}

Redeclare an payment order to the customs

Path parameters
  • merchant Required / string

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

Body
  • customs Required / string

    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.

  • mchCustomsNo Required / string

    The merchant’s record number registered in the customs

  • outTradeNo string

    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.

  • transactionId string

    Order number returned by WeChat Pay

  • subOrderNo string

    Do not fill in the sub-order number. The internal order number of the merchant system

  • subOrderId string

    Do not fill in the sub-order number. Order number returned by WeChat Pay

Responses
  • 200 object

    Payment response.

    • code integer(int32)
    • message string | null

      Response message

    • resultCode string | null

      The third party response code

    • state string | null

      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

    • transactionId string | null

      Order number returned by wechat Pay

    • subOrderNo string | null

      The internal order number of the merchant system

    • modifyTime string | null

      The last update time, time zone is GMT+8 beijing

    • certCheckResult string | null

      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

    • verifyDepartment string | null

      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

  • 400 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

    • resultCode string | null

      The third party response code

    • state string | null

      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

    • transactionId string | null

      Order number returned by wechat Pay

    • subOrderNo string | null

      The internal order number of the merchant system

    • modifyTime string | null

      The last update time, time zone is GMT+8 beijing

    • certCheckResult string | null

      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

    • verifyDepartment string | null

      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

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message

    • resultCode string | null

      The third party response code

    • state string | null

      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

    • transactionId string | null

      Order number returned by wechat Pay

    • subOrderNo string | null

      The internal order number of the merchant system

    • modifyTime string | null

      The last update time, time zone is GMT+8 beijing

    • certCheckResult string | null

      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

    • verifyDepartment string | null

      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

  • 500 object

    Something wrong when redeclare the payment.

    • code integer(int32)
    • message string | null

      Response message

    • resultCode string | null

      The third party response code

    • state string | null

      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

    • transactionId string | null

      Order number returned by wechat Pay

    • subOrderNo string | null

      The internal order number of the merchant system

    • modifyTime string | null

      The last update time, time zone is GMT+8 beijing

    • certCheckResult string | null

      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

    • verifyDepartment string | null

      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

PUT /customs/payment/{merchant}
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"}'
Request example
{
  "customs": "GUANGZHOU_ZS",
  "mchCustomsNo": "31123452K0",
  "outTradeNo": "test2021101901",
  "transactionId": "4200001306202110500000000000.0",
  "subOrderNo": "1000320306201511078440737890",
  "subOrderId": "4200001306202110500000000000.0"
}
Response example (200)
{
  "code": 200,
  "message": "success",
  "resultCode": "success",
  "state": "UNDECLARED",
  "transactionId": "1000320306201511078440737890",
  "subOrderNo": "1000320306201511078440737890",
  "modifyTime": "20091227091010",
  "certCheckResult": "UNCHECKED",
  "verifyDepartment": "OTHERS",
  "verifyDepartmentTradeId": "OTHERS"
}
Response example (400)
{
  "code": 200,
  "message": "success",
  "resultCode": "success",
  "state": "UNDECLARED",
  "transactionId": "1000320306201511078440737890",
  "subOrderNo": "1000320306201511078440737890",
  "modifyTime": "20091227091010",
  "certCheckResult": "UNCHECKED",
  "verifyDepartment": "OTHERS",
  "verifyDepartmentTradeId": "OTHERS"
}
Response example (401)
{
  "code": 200,
  "message": "success",
  "resultCode": "success",
  "state": "UNDECLARED",
  "transactionId": "1000320306201511078440737890",
  "subOrderNo": "1000320306201511078440737890",
  "modifyTime": "20091227091010",
  "certCheckResult": "UNCHECKED",
  "verifyDepartment": "OTHERS",
  "verifyDepartmentTradeId": "OTHERS"
}
Response example (500)
{
  "code": 200,
  "message": "success",
  "resultCode": "success",
  "state": "UNDECLARED",
  "transactionId": "1000320306201511078440737890",
  "subOrderNo": "1000320306201511078440737890",
  "modifyTime": "20091227091010",
  "certCheckResult": "UNCHECKED",
  "verifyDepartment": "OTHERS",
  "verifyDepartmentTradeId": "OTHERS"
}

PostCustomsPayment

POST /customs/payment/{merchant}

Declare an payment order to the customs

Path parameters
  • merchant Required / string

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

Body
  • outTradeNo Required / string

    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.

  • transactionId Required / string

    Order number returned by WeChat Pay

  • customs Required / string

    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.

  • mchCustomsNo string

    The merchant’s record number registered in the customs

  • duty integer

    Tariff, divided into units

  • actionType string

    ADD New customs declaration application, MODIFY modification. Default is ADD

    Values are ADD or MODIFY. Default value is ADD.

  • subOrderNo string

    Merchant's sub-order number, must be passed if there is a split order

  • feeType string

    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.

  • orderFee integer

    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.

  • transportFee integer

    The logistics cost is divided into units, and must be passed if there is a split order.

  • productFee integer

    Commodity costs, in units of cents, must be passed if there is a split order.

  • certType string

    Only mainland ID cards are supported temporarily.

    Default value is IDCARD.

  • certId string

    The user's mainland ID number, the ID number ending in the letter X, please capitalize the letter X.

  • name string

    User name.

Responses
  • 200 object

    Payment response.

    • code integer(int32)
    • message string | null

      Response message

    • resultCode string | null

      The third party response code

    • state string | null

      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

    • transactionId string | null

      Order number returned by wechat Pay

    • subOrderNo string | null

      The internal order number of the merchant system

    • modifyTime string | null

      The last update time, time zone is GMT+8 beijing

    • certCheckResult string | null

      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

    • verifyDepartment string | null

      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

  • 400 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

    • resultCode string | null

      The third party response code

    • state string | null

      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

    • transactionId string | null

      Order number returned by wechat Pay

    • subOrderNo string | null

      The internal order number of the merchant system

    • modifyTime string | null

      The last update time, time zone is GMT+8 beijing

    • certCheckResult string | null

      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

    • verifyDepartment string | null

      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

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message

    • resultCode string | null

      The third party response code

    • state string | null

      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

    • transactionId string | null

      Order number returned by wechat Pay

    • subOrderNo string | null

      The internal order number of the merchant system

    • modifyTime string | null

      The last update time, time zone is GMT+8 beijing

    • certCheckResult string | null

      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

    • verifyDepartment string | null

      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

  • 500 object

    Something wrong when declaring the payment.

    • code integer(int32)
    • message string | null

      Response message

    • resultCode string | null

      The third party response code

    • state string | null

      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

    • transactionId string | null

      Order number returned by wechat Pay

    • subOrderNo string | null

      The internal order number of the merchant system

    • modifyTime string | null

      The last update time, time zone is GMT+8 beijing

    • certCheckResult string | null

      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

    • verifyDepartment string | null

      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

POST /customs/payment/{merchant}
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"}'
Request example
{
  "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"
}
Response example (200)
{
  "code": 200,
  "message": "success",
  "resultCode": "success",
  "state": "UNDECLARED",
  "transactionId": "1000320306201511078440737890",
  "subOrderNo": "1000320306201511078440737890",
  "modifyTime": "20091227091010",
  "certCheckResult": "UNCHECKED",
  "verifyDepartment": "OTHERS",
  "verifyDepartmentTradeId": "OTHERS"
}
Response example (400)
{
  "code": 200,
  "message": "success",
  "resultCode": "success",
  "state": "UNDECLARED",
  "transactionId": "1000320306201511078440737890",
  "subOrderNo": "1000320306201511078440737890",
  "modifyTime": "20091227091010",
  "certCheckResult": "UNCHECKED",
  "verifyDepartment": "OTHERS",
  "verifyDepartmentTradeId": "OTHERS"
}
Response example (401)
{
  "code": 200,
  "message": "success",
  "resultCode": "success",
  "state": "UNDECLARED",
  "transactionId": "1000320306201511078440737890",
  "subOrderNo": "1000320306201511078440737890",
  "modifyTime": "20091227091010",
  "certCheckResult": "UNCHECKED",
  "verifyDepartment": "OTHERS",
  "verifyDepartmentTradeId": "OTHERS"
}
Response example (500)
{
  "code": 200,
  "message": "success",
  "resultCode": "success",
  "state": "UNDECLARED",
  "transactionId": "1000320306201511078440737890",
  "subOrderNo": "1000320306201511078440737890",
  "modifyTime": "20091227091010",
  "certCheckResult": "UNCHECKED",
  "verifyDepartment": "OTHERS",
  "verifyDepartmentTradeId": "OTHERS"
}

PostCustoms

POST /declare

Declare an order to the customs

Body
  • reportId Required / string

    ID used for refund

  • paymentMethod Required / string

    Payment method of the order - wechatpay or alipay

  • trxId Required / string

    Order transection ID from payment

  • subOrder array[object]
    • subOrderRef string

      Sub order reference

    • product array[object]

      Products in this sub order

      • name string

        Product name

      • url string

        Product url

    • totalFee integer

      In CNY. Total amount of this sub order excluding logistics fee, which uses the base unit of the currency.

    • logsiticsFee integer

      In CNY. Logistics fee of this sub order, which uses the base unit of the currency.

Responses
  • 200 object

    Redirect url for payment.

    • status string

      PROCCESSING, SUBMITTED, FAILED, SUCCESS

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message

  • 422 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

  • 500 object

    Something wrong when declaring the payment.

POST /declare
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}]}'
Request example
{
  "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
    }
  ]
}
Response example (200)
{
  "status": "SUCCESS"
}
Response example (401)
{
  "code": 200,
  "message": "success"
}
Response example (422)
{
  "code": 200,
  "message": "success"
}
Response example (500)
{
  "code": 200,
  "message": "success",
  "errors": "Something wrong when making the service."
}

Declare an order after successful payment on youzan platform

POST /declare-order/youzan

Declare an order after successful payment on youzan platform

Headers
Body
  • amount Required / number

    In RMB fen. Total amount of order

  • orderId Required / string

    Order ID

  • subOrderId string

    Sub order ID (optional)

  • youzanTrxId Required / string

    Payment transaction number from youzan payment response

Responses
  • 200 object

    Successfully submitted the customs declaration.

    • storeId Required / number

      Youzan store ID

    • subOrderId string

      Sub order ID (if subOrderId is included in request)

    • customsStatus Required / number

      Status code from customs (1. processing, 2. successful, 3. failed, 4. rejected by customs, 5. in customs warehouse, 6. something wrong, please try again)

    • paymentCustomsId Required / string

      Customs declaration ID of the payment

    • orderId Required / string

      Order ID

    • youzanTrxId Required / string

      Payment transaction number from youzan payment response

  • 401 object

    Failure

    • code integer(int32)
    • message string | null

      Response message

  • 422 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

  • 500 object

    Failure

POST /declare-order/youzan
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}'
Request example
# Headers
X-Youzan-Token: string

# Payload
{
  "amount": 19300,
  "orderId": "E20200206101847089000001",
  "subOrderId": "E202002061018470890000019610GZ",
  "youzanTrxId": 200206101849000130
}
Response example (200)
{
  "storeId": 41261615,
  "subOrderId": "E202002061018470890000019610GZ",
  "customsStatus": 2,
  "paymentCustomsId": "200206101849000125961003",
  "orderId": "E20200206101847089000001",
  "youzanTrxId": "200206101849000125"
}
Response example (401)
{
  "code": 200,
  "message": "success"
}
Response example (422)
{
  "code": 200,
  "message": "success"
}
Response example (500)
{
  "code": 200,
  "message": "success",
  "errors": "Something wrong when making the service."
}

Create a payment

POST /pay

Create a payment

Body
  • paymentMethod Required / string

    Must be wechatpay or alipay

  • orderRef Required / string

    Order reference

  • total Required / integer

    Order total amount, which uses the base unit of current currency

  • currency Required / string

    Must be CNY or GBP

  • orderSuccessUrl Required / string

    This url is notified when the payment succeeds

  • product Required / array[object]

    All products in this order

    • name string

      Product name

    • url string

      Product url

Responses
  • 200 object

    Redirect url for payment.

    • payUrl string

      Url to the payment page

    • trxId string

      Url to the payment page

  • 401 object

    Failure

  • 422 object

    Request validation failure

  • 500 object

    Failure

POST /pay
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"}]}'
Request example
{
  "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"
    }
  ]
}
Response example (200)
{
  "payUrl": "https://payment.page.for.the.order",
  "trxId": "TX1234567890"
}
Response example (401)
{
  "errors": "Not Authenticated."
}
Response example (422)
{
  "field": "orderRef",
  "msg": "cannot be empty"
}
Response example (500)
{
  "errors": "Something wrong when making the payment."
}

QueryPayment

GET /payment/{merchant}

Query a payment

Path parameters
  • merchant Required / string

    Merchant name to payment company, e.g. weixinpay.test

Query parameters
  • order_ref Required / string

    Merchant order no.

Responses
  • 200 object

    Redirect url for payment.

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message

  • 500 object

    Something wrong when making the payment.

GET /payment/{merchant}
curl \
 -X GET https://nomad.samarkand-global.cn/broker/payment/wechat.test?order_ref=test202101&app-api-key=api_token_value
Response example (200)
{
  "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"
}
Response example (401)
{
  "code": 200,
  "message": "success"
}
Response example (500)
{
  "code": 200,
  "message": "success",
  "errors": "Something wrong when making the service."
}

CreatePayment

POST /payment/{merchant}

Create a payment

Path parameters
  • merchant Required / string

    Merchant name to payment company, e.g. weixinpay.test

Body
  • paymentMethod Required / string

    Payment method, must be wechatpay or alipay

    Values are wechatpay or alipay.

  • paymentType Required / string

    Payment companies have different payment types

    Values are NATIVE, H5, or JSAPI.

  • orderRef Required / string

    Order reference

  • total Required / integer

    Order total amount, which uses the base unit of current currency

  • currency Required / string

    Must be CNY or GBP

  • profitSharing boolean

    Whether the order is going to share profit

    Default value is true.

  • subsidyAmount integer

    Subsidy amount, only works when profitSharing is True

  • product Required / array[object]

    All products in this order

    • name string

      Product name

    • url string

      Product url

  • description string

    Product description

Responses
  • 200 object

    Redirect url for payment.

    • code integer(int32)
    • message string | null

      Response message

    • prePayUrl string | null

      Url to the payment page

    • payUrl string | null

      Url need to be accessd in mobile phone browser

    • payPage string | null

      Pay page html source code

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message

  • 422 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

  • 500 object

    Something wrong when making the payment.

POST /payment/{merchant}
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"}'
Request example
{
  "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"
}
Response example (200)
{
  "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"
}
Response example (401)
{
  "code": 200,
  "message": "success"
}
Response example (422)
{
  "code": 200,
  "message": "success"
}
Response example (500)
{
  "code": 200,
  "message": "success",
  "errors": "Something wrong when making the service."
}

ClosePayment

POST /payment/close/{merchant}/{order_ref}

Close a payment

Path parameters
  • merchant Required / string

    Merchant name to payment company, e.g. weixinpay.test

  • order_ref Required / string

    Merchant order no.

Responses
  • 200 object

    Redirect url for payment.

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message

  • 422 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

  • 500 object

    Something wrong when making the payment.

POST /payment/close/{merchant}/{order_ref}
curl \
 -X POST https://nomad.samarkand-global.cn/broker/payment/close/wechat.test/wechat.test?app-api-key=api_token_value
Response example (200)
{
  "code": 200,
  "message": "success",
  "paymentMessage": "success"
}
Response example (401)
{
  "code": 200,
  "message": "success"
}
Response example (422)
{
  "code": 200,
  "message": "success"
}
Response example (500)
{
  "code": 200,
  "message": "success",
  "errors": "Something wrong when making the service."
}

InvokePayment

POST /payment/invocation/{merchant}

Invoke a payment

Path parameters
  • merchant Required / string

    Merchant name to payment company, e.g. weixinpay.test

Body
  • paymentMethod Required / string

    Payment method, must be wechatpay or alipay

    Values are wechatpay or alipay.

  • paymentType Required / string

    Payment companies have different payment types

    Values are NATIVE, H5, or JSAPI.

  • invocationUrl Required / string

    This url is notified when the payment succeeds

Responses
  • 200 object

    Redirect url for payment.

    • code integer(int32)
    • message string | null

      Response message

    • prePayUrl string | null

      Url to the payment page

    • payUrl string | null

      Url need to be accessd in mobile phone browser

    • payPage string | null

      Pay page html source code

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message

  • 422 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

  • 500 object

    Something wrong when making the payment.

POST /payment/invocation/{merchant}
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"}'
Request example
{
  "paymentMethod": "wechatpay",
  "paymentType": "H5",
  "invocationUrl": "https://wx.tenpay.com/cgi-bin/mmpayweb-bin/checkmweb?prepay_id=wx2711083228719406a31dfe004d2b0c0000&package=3754039013"
}
Response example (200)
{
  "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"
}
Response example (401)
{
  "code": 200,
  "message": "success"
}
Response example (422)
{
  "code": 200,
  "message": "success"
}
Response example (500)
{
  "code": 200,
  "message": "success",
  "errors": "Something wrong when making the service."
}

GetAbroadPayout

GET /payout/abroad/{merchant}

Merchant query payout order infomation

Path parameters
  • merchant Required / string

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

Query parameters
  • out_order_id Required / string

    The payout number of the merchant, shall be generated by the merchant when initiating the payout request

  • transaction_id Required / string

    Payment system internal order number

Responses
  • 200 object

    Query payout order successful.

    • 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

    • orderId string | null

      Wechat payout number

    • transactionId string | null

      Wechat payout number

    • 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

    • 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 object

    Request validation failure

    • 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

    • orderId string | null

      Wechat payout number

    • transactionId string | null

      Wechat payout number

    • 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

    • 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

  • 401 object

    Not Authenticated.

    • 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

    • orderId string | null

      Wechat payout number

    • transactionId string | null

      Wechat payout number

    • 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

    • 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

  • 500 object

    Something wrong when query the payout.

    • 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

    • orderId string | null

      Wechat payout number

    • transactionId string | null

      Wechat payout number

    • 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

    • 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

GET /payout/abroad/{merchant}
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
Response example (200)
{
  "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
}
Response example (400)
{
  "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
}
Response example (401)
{
  "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
}
Response example (500)
{
  "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
}

PostAbroadPayout

POST /payout/abroad/{merchant}

Create a payout order

Path parameters
  • merchant Required / string

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

Body
  • outOrderId string

    The payout number of the merchant, shall be generated by the merchant when initiating the payout request

  • transactionId string

    Wechat transaction number

  • amount integer

    Amount of RMB to be payout, unit is cent

  • Currency of overseas payment. Note: The currency field is related to wechat Pay payee ID

  • goodsInfo array[object]

    Goods information, the number cannot exceed 10

  • sellerInfo object
  • expressInfo object
  • payeeInfo object
    • payeeId string

      The payee ID assigned by wechat Pay when accessing the outbound service of wechat Pay.

Responses
  • 200 object

    Query payout order successful.

    • 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

    • orderId string | null

      Wechat payout number

    • transactionId string | null

      Wechat payout number

    • 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

    • 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 object

    Request validation failure

    • 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

    • orderId string | null

      Wechat payout number

    • transactionId string | null

      Wechat payout number

    • 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

    • 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

  • 401 object

    Not Authenticated.

    • 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

    • orderId string | null

      Wechat payout number

    • transactionId string | null

      Wechat payout number

    • 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

    • 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

  • 500 object

    Something wrong when query the payout.

    • 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

    • orderId string | null

      Wechat payout number

    • transactionId string | null

      Wechat payout number

    • 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

    • 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

POST /payout/abroad/{merchant}
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"}}'
Request example
{
  "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"
  }
}
Response example (200)
{
  "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
}
Response example (400)
{
  "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
}
Response example (401)
{
  "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
}
Response example (500)
{
  "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
}

GetAbroadPayoutBill

GET /payout/bill/abroad/{merchant}

Download the payout bill

Path parameters
  • merchant Required / string

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

Query parameters
  • bill_date Required / string

    Bill date. Query format YYYY-MM-DD, for example, 2021-01-01

  • merchant_id string

    Merchant ID of wechat merchant.

Responses
  • 200 string(binary)

    Download the payout bill successful.

  • 400 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message

  • 500 object

    Something wrong when download the payout bill.

    • code integer(int32)
    • message string | null

      Response message

GET /payout/bill/abroad/{merchant}
curl \
 -X GET https://nomad.samarkand-global.cn/broker/payout/bill/abroad/{merchant}?bill_date=string&app-api-key=api_token_value
Response example (400)
{
  "code": 200,
  "message": "success"
}
Response example (401)
{
  "code": 200,
  "message": "success"
}
Response example (500)
{
  "code": 200,
  "message": "success"
}

PostAbroadPayoutBill

POST /payout/bill/abroad/{merchant}

Payout funds transactions operation

Path parameters
  • merchant Required / string

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

Body
  • operation Required / string

    Abroad payout bill operations, available: GetAvailableAbroadAmounts

  • transactionId Required / string

    Wechat transaction number

Responses
  • 200 object

    Payout funds transactions operation execute successfully.

    • 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

      Wechat payout number

    • 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

    • 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 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message

  • 500 object

    Something wrong when download the payout bill.

    • code integer(int32)
    • message string | null

      Response message

POST /payout/bill/abroad/{merchant}
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"}'
Request example
{
  "operation": "GetAvailableAbroadAmounts",
  "transactionId": "transaction_id_123"
}
Response example (200)
{
  "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
}
Response example (400)
{
  "code": 200,
  "message": "success"
}
Response example (401)
{
  "code": 200,
  "message": "success"
}
Response example (500)
{
  "code": 200,
  "message": "success"
}

GetProfitSharing

GET /profit/sharing/{merchant}

Merchant query profit sharing infomation

Path parameters
  • merchant Required / string

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

Query parameters
  • out_order_no Required / string

    The profit sharing number of the merchant, shall be unique within merchant system

  • transaction_id Required / string

    Payment system internal order number

Responses
  • 200 object

    Query payout order successful.

    • code integer(int32)
    • message string | null

      Response message

    • outOrderNo string | null

      The profit sharing number of the merchant

    • transactionId string | null

      Wechat transaction number

    • orderId string | null

      Payment system order number, the unique identifier returned by the payment system

    • status string | null

      Profit sharing order status

      Values are PROCESSING or FINISHED.

    • receivers array[object] | null

      Receivers of the profit sharing

      • type string

        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.

      • amount integer(int32)

        The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation

      • description string

        The description of profit sharing.

      • receiverMchid string

        Merchant ID of receiver.

      • result string | null

        Profit sharing order result

        Values are PENDING, SUCCESS, REFUND, or CLOSED.

      • finishTime string

        The finish time of profit sharing with the rfc3339 standard format.

      • failReason string

        The failed reason of profit sharing.

        Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.

      • detailId string

        Profit sharing detailed order number, which can be used for reconciliation with the fund bill.

    • finishDescription string | null

      Description of the end of the profit sharing

    • finishAmount integer | null

      The amount of the end of the profit sharing, in cent

  • 400 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

    • outOrderNo string | null

      The profit sharing number of the merchant

    • transactionId string | null

      Wechat transaction number

    • orderId string | null

      Payment system order number, the unique identifier returned by the payment system

    • status string | null

      Profit sharing order status

      Values are PROCESSING or FINISHED.

    • receivers array[object] | null

      Receivers of the profit sharing

      • type string

        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.

      • amount integer(int32)

        The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation

      • description string

        The description of profit sharing.

      • receiverMchid string

        Merchant ID of receiver.

      • result string | null

        Profit sharing order result

        Values are PENDING, SUCCESS, REFUND, or CLOSED.

      • finishTime string

        The finish time of profit sharing with the rfc3339 standard format.

      • failReason string

        The failed reason of profit sharing.

        Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.

      • detailId string

        Profit sharing detailed order number, which can be used for reconciliation with the fund bill.

    • finishDescription string | null

      Description of the end of the profit sharing

    • finishAmount integer | null

      The amount of the end of the profit sharing, in cent

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message

    • outOrderNo string | null

      The profit sharing number of the merchant

    • transactionId string | null

      Wechat transaction number

    • orderId string | null

      Payment system order number, the unique identifier returned by the payment system

    • status string | null

      Profit sharing order status

      Values are PROCESSING or FINISHED.

    • receivers array[object] | null

      Receivers of the profit sharing

      • type string

        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.

      • amount integer(int32)

        The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation

      • description string

        The description of profit sharing.

      • receiverMchid string

        Merchant ID of receiver.

      • result string | null

        Profit sharing order result

        Values are PENDING, SUCCESS, REFUND, or CLOSED.

      • finishTime string

        The finish time of profit sharing with the rfc3339 standard format.

      • failReason string

        The failed reason of profit sharing.

        Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.

      • detailId string

        Profit sharing detailed order number, which can be used for reconciliation with the fund bill.

    • finishDescription string | null

      Description of the end of the profit sharing

    • finishAmount integer | null

      The amount of the end of the profit sharing, in cent

  • 500 object

    Something wrong when query the payout.

    • code integer(int32)
    • message string | null

      Response message

    • outOrderNo string | null

      The profit sharing number of the merchant

    • transactionId string | null

      Wechat transaction number

    • orderId string | null

      Payment system order number, the unique identifier returned by the payment system

    • status string | null

      Profit sharing order status

      Values are PROCESSING or FINISHED.

    • receivers array[object] | null

      Receivers of the profit sharing

      • type string

        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.

      • amount integer(int32)

        The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation

      • description string

        The description of profit sharing.

      • receiverMchid string

        Merchant ID of receiver.

      • result string | null

        Profit sharing order result

        Values are PENDING, SUCCESS, REFUND, or CLOSED.

      • finishTime string

        The finish time of profit sharing with the rfc3339 standard format.

      • failReason string

        The failed reason of profit sharing.

        Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.

      • detailId string

        Profit sharing detailed order number, which can be used for reconciliation with the fund bill.

    • finishDescription string | null

      Description of the end of the profit sharing

    • finishAmount integer | null

      The amount of the end of the profit sharing, in cent

GET /profit/sharing/{merchant}
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
Response example (200)
{
  "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
}
Response example (400)
{
  "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
}
Response example (401)
{
  "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
}
Response example (500)
{
  "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
}

PostProfitSharing

POST /profit/sharing/{merchant}

Create a profit sharing order

Path parameters
  • merchant Required / string

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

Body
  • outOrderNo string

    The profit sharing number of the merchant

  • transactionId string

    Wechat transaction number

  • finish boolean

    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 array[object] | null

    Receivers of the profit sharing.

    • type string

      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.

    • amount integer(int32)

      The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation

    • description string

      The description of profit sharing.

Responses
  • 200 object

    Query payout order successful.

    • code integer(int32)
    • message string | null

      Response message

    • outOrderNo string | null

      The profit sharing number of the merchant

    • transactionId string | null

      Wechat transaction number

    • orderId string | null

      Payment system order number, the unique identifier returned by the payment system

    • status string | null

      Profit sharing order status

      Values are PROCESSING or FINISHED.

    • receivers array[object] | null

      Receivers of the profit sharing

      • type string

        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.

      • amount integer(int32)

        The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation

      • description string

        The description of profit sharing.

      • receiverMchid string

        Merchant ID of receiver.

      • result string | null

        Profit sharing order result

        Values are PENDING, SUCCESS, REFUND, or CLOSED.

      • finishTime string

        The finish time of profit sharing with the rfc3339 standard format.

      • failReason string

        The failed reason of profit sharing.

        Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.

      • detailId string

        Profit sharing detailed order number, which can be used for reconciliation with the fund bill.

    • finishDescription string | null

      Description of the end of the profit sharing

    • finishAmount integer | null

      The amount of the end of the profit sharing, in cent

  • 400 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

    • outOrderNo string | null

      The profit sharing number of the merchant

    • transactionId string | null

      Wechat transaction number

    • orderId string | null

      Payment system order number, the unique identifier returned by the payment system

    • status string | null

      Profit sharing order status

      Values are PROCESSING or FINISHED.

    • receivers array[object] | null

      Receivers of the profit sharing

      • type string

        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.

      • amount integer(int32)

        The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation

      • description string

        The description of profit sharing.

      • receiverMchid string

        Merchant ID of receiver.

      • result string | null

        Profit sharing order result

        Values are PENDING, SUCCESS, REFUND, or CLOSED.

      • finishTime string

        The finish time of profit sharing with the rfc3339 standard format.

      • failReason string

        The failed reason of profit sharing.

        Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.

      • detailId string

        Profit sharing detailed order number, which can be used for reconciliation with the fund bill.

    • finishDescription string | null

      Description of the end of the profit sharing

    • finishAmount integer | null

      The amount of the end of the profit sharing, in cent

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message

    • outOrderNo string | null

      The profit sharing number of the merchant

    • transactionId string | null

      Wechat transaction number

    • orderId string | null

      Payment system order number, the unique identifier returned by the payment system

    • status string | null

      Profit sharing order status

      Values are PROCESSING or FINISHED.

    • receivers array[object] | null

      Receivers of the profit sharing

      • type string

        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.

      • amount integer(int32)

        The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation

      • description string

        The description of profit sharing.

      • receiverMchid string

        Merchant ID of receiver.

      • result string | null

        Profit sharing order result

        Values are PENDING, SUCCESS, REFUND, or CLOSED.

      • finishTime string

        The finish time of profit sharing with the rfc3339 standard format.

      • failReason string

        The failed reason of profit sharing.

        Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.

      • detailId string

        Profit sharing detailed order number, which can be used for reconciliation with the fund bill.

    • finishDescription string | null

      Description of the end of the profit sharing

    • finishAmount integer | null

      The amount of the end of the profit sharing, in cent

  • 500 object

    Something wrong when query the payout.

    • code integer(int32)
    • message string | null

      Response message

    • outOrderNo string | null

      The profit sharing number of the merchant

    • transactionId string | null

      Wechat transaction number

    • orderId string | null

      Payment system order number, the unique identifier returned by the payment system

    • status string | null

      Profit sharing order status

      Values are PROCESSING or FINISHED.

    • receivers array[object] | null

      Receivers of the profit sharing

      • type string

        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.

      • amount integer(int32)

        The amount of account allocation, in cent, cannot exceed the payment amount of the original order and the maximum proportion of account allocation

      • description string

        The description of profit sharing.

      • receiverMchid string

        Merchant ID of receiver.

      • result string | null

        Profit sharing order result

        Values are PENDING, SUCCESS, REFUND, or CLOSED.

      • finishTime string

        The finish time of profit sharing with the rfc3339 standard format.

      • failReason string

        The failed reason of profit sharing.

        Values are ACCOUNT_ABNORMAL, NO_RELATION, or RECEIVER_HIGH_RISK.

      • detailId string

        Profit sharing detailed order number, which can be used for reconciliation with the fund bill.

    • finishDescription string | null

      Description of the end of the profit sharing

    • finishAmount integer | null

      The amount of the end of the profit sharing, in cent

POST /profit/sharing/{merchant}
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"}]}'
Request example
{
  "outOrderNo": "string",
  "transactionId": "transaction_id_123",
  "finish": false,
  "receivers": [
    {
      "type": "MERCHANT_ID",
      "receiverAccount": "1900000109",
      "amount": 12,
      "description": "分帐1900000110"
    }
  ]
}
Response example (200)
{
  "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
}
Response example (400)
{
  "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
}
Response example (401)
{
  "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
}
Response example (500)
{
  "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
}

PostProfitReceiver

POST /profit/receiver/{merchant}

Create a profit sharing receiver

Path parameters
  • merchant Required / string

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

Body
  • type string

    Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available

    Values are MERCHANT_ID or PERSONAL_OPENID.

  • account string

    The receiver account.

  • name string

    The receiver name.

  • relationType string

    Relationship between sub-merchant and recipient.

    Values are SUPPLIER, DISTRIBUTOR, SERVICE_PROVIDER, PLATFORM, or OTHERS.

  • encryptedName string

    Ciphertext of individual name(verify if value is passed)

Responses
  • 200 object

    Query payout order successful.

    • code integer(int32)
    • message string | null

      Response message

    • type string | null

      Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available

      Values are MERCHANT_ID or PERSONAL_OPENID.

    • account string | null

      The receiver account.

  • 400 object

    Request validation failure

    • code integer(int32)
    • message string | null

      Response message

    • type string | null

      Receiver type of profit sharing. MERCHANT_ID: merchants, PERSONAL_OPENID: personal. PERSONAL_OPENID is not available

      Values are MERCHANT_ID or PERSONAL_OPENID.

    • account string | null

      The receiver account.

  • 401 object

    Not Authenticated.

    • code integer(int32)
    • message string | null

      Response message