GetCustomsPayment

GET /customs/payment/{merchant}

Merchant queries customs clearance information by order number

Path parameters

  • merchant string Required

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

Query parameters

  • customs string Required

    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.

  • order_no string

    The internal order number of the merchant system

  • transaction_id string

    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 payment company system

  • payment_method string

    Must be wechatpay or alipay

    Values are wechatpay or alipay.

Responses

  • • 200 object

    Get a payment declaration result to customs successfully.

    • code integer(int32)
    • message string | null

      Response message

    • customsMessage string | null

      Original customs return message from payment company

    • resultCode string | null

      The third party response code

    • transactionId string | null

      Transaction ID returned by payment company

    • orders array[object]

      Contents of payment order

      • 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

      • subOrderNo string | null

        The internal order number of the merchant system

      • subOrderId string | null

        Transaction ID returned by payment company

      • mchCustomsNo string | null

        The merchant’s record number registered in the customs

      • explanation string | null

        The declaration result indicates that if the status is failed or abnormal, the failure reason is displayed

      • customs string | null

        Customs code

      • modifyTime string | null

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

      • duty integer | null

        Tariff, divided into units

      • feeType string | null

        The currency used for payment of payment company orders is currently only supported in RMB CNY. If there is an order split, it must be sent.

        Default value is CNY.

      • orderFee integer | null

        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 | null

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

      • productFee integer | null

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

      • certType string | null

        Only mainland ID cards are supported temporarily.

        Default value is IDCARD.

      • 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

      • verifyDepartmentTradeId string

        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

  • • 401 object

    Not Authenticated.

  • • 500 object

    Something wrong when declaring the payment.

GET /customs/payment/{merchant} 
curl \
 -X GET https://nomad.samarkand-global.cn/broker/v1/customs/payment/wechat.sh_smk?customs=GUANGZHOU_ZS \
 -H "app-api-key: $API_KEY"
Response example (200) 
{
  "code": 200,
  "message": "success",
  "customsMessage": "<xml><return_code><![CDATA[SUCCESS]]></return_code>...</xml>",
  "resultCode": "success",
  "transactionId": "1000320306201511078440737890",
  "orders": [
    {
      "state": "UNDECLARED",
      "subOrderNo": "1000320306201511078440737890",
      "subOrderId": "4200001306202110500000000000.0",
      "mchCustomsNo": "31123452K0",
      "explanation": "string",
      "customs": "string",
      "modifyTime": "20091227091010",
      "duty": 88,
      "feeType": "CNY",
      "orderFee": 88,
      "transportFee": 88,
      "productFee": 88,
      "certType": "IDCARD",
      "certCheckResult": "UNCHECKED",
      "verifyDepartment": "OTHERS",
      "verifyDepartmentTradeId": "OTHERS"
    }
  ]
}
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."
}