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
  • Notification Parameters
  • Example
  • Response Parameters
  • Response Sample
  • Outbound IP address
  1. Fiat Settlement

Notification (Callback)

Once the OTC payout is completed, BonusPay will send the corresponding order results to the merchant via a data stream. The merchant must receive and process these results and respond according to the documentation specifications.

Notice

  1. The same notification may be sent to the merchant system multiple times. The merchant system must be able to handle duplicate notifications correctly.

  2. During the background notification interaction, if BonusPay receives a response from the merchant that does not comply with the specifications or times out, BonusPay will determine that the notification has failed, resend the notification until it succeeds (default retry 7 times, time interval: 2, 10, 10, 60, 120, 360, 900, unit: minutes), but BonusPay does not guarantee that the notification will eventually be successful.

  3. If the BonusPay recharge result notification is not received, it is recommended that the merchant actively call the order inquiry interface to confirm the order status.

Notification Parameters

OtcFundoutOrder

Field Name
Variable Name
Required
Type
Example
Description

Merchant Order No

merchantOrderNo

Required

String(64)

S10000

BonusPay Order No

orderNo

Required

String(32)

O1000

Status

status

Required

OtcFundoutOrderStatus

-

Crypto Currency Code and Amount

cryptoAmount

Required

Money

Fiat Currency Code and Amount

settlementAmount

Optional

Money

Created Time

createdTime

Required

Timestamp(3)

1581493898000

Notify URL

notifyUrl

Optional

String(200)

-

Fail Description

failDes

Optional

String(200)

-

reason of failed

Fundout Detail

fundoutDetail

Optional

FundoutDetail

-

Example

{
    "header": {
        "Host": "bonuspay.com",
        "X-Forwarded-For": "172.16.12.81",
        "Connection": "close",
        "Content-Length": "755",
        "X-Real-Ip": "172.16.12.81",
        "X-Forwarded-Proto": "http",
        "X-Forwarded-Port": "80",
        "X-Forwarded-Host": "bonuspay.com",
        "Partner-Id": "200001200101",
        "Sign": "CrjNHPJILbGzUO2syulAwF5Arnh2wmh5SxP2Yd/orMoYKYoLUw4PDDqPrhjt2/zP5X+sDiXdD0UyCmIFdhGAw9A2qg0wO83f6MD2wT+r8lyMfMQcWC+aWz8Rh+Rr1Dz3SZFqZHc6A1TrAaZyvWBWCtSLdlUKbq0yfen6NjYFGp0YU9MKLBkfIouCIgoT+jL+Sf/+GIjkSjOb8Pj/OB2hqj/36TDF+VuNIvUVyQI9Z8u1CbnNogHMrIy4coAWjkfSpqK3/qtlVkGR1Du+f8uQaVrlD6GcadS1P/IPLJyybdTVYhtMLPbDabZaJgGL8jHN6ImEX78WcU2FcAsoF2B0pA==",
        "Request-Id": "21116.222799.16370572829643753",
        "Prod-Sw6": "1-MjExMTYuMjIyNzk5LjE2MzcwNTcyODI5NjQzNzUz-MjE4NjguNDMwLjE2MzczMzE3NDM4MzM2MTgw-2-21868-21116-MTE5Mw==-Iy9zZ3MvYXBpL2NyeXB0by9wbGFjZU9yZGVy-I1RocmVhZC9vcmcuYXBhY2hlLnNreXdhbGtpbmcuYXBtLnRvb2xraXQudHJhY2UuUnVubmFibGVXcmFwcGVyL3J1bg==",
        "Content-Type": "application/json; charset=UTF-8",
        "User-Agent": "Apache-HttpClient/4.5.8 (Java/1.8.0_72)",
        "Accept-Encoding": "gzip,deflate"
    },
    "body": {
        "notify_time": "20211119182223",
        "otcFundoutOrder": {
            "cryptoAmount": {
                "currency": "USDT",
                "amount": 0.11
            },
            "merchantOrderNo": "8784b0b4-6c9f-4c26-8858-47a9b5037d74",
            "notifyUrl": "http://yoursite.com/api/notification",
            "createdTime": 1709109026970,
            "orderNo": "20240228000000453",
            "status": "COMPLETED",
            "fundoutDetail": {
                "fromAddress": "TT3afBRdUjLKjYYAAXPoetLTG6Xcqw9ZHb",
                "toAddress": "TJ18DxzR8T89UjgJUKkhR3xUoW2i69b4Ku",
                "txHash": "a91b85d1c8ad53a4afe348c156637efdfb04956211fbf03b953de25a4d5d8531",
            "receivingAmount": {
                "currency": "USD",
                "amount": 100
            },
            "receivingFee": {
                "currency": "USD",
                "amount": 0.1
            }
            },
            "settlementAmount": {
                "currency": "USD",
                "amount": 0.1
            }
        },
        "_input_charset": "UTF-8",
        "notify_timestamp": 1637331743833,
        "notify_id": "202111190340008301"
    }
}

Response Parameters

After receiving the notification, the merchant returns "SUCCESS" to indicate successful reception, and other values indicate exceptions.

Response Sample

Http Header
{
    "Content-Type": "application/json; charset=UTF-8"
}

Http Body
{
  SUCCESS
}

Outbound IP address

8.219.8.37

Our system will call your system with this ip address.

PreviousGet OrderNextPlug-and-Play

Last updated 2 months ago