Payment
Query Payment order
Payment
Query Payment order
This endpoint enables you to retrieve a payment
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
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 |
| cancel_time | integer(int64) | Order expiration cancel timestamp in 13-digit |
| transact_time | integer(int64) | Order transaction timestamp in 13-digit |
| 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 |
| 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 |
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 |
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 |