Query Payment order - Cregis Developer

API URL

POST /api/v2/order/info

Request

Request Parameters

Name	Type	Required	Description
pid	integer(int64)	Y	Project id
nonce	string	Y	6 random string
timestamp	integer(int64)	Y	Timestamp
sign	string	Y	Signature
cregis_id	string	Y	Cregis unique id

Request Example

{
    "cregis_id": "po20240703132452000",
    "pid": 1382528827416576,
    "nonce": "hwlkk6",
    "timestamp": 1688004243314,
    "sign": "d6eef2de79e39f434a38efb910213ba6"
}

Response

Response Result

Name	Type	Description
code	string	Return code
msg	string	Return message
data	object	Return data

Response `data` Object

Name	Type	Description
cregis_id	string	Cregis unique id
order_id	string	used by the merchant to assign their own internal order ID to a payment
order_amount	string	Order transaction amount, defined by the merchant
order_currency	string	Order currency code, i.e. ISO 4217 currency code, such as CNY, HKD, defined by the merchant
created_time	integer(int64)	Order creation timestamp in 13-digit, eg:1734328473070
cancel_time	integer(int64)	Order expiration cancel timestamp in 13-digit, eg:1734328473070
transact_time	integer(int64)	Order transaction timestamp in 13-digit, eg:1734328473070
valid_time	integer(int32)	Validation time in minute (within 10 to 60 minutes) for a payment, a payment will be expired after this assigned validation timeframe
status	string	Order Status: new - Initial status of the order paid - The order has been successfully paid expired - The order has exceeded the valid time paid_over - Payment exceeds the order amount paid_partial - Payment is less than the order amount
refund_requested	string	Whether a refund has been requested to the order no: no refund request record yes: a refund is requested
payer_id	string	Merchant to assign their own internal user ID to associate with a payment
payer_name	string	Payer’s name
payer_email	string	Payer’s email
remark	string	For the merchant to make remarks about a payment
payment_detail	array	Payment details
payment_info	array	Payment related information
order_details	Object	The breakdown details of an order, each item will be displayed on the Cregis checkout page
settlement_status	string	Order settlement status: unsettled : settlement not processed yet settling : settlement processing settled : settlement completed
settlement_type	string	Settlement type： system : settlement is handled automatically manual •: settlement is handled manually
sub_merchant	Object	If the merchant has a sub merchant assigned under this acquiring project, it can be used by the merchant to assign their own internal sub merchant ID to associate with a payment
refund_data	object	Refund related information

payment_detail object

Name	Type	Description
payment_address	string	Payment wallet address (Pay to address)
from_address	string	Payer’s wallet address (Pay from address)
receive_amount	string	The amount of the order after exchange rate conversion
receive_currency	string	The order currency code after exchange rate conversion
pay_amount	string	Actual received amount
pay_currency	string	Received currency
exchange_rate	string	Exchange rate
tx_id	string	Transaction hash
blockchain	string	blockchain
token_name	string	token_name

payment_info object

Name	Type	Description
payment_address	string	Wallet address that receives payment
token_symbol	string	crypto asset symbol
blockchain	string	Blockchain network
token_name	string	crypto token name
logo_url	string	crypto token logo
token_decimals	integer	crypto token decimal places
receive_amount	string	The amount of the order after exchange rate conversion
receive_currency	string	The order currency code after exchange rate conversion
exchange_rate	string	Currency exchange rate
asset_logo	string	crypto asset logo

order_details object

Name	Type	Required	Description
shopping_cost	decimal	N	Shipping cost of the order
tax_cost	decimal	N	Tax amount of the order
items	JSONArrayString	N	The breakdown details of each item in the order

items object

Name	Type	Required	Description
item_id	string	N	The unique identifier of a payment in the merchant’s system
item_name	string	N	Name of an item purchase
item_price	decimal	N	Unit price of an item
price_currency	string	N	ISO 4217 3-character currency code. This is the currency associated with the order amount field
item_quantity	integer(int64)	N	Quantity of an item ordered

sub_merchant object

Name	Type	Required	Description
sub_merchant_id	string	N	ID of sub merchant
sub_merchant_name	string	N	Name of sub merchant

refund_data object

Name	Type	Required
refund_id	long	Unique identifier of a refund generated by Cregis
cregis_id	long	Unique identifier of a payment generated by Cregis
reference_id	string	used by the merchant to assign their own internal order ID to a payment
recipient_id	string	Merchant to assign their own internal user ID to associate with a refund
recipient_name	string	Refund receiver’s name
recipient_email	string	Refund receiver’s email
recipient_address	string	Refund receiving address
token	string	Refund currenccy：USDT-BEP20，USDT-TRC20
network	string	Refund payment network/blockchain
refund_amount	string	Refund amount
refund_fee	string	Refund handling fee that’s paid by receiver
actual_refund_amount	string	The actual refund amount after deducting the refund handling fee = refund_amount - refund_fee
type	int	Refund type 0: partial refund 1: full refund
refund_status	int	Refund status 0: refund in progress 1: refund successful 2: refund failed
refund_tx_id	string	Refund transaction hash
refund_created_time	string	Refund request creation timestamp e.g. 1720508269092 means 2024-07-09 14:57:49 092
refund_transact_time	string	Refund request transaction time e.g. 1720508269092 即 2024-07-09 14:57:49 092

Response Example

{
    "code": "00000",
    "msg": "ok",
    "data": {
        "cregis_id": "po1420761885130752",
        "order_id": "merchant_order_id_123",
        "order_amount": "5",
        "order_currency": "HKD",
        "created_time": 1734328473070,
        "cancel_time": null,
        "transact_time": 1734328473872,
        "valid_time": 60,
        "status": "paid",
        "payer_id": "payer001",
        "payer_name": "payer",
        "payer_email": "[email protected]",
        "remark": "remark",
        "payment_detail":  [
            {
                "payment_address": "TUX9zGoPFVXd6RC7pg18nfVLATeN9vgBeX",
                "from_address": "THMxY6QeMYqACWs8fiL4VGBz2ZJRp4mDhT",
                "receive_amount": "10.00",
                "receive_currency": "USDT",
                "pay_amount": "10",
                "pay_currency": "USDT",
                "exchange_rate": "1",
                "tx_id": "d51bc829da5ad05c14f8f0a6ae16708129e485346ad91b8d5f2d33e490b91815",
                "blockchain": "TRON",
                "token_name": "USDT-TRC20"
            }
        ],
        "payment_info": [
            {
                "payment_address": "0xf9d70ab23195cfc9c0c14b384a1fd3a3f12cd4f8",
                "token_symbol": "USDT",
                "blockchain": "BNB-BSC",
                "token_name": "USDT-BEP20",
                "logo_url": "https://static.cregis.io/pic/coin/USDT-BNB%[email protected]",
                "token_decimals": 18,
                "receive_amount": "0.642951",
                "receive_currency": "USDT",
                "exchange_rate": "0.1285902181",
                "asset_logo": "https://static.cregis.io/pic/coin/tether%[email protected]"
            },
            {
                "payment_address": "TX8GZJfLYPtmzRgd3FoiXuCHbptiQ37NSM",
                "token_symbol": "USDT",
                "blockchain": "TRON",
                "token_name": "USDT-TRC20",
                "logo_url": "https://static.cregis.io/pic/coin/[email protected]",
                "token_decimals": 6,
                "receive_amount": "0.642951",
                "receive_currency": "USDT",
                "exchange_rate": "0.1285902181",
                "asset_logo": "https://static.cregis.io/pic/coin/tether%[email protected]"
            }
        ],
        "order_details": {
            "items": [
                {
                    "item_id": "1",
                    "item_name": "Product1",
                    "item_price": 123,
                    "price_currency": "HKD",
                    "item_quantity": 1
                },
                {
                    "item_id": "1",
                    "item_name": "Product2",
                    "item_price": 124,
                    "price_currency": "HKD",
                    "item_quantity": 1
                }
            ],
            "shopping_cost": 10.88,
            "tax_cost": 100
        },
        "settlement_status": "unsettled",
        "settlement_type": "",
        "sub_merchant": {
            "sub_merchant_id": "123",
            "sub_merchant_name": "kg"
        }
    }
}

Commons

API

Payment

​API URL

​Request

​Request Parameters

Request Example

​Response

​Response Result

​Response data Object

Response Example

API URL

Request

Request Parameters

Response

Response Result

Response `data` Object