Nomad Broker API documentation

QueryPayment

GET /payment/{merchant}

Query a payment

Path parameters

merchant string Required

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

Query parameters

order_ref string Required

Merchant order no.
payment_method string

Must be wechatpay or alipay

Values are wechatpay or alipay.

Responses

• 200

Query a payment successfully.
Hide response attributes Show response attributes object
- code integer(int32)
- message string | null
  
  Response message
- orderRef string | null
  
  Merchant system order number
- payerCurrency string | null
  
  Paymer amount currency
- currency string | null
  
  Amount currency
- payerTotal number | null
  
  Payer total amount, unit is fen
- actualAmount integer | null
  
  Order actual amount, which uses the base unit of current currency
- total number | null
  
  Total amount, unit is fen
- bankType string | null
  
  Bank type
- Timing string | null
  
  Payment time
- transactionId string | null
  
  Transaction ID
- tradeState string | null
  
  Trade state
- tradeStateDesc string | null
  
  Trade state description
- tradeType string | null
  
  Trade type
- tradeMessage string | null
  
  Trade message of third payment providers.
• 401

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

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

GET /payment/{merchant}

curl \
 -X GET https://nomad.samarkand-global.cn/broker/v1/payment/wechat.sh_smk?order_ref=test202101 \
 -H "app-api-key: $API_KEY"

Response examples (200)

{
  "code": 200,
  "message": "success",
  "orderRef": "test202103",
  "payerCurrency": "CNY",
  "currency": "CNY",
  "payerTotal": 10,
  "actualAmount": 2200,
  "total": 10,
  "bankType": "string",
  "Timing": "2021-11-02T17:03:38+08:00",
  "transactionId": "4200001148202111020556019250",
  "tradeState": "SUCCESS",
  "tradeStateDesc": "支付成功",
  "tradeType": "MWEB",
  "tradeMessage": "string"
}

Response examples (401)

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

Response examples (500)

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