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
  • DepositWalletStatus
  • Interface Address
  • Request Parameters
  • Request Example
  • Response Parameters
  • Response Example
  • Return Codes
  1. Crypto TOPUP

getAddress

Merchants use their own identifier to create a cryptocurrency deposit address. The deposit address can receive external on-chain transfers.

DepositWalletStatus

Status
Description

ENABLED

Available

DISABLED

Disabled

Interface Address

Test URL: https://api.testbonuspay.network/sgs/api/ccdeposit/getAddress

Production URL: http://api.bonuspay.network/sgs/api/ccdeposit/getAddress

Request Parameters

Submit order request. The idempotent interface can be requested multiple times with the same request, and the current order status will be returned. The idempotent request does not check the request time; if requested multiple times, the order request time will be based on the first request.

Http Header

Field Name
Variable Name
Required
Type
Example Value
Description

Content-Language

Content-Language

Optional

String(10)

en

en-English (default)

Signature

sign

Required

String

Merchant ID

Partner-Id

Required

String(12)

Http Body

Field Name
Variable Name
Required
Type
Example Value
Description

Request Time

requestTime

Required

Timestamp(3)

1581493898000

Business Content

bizContent

Required

JSON

-

Business content

Customer ID

-customerId

Required

String(200)

M965739182419

Asset Code

-assetCode

Required

String(32)

ETH

Network

-network

Required

String(32)

ETH

Request Example

Http Header
{
    "Content-Language": "en",
    "Content-Type": "application/json",
    "sign": "IXJI/QicPQotIsIDBcSGIg6jtJUXs1rTuifQFZUNd3KDTl25GKmpYO7OrkaKkTV0shDRitLmkxJCe3Z60zHE2ZSeVczrhwrnmuMG+bX9N22Hw821H6MydsXetYHRnyf5dPbgpmVja582w49grA6jRlVFAVMYdxKJDPSCb2X/IpltvyrLQ1Wt+lqr+fnpYXvyON6/PIZIQIknC8BVddVahxJnaC6HEagvJf6gskz22/DFfPHT1mlMA9pg8qrbh4O7DYZahf8TB3nIzAPc/FHOUZkYYTT2c8m4eLL8740nJVK7D3IOSqSnBAU/iJ2omjPPFvRCCSqzz17pkGsT7AW91w==",
    "Partner-Id": "200000000888"
}

Http Body
{
	"requestTime": 1581404947666,
	"bizContent": {
		"customerId": "M965739182419",
		"assetCode": "ETH",
		"network": "ETH"
	}
}

Response Parameters

Http Header

Field Name
Variable Name
Required
Type
Example Value
Description

Signature

sign

Required

String

-

Http Body's body field is only returned when applyStatus is SUCCESS and code is 0.

Http Body

Field Name
Variable Name
Required
Type
Example Value
Description

Response Header

head

Required

JSON

-

Request Status

-applyStatus

Required

String(16)

SUCCESS

SUCCESS-Application successful<br>FAIL-Application failed<br>ERROR-Application exception

Return Error Code

-code

Required

String(10)

0

Return code

Return Message

-msg

Optional

String(200)

-

Return message

Response Body

body

Optional

JSON

-

Order Information

-wallet

Optional

CustomerWallet

-

Response Example

Http Header
{
  "sign": "JzWjVQ245trg3p0CyuwUUHN+Ck40q/HDaMvhqueHDP8YHqC/Uw3c9VWCw4gKsNbk+CRShjT+bvKkck8Fc3aAiRK8wIVQz6eu95sPkJgZp5A0P+tfMH/44F+3CrejtbEIkrHdSwhy98Tv9TYs9QFe7Yni/vEJ8P4OU6FZJOi8LGOMF6Nc8+S5qftc7qLA17cNJ7NJYC+EW8suGe/NmGA9c5NMK5BwHTHzXYOjXwXLx8mw4M3hiirl0wtVym3hrOmbkujYZCH56h8uOVF0FbHGu5uoq61NuniJitLLs9qyiEprQzUe8oWsJnHKXeGAgEr//fLXIXgYsRYb7AWoJzs6Eg=="
}

Http Body
{
    "head":{
        "applyStatus":"SUCCESS",
        "code":"0",
        "msg":"SUCCESS",
        "success":true,
        "traceCode":"122185"
    },
    "body":{
        "wallet":{
            "address":"0xa4ef81a7d86f365785dd5bcc8e7964fe98155e16",
            "confirm":2,
            "customerId":"test001",
            "minDeposit":0.01,
            "network":"ETH",
            "product":"CTOPUP",
            "cashierUrl": "https://checkout.bonuspay.network/?token=c5bfdda1-29da-4998-9117-1d45cf4b19cf&type=ctopup",
            "status":"ENABLED"
        }
    }
}

Return Codes

code
msg
Reason
Solution

0

SUCCESS

Success

400

INVALID_PARAMETER

Parameter error

Adjust request parameters

400

REQUESTTIME_TOO_EARLY

Request time too early

Adjust request time

400

REQUESTTIME_TOO_LATER

Request time too late

Adjust request time

402

RATE_LIMIT_REJECT

Too many requests

Lower request frequency

403

UNAUTHORIZED

API not authorized

Contact BonusPay

404

SERVICE_NOT_AVAILABLE

API service unavailable

Contact BonusPay

500

SYSTEM_ERROR

System error

Contact BonusPay<br>Try again later

504

SERVICE_TIMEOUT

Service timeout

Try again later

601

RISK_FAIL

Risk check failed

Adjust business

75002

PRODUCT_IS_NOT_APPLIED

Product not applied

Apply for the product

75003

ASSET_CONFIG_NOT_EXIST

Asset configuration not exist

Adjust asset code or network code

PreviousParametersNextqueryCustomerDepositOrderPage

Last updated 10 months ago