API Deposit Webhook Notification

Notification will be posted when the orders from Get Checkout URL, Create Payment Order interface is completed.

Webhook notification

There are three transaction statuses in the webhook notification under the field name “pay_status”. CCPayment will credit assets if the pay_status is “success”, which is the one and only status you should consider as the confirmation of the transaction. The other two pay_status, “pending” and “processing”, can not be regarded as the confirmation of the transaction.

Header

Name	Value	Required	Type	Description
Content-Type		Y	string	application/json; charset=utf-8
Appid	202302010636261620672405236006912	Y	string	Merchant's unique credential. Find it on the Developer page.
Timestamp	1677152490	Y	string	Timestamp in seconds (10-digit). The request is valid for two minutes.
Sign	871f0223c66ea72435208d03603a0cb00b90f6ac4a4ba725d00164d967e291f6	Y	string	SHA-256 (appId + appSecret + timestamp+body (json string))

Body

```json
{
   "pay_status": "success",
   "order_type": "API Deposit",
   "record_id": "202302201213531627642695975706624",
   "order_id": "202302200951001627606736097771520",
   "product_price": "25", 
   "denominated_currency": "USD", //The currency for calculating the order price, it could be cryptocurrency or fiat currency
   "order_amount": "25", 
   //When denominated_currency is set to a fiat currency, order_amount=product_price/fiat_rate/token_rate; 
   //When denominated_currency is set to 'Token', order_amount is the token amount required to pay for the order;
   "fiat_rate": "0.08",
   "paid_amount": "10",
   "token_rate": "0.08",
   //Token paid in USD value = token_rate*paid_amount
   "chain": "BSC",
   "txid": "0xbA2aE424d96...c32edC70B295c744C43",
   "contract": "0xbA2aE424d960c26247Dd6c32edC70B295c744C43",
   "crypto": "DOGE",
   "extend": {
        "merchant_order_id": "202211154785795"
      }
 }
```

Parameters

Name	Type	Description
pay_status	string	Payment status: pending, processing, success, failed pending: The transaction started, it is waiting to be sent out to the blockchain. processing: It’s being processed on the blockchain.
order_type	string	API Deposit
record_id	string	Trading record: one transaction generates one unique record_id which can be used to distinguish multiple transactions under one merchant_order_id
order_id	string	CCPayment order ID
product_price	string	Initial pricing (price submitted by merchant or invoice).
denominated_ currency	string	Currency unit of the product price. Call the interface to get all denominated_ currency.
order_amount	string	If the denominated currency is crypto currency, order_amount = product_price; when the denominated currency is fiat currency, order_amount=product_price/fiat_rate/token_rate
paid_amount	string	Token amount actually paid
fiat_rate	string	Fiat tax rate (in USD by default)
token_rate	string	Token price (in USDT by default), Token value in USD = token_rate*paid_amount
chain	string	Used to record the blockchain from which the user deposits.
contract	string	Contract
crypto	string	Crypto symbol
extend	object
extend.merchant_order_id	string	Merchant order ID, order_type is the Api type
custom_value	string	Merchant custom field - This custom value field will be returned in the transaction status notification.

Remarks

Return Appid, Sign, Timestamp in the header of the response. The signature method SHA-256 (appid+appSecret+Timestamp+body).

Please use the data with caution if the signature verification fails. It indicates that the data has been tampered with.

Once the merchant has processed the order, please return {http code: 200} and include a “success” string in the HTTP response body.

If CCPayment does not receive “success” as a response from the merchant, CCPayment will keep pushing the notification up to 6 times. Any response other than “success” will be regarded as a failure, and CCPayment will keep sending the notification.

Example

PHP

$this->response->setString("success")

Java

this.response.setString("success");

Golong

this.response.SetString("success")

Python

self.response.set_string("success")

Node.js

this.response.setString("success");

Response Example