API Reference
API Reference

Object


Field

Type

Desc

id

int

Checkout session ID

access_no

string

Third-party access number

merchant_id

string

Merchant unique identifier

order_id

string

Third-party order number

trade_id

string

Trade ID

customer

Customer

Customer information

status

string

Checkout session status:

  • open: Created successfully
  • expire: Expired
  • complete: Transaction completed

expire_time

int

Validity period (seconds), expiration time can be calculated by adding validity period to creation time

return_url

string

Payment success redirect URL

cancel_url

string

Cancel payment redirect URL

callback_url

string

Webhook notification URL

session_url

string

Checkout page URL

mode

string

Payment mode, used to determine whether to validate product information:

  • checkout: Validate product data, default value
  • payment: Do not validate product data

total_amount

string

Total amount

integration_method

string

Integration mode:

  • hosted: Hosted, default mode
  • embedded: Embedded integration

redirect_on_completion

string

Redirect 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_at

string

Creation time

payment_token

string

Payment token returned for subscription payment, used for subsequent subscription renewals

metadata

map[string]string

A 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