Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 4.71 KB

File metadata and controls

43 lines (34 loc) · 4.71 KB

CreatePaymentOrderRequest

Properties

Name Type Description Notes
merchant_id str The merchant ID.
merchant_order_code str A unique reference code assigned by the merchant to identify this order in their system. [optional]
psp_order_code str A unique reference code assigned by the developer to identify this order in their system.
pricing_currency str The pricing currency that denominates `pricing_amount` and `fee_amount`. If left empty, both values will be denominated in `payable_currency`. Currently, For a complete list of supported currencies, see Supported chains and tokens. [optional]
pricing_amount str The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. [optional]
fee_amount str The developer fee for the order. It is added to the base amount (`pricing_amount`) to determine the final charge. For example, if `pricing_amount` is "100.00" and `fee_amount` is "2.00", the payer will be charged "102.00" in total, with "100.00" being settled to the merchant account and "2.00" settled to the developer account. Values must be greater than 0 and contain two decimal places.
payable_currency str The ID of the cryptocurrency used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`
payable_amount str The total amount the payer needs to pay, denominated in the specified `payable_currency`. If this field is left blank, the system will automatically calculate the amount at order creation using the following formula: (`pricing_amount` + `fee_amount`) / current exchange rate. Values must be greater than 0 and contain two decimal places. [optional]
expired_in int The number of seconds until the pay-in order expires, counted from when the request is sent. For example, if set to `1800`, the order will expire in 30 minutes. Must be greater than zero and cannot exceed 3 hours (10800 seconds). After expiration: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event. [optional] [default to 1800]
amount_tolerance str 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]
currency str This field has been deprecated. Please use `pricing_currency` instead. [optional] [default to '']
order_amount str This field has been deprecated. Please use `pricing_amount` instead. [optional]
token_id str This field has been deprecated. Please use `payable_currency` instead. [optional]
use_dedicated_address bool This field has been deprecated. [optional]
custom_exchange_rate str This field has been deprecated. [optional]

Example

from cobo_waas2.models.create_payment_order_request import CreatePaymentOrderRequest

# TODO update the JSON string below
json = "{}"
# create an instance of CreatePaymentOrderRequest from a JSON string
create_payment_order_request_instance = CreatePaymentOrderRequest.from_json(json)
# print the JSON string representation of the object
print(CreatePaymentOrderRequest.to_json())

# convert the object into a dict
create_payment_order_request_dict = create_payment_order_request_instance.to_dict()
# create an instance of CreatePaymentOrderRequest from a dict
create_payment_order_request_from_dict = CreatePaymentOrderRequest.from_dict(create_payment_order_request_dict)

[Back to Model list] [Back to API list] [Back to README]