| Field | Type | Desc |
|---|---|---|
| trade_id | string | Trade ID |
| access_no | string | Third-party access number |
| merchant_id | string | Merchant ID |
| amount | string | Payment amount, truncated to two decimal places |
| currency | string | Currency |
| customer_id | string | Platform customer ID |
| callback_url | string | Webhook notification callback URL |
| 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. |
| last_payment_error | LastPaymentError | Last payment error information, if this field has a value, it indicates payment failure. |
| next_action | NextAction | Next action |
| order_id | string | Third-party order number |
| last_trans_id | string | Order transaction ID |
| paid_at | string | Payment success time |
| payment_mode | string | Payment business mode: subscription: Initial subscription payment, requires collecting customer payment information, pass payment_method_data field, returns payment_token for subsequent subscription renewals upon successful paymentrecurring_payment: Subscription renewal payment, requires passing payment_token to complete payment, no need to collect user payment information |
| payment_token | string | Payment token returned for subscription payment, used for subsequent subscription renewals |
| payment_method | string | Payment method |
| payment_channel | string | Payment channel |
| return_url | string | Redirect page after payment channel accepts successfully in scenarios like 3DS redirect payment |
| trade_status | string | Payment status: requires_payment_method: Initial order status. The customer has not completed payment (may not have initiated it or is still in process), or a subscription renewal charge has been initiated but the result is not yet available. payment_failed: The provider declined the payment request due to reasons such as insufficient funds, failed card verification, or risk control restrictions. The customer can try again. processing: The payment has been submitted by the customer and is being processed by the provider. The result is pending — possibly under risk review, bank processing, or delayed settlement. succeeded: The payment has been confirmed successfully by the provider, and the funds have been credited. closed: The trade order is closed when its status is no longer expected to change positively, such as after a subscription renewal fails (after multiple retries) or when no payment result is returned for over 7 days. |
| txn_time | string | Trade initiation time, time when client initiates the interface |
| created_at | string | Creation time |
| refund_status | string | Refund status: no_refund: No refund partially_refunded: A partial refund has been successfully issued, and the refunded amount is less than the total trade order value. refunded: The full amount of the trade order has been successfully refunded. |
| total_refunded_amount | string | Refund amount, truncated to two decimal places |
| session_id | string | Session id |
| session_url | string | Session url |
| refer_info | ReferInfo | Source information of the customer |
| order_type | string | Order types generated under different purchase or billing scenarios: onetime_payment: The trade order is created for a one-time payment request. subscription: The trade order is created for initiating a subscription payment request. recurring_payment: The trade order is created by the Subotiz subscription renewal service. token_payment: The trade order is created when the merchant charges a customer using an existing subscription contract token. |
| line_items | LineItem[] | The line items purchased by the customer |
| discounts | Discounts | Discounts applied to the trade, including all discount information for this trade |
| closed_at | string | Trade closed time |
| closed_reason | string | The reason for the order being closed timeout: Payment timed out renewal_failed: Subscription renewal failed (including retries) |
| first_source_channel | string | The source where this checkout session was initially created |
| last_source_channel | string | The source where this checkout session was last accessed |
| billing_address | BillingAddress | The customer’s billing address |
ReferInfo
| Field | Type | Desc |
|---|---|---|
| country_code | string | The country code of the client (ISO 2 format) |
| ip | string | The customer’s IP address |
| device | string | The type of the customer’s equipment pc: Refers to the types of personal computer devices including desktops and laptops. mobile: Refers to portable device types that have wireless connection capabilities and include smart phones and tablets. |
| user_agent | string | The customer’s user agent |
NextAction
| Field | Type | Desc |
|---|---|---|
| type | string | Type of next action required by client: redirect: Redirect |
| redirect | NextActionRedirect | Redirect information |
| client | NextActionClient | Client operation information |
NextActionRedirect
| Field | Type | Desc |
|---|---|---|
| url | string | Redirect URL |
NextActionClient
| Field | Type | Desc |
|---|---|---|
| confirm_url | string | Confirm payment URL |
| apple_pay_session | string | ApplePay session data for creation |
LastPaymentError
| Field | Type | Desc |
|---|---|---|
| code | string | System returned transaction return code |
| message | string | System returned transaction return description |
LineItem
| Field | Type | Desc |
|---|---|---|
| product_id | string | The product ID of the item being purchased |
| price_id | string | The price ID associated with the purchased item |
| price | string | The price before any discounts are applied |
| quantity | int | The quantity of products being purchased |
Discounts
| Field | Type | Desc |
|---|---|---|
| current_period | CurrentPeriodDiscount[] | The current period’s discount details |
CurrentPeriodDiscount
| Field | Type | Desc |
|---|---|---|
| discount_id | string | The unique identifier for the discount |
| discount_amount | string | The amount discounted |
| discount_code | string | The discount code used |
BillingAddress
| Field | Type | Desc |
|---|---|---|
| name | string | Recipient’s full name (e.g: John Smith) |
| address_line1 | string | Address line 1, primary street address |
| address_line2 | string | Address line 2, additional address information |
| country_code | string | Country code in ISO2 format (e.g: US, GB, CN) |
| province_code | string | Province/state code (e.g: CA for California) |
| city | string | City name |
| area | string | Area/district/county name for more granular address |
| postal_code | string | Postal code/ZIP code, format varies by country |
| phone | string | Phone number without country code |
| phone_area_code | string | Phone country code (e.g: +1, +44, +86) |
| string | Email address for billing notifications and contact |