| order_id |
String |
The unique identifier of the payment order. Cobo assigns this ID when the payment order is created — when that happens depends on which pay-in method you use. For the direct method, `Create pay-in order` creates the order synchronously and returns `order_id` in the response immediately. For the payment link method, `Create order link` returns only the hosted link details and does not create an order, so `order_id` does not exist yet at that point. `order_id` becomes available only after the payer opens the hosted payment page, selects the payment token and blockchain network, and submits the order — Cobo creates the order and assigns `order_id` at that moment, not when the link itself was generated. |
|
| merchant_id |
String |
The merchant ID. |
[optional] |
| merchant_order_code |
String |
The downstream merchant's order reference, exactly as you supplied it in `merchant_order_code` when creating the order, if you provided one. Present only when a `merchant_order_code` was included at order creation. |
[optional] |
| psp_order_code |
String |
The order identifier for your own internal business order, exactly as you supplied it in `psp_order_code` when creating the order. This value is unique within your Cobo organization. |
|
| pricing_currency |
String |
The pricing currency of the order. |
[optional] |
| pricing_amount |
String |
The base amount of the order, excluding the developer fee (specified in `fee_amount`). |
[optional] |
| fee_amount |
String |
The order-level developer charge credited to your developer balance when the order settles. A value of `0` means that no developer fee was charged and the merchant was credited with the full collected amount. When the collected payment exactly matches the payable amount, the merchant balance is credited with the payable amount minus `fee_amount`, and your developer balance is credited with `fee_amount`. For example, for a payable amount of `104.08` and a `fee_amount` of `2`, the merchant receives `102.08` and you receive `2`. For related fee settings and settlement details, see Merchant management and Accounts and fund allocation. |
|
| payable_currency |
String |
The ID of the cryptocurrency used for payment. |
[optional] |
| chain_id |
String |
The ID of the blockchain network where the payment transaction should be made. |
|
| payable_amount |
String |
The cryptocurrency amount to be paid for this order. |
|
| exchange_rate |
String |
The exchange rate between `payable_currency` and `pricing_currency`, calculated as (`pricing_amount` + `fee_amount`) / `payable_amount`. <Note>This field is only returned when `payable_amount` was not provided in the order creation request. </Note> |
|
| amount_tolerance |
String |
The allowed amount deviation, with precision up to 1 decimal place. For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) |
[optional] |
| receive_address |
String |
The recipient wallet address to be used for the payment transaction. |
|
| status |
OrderStatus |
|
|
| received_token_amount |
String |
The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). |
|
| expired_at |
Number |
The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. |
[optional] |
| created_timestamp |
Number |
The created time of the order, represented as a UNIX timestamp in seconds. |
[optional] |
| updated_timestamp |
Number |
The updated time of the order, represented as a UNIX timestamp in seconds. |
[optional] |
| transactions |
[PaymentTransaction] |
An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the settlement process. |
[optional] |
| currency |
String |
This field has been deprecated. Please use `pricing_currency` instead. |
[optional] |
| order_amount |
String |
This field has been deprecated. Please use `pricing_amount` instead. |
[optional] |
| token_id |
String |
This field has been deprecated. Please use `payable_currency` instead. |
[optional] |
| settlement_status |
SettleStatus |
|
[optional] |