BonusPay Documents
English
English
  • Welcome
  • Get Started
  • Basic Fee Structure
  • API Rules
  • Creating an RSA Key
  • Products
  • Crypto TOPUP
    • Parameters
    • getAddress
    • queryCustomerDepositOrderPage
    • getCustomerDepositOrder
    • Notification (Callback)
  • Order Payment by API
    • Parameters
    • Place Order
    • Cancel Order
    • Accept Order
    • Get Order
    • Get PaymentEventList
    • Refund
    • Get Refund Order
    • Notification (Callback)
  • Order Payment by Checkout
    • Parameters
    • Place Order
    • Cancel Order
    • Accept Order
    • Get Order
    • Get PaymentEventList
    • Refund
    • Get Refund Order
    • Notification (Callback)
  • Withdraw
    • Parameters
    • Place Order
    • Get Order
    • Get Networks
    • Notification (Callback)
  • Transfer
    • Parameters
    • Place Order
    • Get Order
    • Get Networks
    • Notification (Callback)
  • Fx Rate
    • Parameters
    • getFxrate
  • Get Account Balance
    • Parameters
    • getAccountList
  • No Code Production
  • Fiat Settlement
    • Parameters
    • Place Order
    • Get Order
    • Notification (Callback)
  • Plug-and-Play
    • WooCommerce
Powered by GitBook
On this page
  • Request Parameters
  • Request Example
  • Response Parameters
  • Response Example
  1. Order Payment by API

Cancel Order

PreviousPlace OrderNextAccept Order

Last updated 6 months ago

  1. If a merchant's order payment fails and a new order number is generated for re-payment, the original order number should be canceled to avoid duplicate payments.

  2. After the system places an order, if the user's payment times out and the system stops processing it, please call the order cancellation interface to avoid further user attempts to pay.

Interface URL

Sandbox URL:

Production URL:

Request Parameters

Http Header

Field Name
Variable Name
Required
Type
Example
Description

Language

Content-Language

Optional

String(10)

en

en-English

Signature

sign

Required

String

Merchant ID

Partner-Id

Required

String(12)

Http Body

Field Name
Variable Name
Required
Type
Example
Description

Request Time

requestTime

Required

Timestamp(3)

1581493898000

Business Content

bizContent

Required

OrderIndexRequest

-

Business Content

Request Example

{
    "Http Header": {
    "Content-Language": "en",
    "Content-Type": "application/json",
    "sign": "WTKtJcUWKQIdXndcHT3XrgX6gh2o+tQNSC7X+Ei/pJxAxp6bqUiSufXpkA0jhD+8z4/bZmMAhe8pRg4jhTVtW6ZMp2on7D/b2qzti3K5H3vDNeZeroGQ7OidO+KUT3PNxpdlCSmiNdybP5Jyi+TNvzEKWVNUZy7jTwqtFjx9NswOuMack7xDicitY+MpAzYdy0QpFIxZq1M33KamKNox0EnQztDOsK8jZ2fQbNx0drA98W+mLZimkgv8FUAsrBXLSGnsJVsiIvQQWcOjZW+xFU/THdHho0XLtpJigTWs1qn3MQjeMIC0+hHOtJ8jQwUfhmi2y3VwtlUdKly9kSdLsg==",
    "Partner-Id": "200000000888"
  },
  "Http Body": {
    "requestTime": 1581344641872,
    "bizContent": {
      "merchantOrderNo": "M172475858661"
    }
  }
}

Response Parameters

Http Header

Field Name
Variable Name
Required
Type
Example
Description

Sign

sign

Required

String

Http Body: The body field is returned only when applyStatus is SUCCESS and code is 0.

Field Name
Variable Name
Required
Type
Example
Description

Response Header

head

Required

ResponseHeader

-

Response Body

body

Optional

CancelOrderResponse

-

CancelOrderResponse

Field Name
Variable Name
Required
Type
Example
Description

Order Information

acquireOrder

Required

AcquireOrder

-

Response Example

Http Header
{
  "sign": "XBRRQzTFvIKPE4bhBLKXF23RBeJn7WytxwhQXutCTZgO7NmzVE0YufjbSUSFKB5Eg6EtrVMVFM/FmTSSI/hWBJnk0j8rBxb+K3FlplTw1ydStM7upkvxLOe2uoOkac8FFXZIvjRWDNY7+VXwo40yI33Ct3YLTwu5kQHhVCEf6ClvnkTynXuy6hxALFsbJchKOZNbqm5WA24x2VtFbNe+jz+CRwD4MD8xg6npPMwfTc0b4sZ7SkUAKYlttxm+nO9qFjczbp55R7LdajxfCXxgpTp0hc576pwo2AqyNDcMjzunynX+AR7pzDqwkgC1NIc/eax67HPq/X+v/T8t671sHg=="
}

Http Body
{
  "head": {
    "applyStatus": "SUCCESS",
    "code": "0",
    "msg": "SUCCESS"
  },
  "body": {
    "acquireOrder": {
      "merchantOrderNo": "M172475858661",
      "orderNo": "131422372621002238",
      "status": "FAILURE",
      "product": "Crypto Basic Payment Gateway",
      "totalAmount": {
        "currency": "BUSD",
        "amount": 21.74
      },
      "payeeMid": "200000004021",
      "expiredTime": 1581429572587,
      "notifyUrl": "http://www.yoursite.com",
      "subject": "Your subject",
      "requestTime": 1581422372587,
      "accessoryContent": {
        "amountDetail": {
          "discountableAmount": {
            "currency": "BUSD",
            "amount": 2.31
          },
          "amount": {
            "currency": "BUSD",
            "amount": 20.65
          },
          "vatAmount": {
            "currency": "BUSD",
            "amount": 1.09
          },
          "tipAmount": {
            "currency": "BUSD",
            "amount": 0.02
          }
        },
        "goodsDetail": {
          "body": "Gifts",
          "categoriesTree": "CT12",
          "goodsCategory": "GC10",
          "goodsId": "GI1005",
          "goodsName": "candy flower",
          "price": {
            "currency": "BUSD",
            "amount": 10.87
          },
          "quantity": 2,
          "showUrl": "http://www.yourshop.com/index.htm"
        },
        "terminalDetail": {
          "operatorId": "OP10001",
          "storeId": "SI1002",
          "terminalId": "TI10000",
          "merchantName": "candy home",
          "storeName": "lovely house"
        }
      },
      "paySceneCode": "API"
    }
  }
}

Response Code

code
msg
reason
solution

0

SUCCESS

Success

400

INVALID_PARAMETER

Invalid parameters

Adjust request parameters

400

REQUESTTIME_TOO_EARLY

Request time too early

Adjust request time

400

REQUESTTIME_TOO_LATER

Request time too later

Adjust request time

402

RATE_LIMIT_REJECT

Too many requests

Decrease request frequency

403

UNAUTHORIZED

API unauthorized

Contact BonusPay

404

SERVICE_NOT_AVAILABLE

API service unavailable

Contact BonusPay

500

SYSTEM_ERROR

System error

Contact BonusPay, try again later

504

SERVICE_TIMEOUT

Service timeout

Try again later

601

RISK_FAIL

Risk check failed

Adjust business

77001

ORDER_PAID

Order already paid

Adjust merchant order number

77002

ORDER_FAILURE

Failed order cannot cancel

Adjust merchant order number

77003

ORDER_SETTLED

Settled order cannot cancel

Adjust merchant order number

77004

MERCHANT_ORDER_NO_NOT_EXIST

Order does not exist

Adjust merchant order number

77016

ORDER_NO_NOT_EXIST

Order does not exist

Adjust BonusPay order number

http://api.testbonuspay.network/sgs/api/crypto/cancelOrder
https://api.bonuspay.network/sgs/api/crypto/cancelOrder