ClosePayment

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

Close a payment

Path parameters

  • merchant string Required

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

  • order_ref string Required

    Merchant order no.

Query parameters

  • payment_method string

    Must be wechatpay or alipay

    Values are wechatpay or alipay.

Responses

  • • 200

    Close a payment successfully.

    Hide response attributes Show response attributes object
  • • 401

    Not Authenticated.

    Hide response attributes Show response attributes object
  • • 422

    Request validation failure

    Hide response attributes Show response attributes object
  • • 500

    Something wrong when making the payment.

    Hide response attributes Show response attributes object
POST /payment/close/{merchant}/{order_ref} 
curl \
 -X POST https://nomad.samarkand-global.cn/broker/v1/payment/close/wechat.sh_smk/orderno2022030300011 \
 -H "app-api-key: $API_KEY"
Response examples (200) 
{
  "code": 200,
  "message": "success",
  "paymentMessage": "success"
}
Response examples (401) 
{
  "code": 200,
  "message": "success"
}
Response examples (422) 
{
  "code": 200,
  "message": "success"
}
Response examples (500) 
{
  "code": 200,
  "message": "success",
  "errors": "Something wrong when making the service."
}