Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 3.26 KB

File metadata and controls

35 lines (27 loc) · 3.26 KB

Order

Properties

Name Type Description Notes
orderId String The order ID.
merchantId String The merchant ID. [optional]
merchantOrderCode String A unique reference code assigned by the merchant to identify this order in their system. [optional]
pspOrderCode String A unique reference code assigned by the developer to identify this order in their system.
pricingCurrency String The pricing currency of the order. [optional]
pricingAmount String The base amount of the order, excluding the developer fee (specified in `fee_amount`). [optional]
feeAmount String The developer fee for the order. It is added to the base amount to determine the final charge.
payableCurrency String The ID of the cryptocurrency used for payment. [optional]
chainId String The ID of the blockchain network where the payment transaction should be made.
payableAmount String The cryptocurrency amount to be paid for this order.
exchangeRate 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>
amountTolerance 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]
receiveAddress String The recipient wallet address to be used for the payment transaction.
status OrderStatus
receivedTokenAmount 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).
expiredAt Integer The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. [optional]
createdTimestamp Integer The created time of the order, represented as a UNIX timestamp in seconds. [optional]
updatedTimestamp Integer The updated time of the order, represented as a UNIX timestamp in seconds. [optional]
transactions List<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]
orderAmount String This field has been deprecated. Please use `pricing_amount` instead. [optional]
tokenId String This field has been deprecated. Please use `payable_currency` instead. [optional]
settlementStatus SettleStatus [optional]