API Reference
Log in
API Reference

Object

Field

Type

Desc

trade_id

string

Transaction ID

access_no

string

Assigned access party number

merchant_id

string

Access party's merchant ID

amount

string

Payment amount, truncated to two decimal places

currency

string

Transaction currency corresponding to the amount, encoding follows

customer_id

string

Customer ID

paid_at

string

Transaction payment success time.

metadata

map<string, string>

Passthrough metadata, key length does not exceed 40 bytes, value length does not exceed 500 bytes, JSON encoded ≤ 1024 bytes

last_payment_error

PaymentError

Last payment error information. If this field has a value, it indicates payment failure.

next_action

NextAction

Next action to be taken

order_id

string

Access party order ID

last_trans_id

string

Order transaction ID.

payment_mode

string

Payment business mode:

  • subscription:First subscription payment, requires collecting customer payment information, passing the payment_method_data field. Upon successful payment, a payment_token will be returned for subsequent subscription renewals.
  • recurring_payment:Subscription renewal payment, requires passing payment_token to complete payment, no need to collect user payment information.

payment_token

string

Payment token, used for subscription renewal deductions.

payment_method

string

Payment method

payment_channel

string

Payment channel

return_url

string

In scenarios like 3DS redirect payment, the page redirected to after the payment channel successfully accepts the payment.

trade_status

string

Payment order status:

  • requires_payment_method:Initial state
  • requires_action:Indicates that the transaction requires additional operations. For example, 3DS redirect verification, etc.
  • processing:Payment processing
  • succeeded:Payment successful

txn_time

string

Transaction initiation time, time when the client initiates the interface

created_at

string

Transaction creation time

refund_status

string

Refund status:

  • no_refund:No refund
  • partially_refunded:Partially refunded
  • refunded:Refund completed

total_refunded_amount

string

Refund amount, truncated to two decimal places

PaymentError

FieldTypeDesc
codestringTransaction error code
messagestringTransaction error message

NextAction

Field

Type

Desc

type

string

Type of action the client needs to take next:

  • redirect:Redirect

redirect

NextActionRedirect

Redirect information

NextActionRedirect

FieldTypeDesc
urlstringRedirect URL