API Reference
API Reference

Object

Checkout session entity field reference.


FieldTypeDesc
idintCheckout session ID
access_nostringThird-party access number
merchant_idstringMerchant unique identifier
order_idstringThird-party order number
trade_idstringTrade ID
customerCustomerCustomer information
statusstringCheckout session status:
  • open: Created successfully
  • expire: Expired
  • complete: Transaction completed
expire_timeintValidity period (seconds), expiration time can be calculated by adding validity period to creation time
return_urlstringPayment success redirect URL
cancel_urlstringCancel payment redirect URL
callback_urlstringWebhook notification URL
session_urlstringCheckout page URL
modestringPayment mode, used to determine whether to validate product information:
  • checkout: Validate product data, default value
  • payment: Do not validate product data
total_amountstringTotal amount
integration_methodstringIntegration mode:
  • hosted: Hosted, default mode
  • embedded: Embedded integration
redirect_on_completionstringRedirect behavior for embedded UI mode
  • always: Automatically redirect to return_url after successful payment
  • if_required: Only redirect to return_url for payment methods that require redirection
created_atstringCreation time
payment_tokenstringPayment token returned for subscription payment, used for subsequent subscription renewals
metadatamap[string]stringA set of key-value pairs that can be attached to an object, allowing you to store additional information in a structured format.

Customer

FieldTypeDesc
idstringCustomer ID
payer_idstringThird-party customer ID
emailstringCustomer email