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

Get Order

PreviousAccept OrderNextGet PaymentEventList

Last updated 6 months ago

This interface provides the query of all BonusPay orders. Merchants can actively query the order status through the query order interface to complete the next business logic.

The situations that require calling the query interface are:

  1. When there are exceptions such as merchant background, network, server, etc., and the merchant system ultimately does not receive the payment notification.

  2. When calling the payment interface, a system error or unknown transaction status occurs.

  3. Before calling the cancel order API, the payment status needs to be confirmed.

Interface Address

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": "Tu3fopHy1opsWVTAk12FSr8KsGMcFTQB0dOH4fPGrG8iKvhcGCsmCr4kOy3CBmv7zXpBNfMxoRW33YPz0Zm6503CDnqxlOZGaOCFSmwnsE01vDzZL489wPj5HEKJ7kk70/muDMiUwJubZoXVtmOGhpvvczJDYIhP/5kpwSkucdkjZwrlp7IGqoFHrgKgZXXieOsUlGJHb9xg+HchtCqCYaOvX+gIK/o88SdgogvGm8NW/N4dzBhnfbwPcC7ue3MO8mwCDkJ/5KavK8TEotSeTvFEyhAvzrd41ccg47SWXZ4UnhvwT06iIYZ67G4Xg24Bc97cQe1XFM9CPd+/8w7uDA==",
    "Partner-Id": "200000000888"
}

Http Body
{
  "requestTime": 1581405884647,
  "bizContent": {
    "merchantOrderNo": "M965739182419"
  }
}

Response Parameters

Http Header

Field Name
Variable Name
Required
Type
Example
Description

Signature

sign

Required

String

-

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

Http Body

Field Name
Variable Name
Required
Type
Example
Description

Response Header

head

Required

ResponseHeader

-

Response Body

body

Optional

GetOrderResponse

-

GetOrderResponse

Field Name
Variable Name
Required
Type
Example
Description

Order Information

acquireOrder

Required

AcquireOrder

-

Response Example

Http Header
{
	"sign": "nDdClX1tAyV3qcX/Epay6AXFNRGSsWd8ysWO9SgwPrNTetSePLA9C39mGp6qRbjJeqXLEnYLwSkBu5eKdtyVX3tflGLiV2kvRjVfYpTCjXdVL2Pcnv2w+ghjHe2jL988iklk7q5AjAgdtXNphpHcTes9pk6W3bVCbvijH6at0fExUtZ91L1LrnPGELT1IJm/lFW3w4KLh0Gxs7FzDPI9RDfUemObNlRzV8kCtkWahwPgs/hBnS69GyYDKN7ihQX2UiLuP239wl6IA+VG/ZZKHPhLs8bbuOS+LKWORIp6jRt+JsAx7c/Ot1RNyOnHKxPRKJ8bVTohEp39yUz/HwG8oA=="
}

Http Body
{
    "body":{
        "acquireOrder":{
            "accessoryContent":{
                "amountDetail":{
                    "vatAmount":{
                        "amount":0.01,
                        "currency":"BUSD"
                    }
                },
                "goodsDetail":{
                    "body":"gifts",
                    "goodsId":"GI1005",
                    "goodsName":"candy flower"
                },
                "terminalDetail":{
                    "merchantName":"sdfsdf"
                }
            },
            "actualTotalAmount":{
                "amount":1,
                "currency":"ETH"
            },
            "expiredTime":1678950113923,
            "notifyUrl":"http://yoursite.com/api/notification",
            "paySceneCode":"API",
            "payeeMid":"200000344356",
            "paymentInfo":{
                "paidAmount":{
                    "amount":1,
                    "currency":"ETH"
                },
                "paidTime":1678972513000,
                "payChanneCode":"CHAIN",
                "payerFeeAmount":{
                    "amount":1,
                    "currency":"ETH"
                }
            },
            "requestTime":1678942913923,
            "reserved":"order desc",
            "settlementInfo":{
                "payeeFeeAmount":{
                    "amount":0.02,
                    "currency":"BUSD"
                },
                "settledTime":1678972548000,
                "settlementAmount":{
                    "amount":0.08,
                    "currency":"BUSD"
                }
            },
            "status":"SUCCESS",
            "subject":"ipad",
            "totalAmount":{
                "amount":0.01,
                "currency":"BUSD"
            }
        }
    },
    "head":{
        "applyStatus":"SUCCESS",
        "code":"0",
        "msg":"SUCCESS",
        "success":true,
        "traceCode":"000000"
    }
}

Response Code

code
msg
reason
solution

0

SUCCESS

Success

400

INVALID_PARAMETER

Invalid parameter

Adjust request params

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

Request too frequent

Reduce request rate

403

UNAUTHORIZED

API unauthorized

Contact BonusPay

404

SERVICE_NOT_AVAILABLE

API service not available

Contact BonusPay

500

SYSTEM_ERROR

System error

Contact BonusPay, try later

504

SERVICE_TIMEOUT

Service timeout

Try later

601

RISK_FAIL

Risk verification failed

Adjust business

77004

MERCHANT_ORDER_NO_NOT_EXIST

Merchant order not exist

Adjust merchant order number

77016

ORDER_NO_NOT_EXIST

BonusPay order not exist

Adjust BonusPay order number

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