Use these field definitions with the Payment API and Business API. Required response fields can still be null when their schema permits it.
For precise validation, use the downloadable OpenAPI schemas, including their conditional rules.
| Field | Type | Required | Description |
|---|
request_id | string | Yes | The API request correlation ID. Min length: 1. Max length: 40. |
as_of | string (date-time) | Yes | The time represented by the response, in RFC 3339 format. |
sync_lag_seconds | integer or null | Yes | Known reporting synchronization delay in seconds; null when unknown or not applicable. |
data_source | cn, us | Yes | The response source: cn for the China service or us for US reporting. |
Error
| Field | Type | Required | Description |
|---|
code | VALIDATION_FAILED, UNAUTHENTICATED, SCOPE_DENIED, RESOURCE_NOT_FOUND, VERSION_CONFLICT, IDEMPOTENCY_CONFLICT, REQUEST_IN_PROGRESS, REFUND_WINDOW_EXPIRED, REFUND_CAPACITY_EXCEEDED, FUNDS_UNAVAILABLE, APPROVAL_REQUIRED, SELF_APPROVAL_FORBIDDEN, APPROVAL_STALE, ADVANCE_LIMIT_EXCEEDED, POLICY_NOT_ACCEPTED, PRODUCTION_NOT_READY, CAPABILITY_UNAVAILABLE, SUBJECT_MISMATCH, EVIDENCE_REUSED, CURSOR_EXPIRED, RATE_LIMITED, AUTHORITATIVE_UNAVAILABLE, ENDPOINT_NOT_VERIFIED, CONFIGURATION_INCOMPLETE, STATE_CONFLICT, UPLOAD_INCOMPLETE, EVIDENCE_UNAVAILABLE, BANK_RESULT_UNVERIFIED, SECRET_RECOVERY_EXPIRED, AUTH_STAGE_REQUIRED, TWO_FACTOR_INVALID, RECENT_AUTH_REQUIRED, TEMPORARY_PASSWORD_EXPIRED | Yes | The machine-readable error code. |
message | string | Yes | Human-readable context. Do not branch on its exact wording. Min length: 1. Max length: 1024. |
request_id | string | Yes | The API request correlation ID. Min length: 1. Max length: 40. |
retryable | boolean | Yes | Whether the request may be retried later. Preserve the original command and idempotency key. |
current_version | integer or null | Yes | |
operation_id | string or null | Yes | The asynchronous operation ID used to retrieve progress. |
status_path | string or null | Yes | The relative API path used to retrieve the resource or operation. Resolve against the assigned trusted service. |
details | array of object | Yes | Max items: 100. |
Version
| Field | Type | Required | Description |
|---|
expected_version | integer | Yes | The resource version you most recently read, used to prevent overwriting a concurrent change. Minimum: 1. Maximum: 9007199254740991. |
CreatePayment
| Field | Type | Required | Description |
|---|
app_id | string | Yes | The platform application ID authorized by the credential. Min length: 1. Max length: 40. |
amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991. |
currency | CNY | Yes | The three-letter uppercase currency code. |
external_order_id | string | Yes | Your business order ID, unique within the application. Available through the Payment API; omitted from US reporting and customer webhooks. Min length: 1. Max length: 128. |
description | string | Yes | A concise customer-facing purchase description. Min length: 1. Max length: 128. |
scene | object | No | Entry-specific payment context. wechat_h5 requires client_ip and return_url_id. |
scene.client_ip | string (ipv4) or string (ipv6) | No | The IP address of the customer initiating the payment. |
scene.return_url_id | string | No | The ID of an approved return-URL configuration. Do not send an arbitrary URL. Min length: 1. Max length: 40. |
payment_entry | wechat_app, wechat_h5, wechat_native, alipay_app, alipay_wap, alipay_page, alipay_qr | Yes | The payment provider and entry method, such as wechat_h5 or alipay_qr. |
Invocation
One of: InvocationSdkString, InvocationSdkFields, InvocationRedirectUrl, InvocationQrUrl, InvocationHtmlForm. Select by kind where a discriminator is present.
PaymentSession
| Field | Type | Required | Description |
|---|
order | CnOrder | Yes | |
invocation | Invocation or null | Yes | Client payment instructions, or null while unavailable. |
VerifyPurchase
| Field | Type | Required | Description |
|---|
app_id | string | Yes | The platform application ID authorized by the credential. Min length: 1. Max length: 40. |
product_id | string | Yes | The platform HMS product mapping ID, separate from the provider product ID. Min length: 1. Max length: 40. |
client_user_id | string | Yes | A stable, opaque user identifier from your application for HMS ownership verification. Processed in China; do not send names, email addresses, or phone numbers. Min length: 1. Max length: 191. |
external_order_id | string | Yes | Your business order ID, unique within the application. Available through the Payment API; omitted from US reporting and customer webhooks. Min length: 1. Max length: 128. |
purchase_evidence | string | Yes | The provider purchase evidence in the representation agreed for your HMS adapter. Min length: 1. Max length: 65536. |
Verification
| Field | Type | Required | Description |
|---|
id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
status | pending, verified, rejected, unknown | Yes | The business state of the resource. HTTP 202 alone does not indicate completion. |
order_id | string or null | Yes | The platform order ID. Your business order reference is external_order_id. |
failure_code | string or null | Yes | The failure classification, or null when there is no recorded failure. |
version | integer | Yes | The current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991. |
Refund
The refund ID remains stable throughout review, provider execution, and economics updates. Its public version advances as these change.
| Field | Type | Required | Description |
|---|
id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
app_id | string | Yes | The platform application ID authorized by the credential. Min length: 1. Max length: 40. |
order_id | string | Yes | The platform order ID. Your business order reference is external_order_id. Min length: 1. Max length: 40. |
amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991. |
currency | CNY | Yes | The three-letter uppercase currency code. |
review_status | received, needs_materials, under_review, awaiting_funds, approved, rejected, cancelled | Yes | The refund review state, separate from provider execution. |
execution_status | not_submitted, accepted, submitting, processing, unknown, succeeded, failed, cancelled | Yes | The provider execution state. unknown means that the result is unresolved. |
valid_received_at | string (date-time) | Yes | When the valid refund request was received, used to assess the request deadline. |
version | integer | Yes | The public refund version. Advances when the request, execution, or confirmed economics change. Minimum: 1. Maximum: 9007199254740991. |
execution_id | string or null | Yes | The provider-execution reference, or null before execution is created. |
economics | object | Yes | |
economics.estimate | RefundEconomics or null | Yes | |
economics.actual | RefundEconomics or null | Yes | |
| Field | Type | Required | Description |
|---|
amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991. |
reason | customer_request, duplicate, fraud, service_issue, consumer_complaint, other | Yes | The refund reason. |
expected_order_version | integer | Yes | The current order version used to check concurrency. Minimum: 1. Maximum: 9007199254740991. |
Operation
| Field | Type | Required | Description |
|---|
id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
status | pending, running, succeeded, failed, manual_review | Yes | The business state of the resource. HTTP 202 alone does not indicate completion. |
resource | ResourceRef or null | Yes | |
failure_code | string or null | Yes | The failure classification, or null when there is no recorded failure. |
created_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
completed_at | string (date-time) or null | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
status_path | string | Yes | The relative API path used to retrieve the resource or operation. Resolve against the assigned trusted service. |
ChannelConfirmation
| Field | Type | Required | Description |
|---|
id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
order_id | string | Yes | The platform order ID. Your business order reference is external_order_id. Min length: 1. Max length: 40. |
status | awaiting_attestation, pending, confirmed, unknown, manual_review, not_required | Yes | The business state of the resource. HTTP 202 alone does not indicate completion. |
version | integer | Yes | The current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991. |
FulfillmentAttestation
| Field | Type | Required | Description |
|---|
expected_version | integer | Yes | The resource version you most recently read, used to prevent overwriting a concurrent change. Minimum: 1. Maximum: 9007199254740991. |
fulfilled_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
fulfillment_reference | string | Yes | Your durable business fulfillment reference. Min length: 1. Max length: 191. |
ResourceRef
| Field | Type | Required | Description |
|---|
type | app, order, refund, settlement, case, approval_case, policy, evidence, credential, webhook_endpoint, payout_attempt, ledger_entry, admin_grant | Yes | |
id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
CnOrder
CN customer-server view. External reference never enters the US order projection.
| Field | Type | Required | Description |
|---|
id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
app_id | string | Yes | The platform application ID authorized by the credential. Min length: 1. Max length: 40. |
environment | production | Yes | The payment environment. This edition supports production. |
amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991. |
currency | CNY | Yes | The three-letter uppercase currency code. |
status | pending, processing, unknown, paid, failed, closed | Yes | The business state of the resource. HTTP 202 alone does not indicate completion. |
paid_at | string (date-time) or null | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
policy_snapshot_id | string or null | Yes | The public resource identifier. |
version | integer | Yes | The current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991. |
created_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
payment_entry | wechat_app, wechat_h5, wechat_native, alipay_app, alipay_wap, alipay_page, alipay_qr, hms_iap | Yes | The payment provider and entry method, such as wechat_h5 or alipay_qr. |
paid_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
refunded_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
pending_refund_amount_minor | integer | Yes | Refund principal reserved by valid requests and provider executions in progress. A transfer between these stages is counted once. Minimum: 0. Maximum: 9007199254740991. |
refund_request_deadline_at | string (date-time) or null | Yes | A valid refund request must be received before this exclusive deadline. Null before payment. |
external_order_id | string | Yes | Your business order ID, unique within the application. Available through the Payment API; omitted from US reporting and customer webhooks. Min length: 1. Max length: 128. |
WechatSdkFields
Normalized fields; adapter maps these to selected SDK native names. Algorithm must match verified account capability, never client selection.
| Field | Type | Required | Description |
|---|
provider | wechat | Yes | |
app_id | string | Yes | The WeChat AppID for the native SDK invocation, separate from the platform application ID. Min length: 1. Max length: 1024. |
merchant_id | string | Yes | The payment provider merchant identifier. Min length: 1. Max length: 1024. |
prepay_id | string | Yes | The public resource identifier. Min length: 1. Max length: 1024. |
package | string | Yes | Min length: 1. Max length: 1024. |
nonce | string | Yes | Min length: 1. Max length: 1024. |
timestamp | string | Yes | |
signature | string | Yes | Min length: 1. Max length: 1024. |
signature_algorithm | RSA, HMAC-SHA256, MD5 | Yes | |
InvocationSdkString
| Field | Type | Required | Description |
|---|
kind | sdk_string | Yes | |
sdk_string | string | Yes | Min length: 1. Max length: 65536. |
expires_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
InvocationSdkFields
| Field | Type | Required | Description |
|---|
kind | sdk_fields | Yes | |
sdk_fields | WechatSdkFields | Yes | |
expires_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
InvocationRedirectUrl
| Field | Type | Required | Description |
|---|
kind | redirect_url | Yes | |
redirect_url | string (uri) | Yes | |
expires_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
InvocationQrUrl
| Field | Type | Required | Description |
|---|
kind | qr_url | Yes | |
qr_url | string (uri) | Yes | |
expires_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
| Field | Type | Required | Description |
|---|
kind | html_form | Yes | |
html_form | string | Yes | Min length: 1. Max length: 65536. |
expires_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
RefundEconomics
| Field | Type | Required | Description |
|---|
developer_principal_reversal_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
platform_principal_reversal_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
original_payment_fee_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
developer_fee_already_borne_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
developer_fee_adjustment_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: -9007199254740991. Maximum: 9007199254740991. |
developer_refund_cost_minor | integer | Yes | Principal reversal plus signed incremental original-fee adjustment; consumer refund principal is never reduced. Minimum: -9007199254740991. Maximum: 9007199254740991. |
outstanding_debt_minor | integer | Yes | Debt as of calculated_at, not a live debt balance. Current outstanding debt is read from Balance. Minimum: 0. Maximum: 9007199254740991. |
policy_snapshot_id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
calculated_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
App
| Field | Type | Required | Description |
|---|
id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
environment | production | Yes | The payment environment. This edition supports production. |
status | onboarding, active, suspended, closing, closed | Yes | The business state of the resource. HTTP 202 alone does not indicate completion. |
version | integer | Yes | The current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991. |
client_id | string | Yes | The public customer ID associated with the application. Min length: 1. Max length: 40. |
enabled_payment_entries | array of wechat_app, wechat_h5, wechat_native, alipay_app, alipay_wap, alipay_page, alipay_qr, hms_iap | Yes | Payment entries enabled for this application. Max items: 100. |
us_app_id | string (uuid) or null | Yes | The US application UUID, separate from the payment application ID. |
Order
| Field | Type | Required | Description |
|---|
id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
app_id | string | Yes | The platform application ID authorized by the credential. Min length: 1. Max length: 40. |
environment | production | Yes | The payment environment. This edition supports production. |
amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991. |
currency | CNY | Yes | The three-letter uppercase currency code. |
status | pending, processing, unknown, paid, failed, closed | Yes | The business state of the resource. HTTP 202 alone does not indicate completion. |
paid_at | string (date-time) or null | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
policy_snapshot_id | string or null | Yes | The public resource identifier. |
version | integer | Yes | The current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991. |
created_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
payment_entry | wechat_app, wechat_h5, wechat_native, alipay_app, alipay_wap, alipay_page, alipay_qr, hms_iap | Yes | The payment provider and entry method, such as wechat_h5 or alipay_qr. |
paid_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
refunded_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
pending_refund_amount_minor | integer | Yes | Refund principal reserved by valid requests and provider executions in progress. A transfer between these stages is counted once. Minimum: 0. Maximum: 9007199254740991. |
refund_request_deadline_at | string (date-time) or null | Yes | A valid refund request must be received before this exclusive deadline. Null before payment. |
RefundEligibility
| Field | Type | Required | Description |
|---|
order_id | string | Yes | The platform order ID. Your business order reference is external_order_id. Min length: 1. Max length: 40. |
eligible | boolean | Yes | Whether the order is eligible at the time of the check. Revalidated on submission. |
refundable_amount_minor | integer | Yes | Maximum refundable principal at the time of the check, in minor units. Revalidated on submission. Minimum: 0. Maximum: 9007199254740991. |
order_version | integer | Yes | Minimum: 1. Maximum: 9007199254740991. |
checked_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
blocked_reasons | array of string | Yes | Reasons preventing the operation or release at the time of the check. Max items: 100. |
refund_request_deadline_at | string (date-time) or null | Yes | A valid refund request must be received before this exclusive deadline. Null before payment. |
Balance
Sales reserved bucket is reserve; USD adjustment reservations are settlement pending. Risk holds overlay asset buckets; debt is separate. Eligibility is computed in CN and rechecked under locks.
| Field | Type | Required | Description |
|---|
app_id | string | Yes | The platform application ID authorized by the credential. Min length: 1. Max length: 40. |
currency | CNY, USD | Yes | The three-letter uppercase currency code. |
as_of | string (date-time) | Yes | The time represented by the response, in RFC 3339 format. |
locked_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
available_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
reserve_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
pending_refund_amount_minor | integer | Yes | Refund principal reserved by valid requests and provider executions in progress. A transfer between these stages is counted once. Minimum: 0. Maximum: 9007199254740991. |
pending_settlement_amount_minor | integer | Yes | Funds reserved for a settlement that has not completed, in minor units. Minimum: 0. Maximum: 9007199254740991. |
outstanding_debt_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
risk_hold_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
settlement_eligible_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
ReleaseStage
| Field | Type | Required | Description |
|---|
id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
lot_id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
due_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
blocked_reasons | array of string | Yes | Reasons preventing the operation or release at the time of the check. Max items: 100. |
original_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
released_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
consumed_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
WebhookEvent
| Field | Type | Required | Description |
|---|
event_id | string | Yes | The event identifier. Retries and replays of the same event retain this value. Min length: 1. Max length: 40. |
schema_version | 1 | Yes | The event schema version, separate from the business resource version. |
type | payment.succeeded, payment.failed, payment.closed, refund.succeeded, refund.failed, hms.confirmation.required, hms.confirmation.completed | Yes | |
app_id | string | Yes | The platform application ID authorized by the credential. Min length: 1. Max length: 40. |
environment | production | Yes | The payment environment. This edition supports production. |
occurred_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
resource_version | integer | Yes | The version of the resource represented by the event. Compare versions within the same resource. Minimum: 1. Maximum: 9007199254740991. |
data | EventOrder or EventRefund or EventChannelConfirmation | Yes | The response resource or resource list. |
The event type and resource state must agree. For example, payment.succeeded contains an order with status paid; refund.succeeded contains a refund with execution status succeeded. The downloadable schema enforces these associations.
WebhookChallenge
| Field | Type | Required | Description |
|---|
event_id | string | Yes | The event identifier. Retries and replays of the same event retain this value. Min length: 1. Max length: 40. |
schema_version | 1 | Yes | The event schema version, separate from the business resource version. |
type | endpoint.verification | Yes | |
app_id | string | Yes | The platform application ID authorized by the credential. Min length: 1. Max length: 40. |
environment | production | Yes | The payment environment. This edition supports production. |
occurred_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
data | object | Yes | The response resource or resource list. |
data.endpoint_id | string | Yes | The webhook endpoint ID. Min length: 1. Max length: 40. |
data.challenge | string | Yes | Min length: 32. Max length: 256. |
data.expires_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
EventOrder
| Field | Type | Required | Description |
|---|
id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
app_id | string | Yes | The platform application ID authorized by the credential. Min length: 1. Max length: 40. |
environment | production | Yes | The payment environment. This edition supports production. |
amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991. |
currency | CNY | Yes | The three-letter uppercase currency code. |
status | pending, processing, unknown, paid, failed, closed | Yes | The business state of the resource. HTTP 202 alone does not indicate completion. |
paid_at | string (date-time) or null | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
policy_snapshot_id | string or null | Yes | The public resource identifier. |
version | integer | Yes | The current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991. |
created_at | string (date-time) | Yes | An RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai. |
payment_entry | wechat_app, wechat_h5, wechat_native, alipay_app, alipay_wap, alipay_page, alipay_qr, hms_iap | Yes | The payment provider and entry method, such as wechat_h5 or alipay_qr. |
paid_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
refunded_amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991. |
pending_refund_amount_minor | integer | Yes | Refund principal reserved by valid requests and provider executions in progress. A transfer between these stages is counted once. Minimum: 0. Maximum: 9007199254740991. |
refund_request_deadline_at | string (date-time) or null | Yes | A valid refund request must be received before this exclusive deadline. Null before payment. |
EventRefund
The refund ID remains stable throughout review, provider execution, and economics updates. Its public version advances as these change.
| Field | Type | Required | Description |
|---|
id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
app_id | string | Yes | The platform application ID authorized by the credential. Min length: 1. Max length: 40. |
order_id | string | Yes | The platform order ID. Your business order reference is external_order_id. Min length: 1. Max length: 40. |
amount_minor | integer | Yes | An integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991. |
currency | CNY | Yes | The three-letter uppercase currency code. |
review_status | received, needs_materials, under_review, awaiting_funds, approved, rejected, cancelled | Yes | The refund review state, separate from provider execution. |
execution_status | not_submitted, accepted, submitting, processing, unknown, succeeded, failed, cancelled | Yes | The provider execution state. unknown means that the result is unresolved. |
valid_received_at | string (date-time) | Yes | When the valid refund request was received, used to assess the request deadline. |
version | integer | Yes | The public refund version, updated as the refund lifecycle changes. Minimum: 1. Maximum: 9007199254740991. |
execution_id | string or null | Yes | The provider-execution reference, or null before execution is created. |
economics | object | Yes | |
economics.estimate | RefundEconomics or null | Yes | |
economics.actual | RefundEconomics or null | Yes | |
EventChannelConfirmation
| Field | Type | Required | Description |
|---|
id | string | Yes | The public resource identifier. Min length: 1. Max length: 40. |
order_id | string | Yes | The platform order ID. Your business order reference is external_order_id. Min length: 1. Max length: 40. |
status | awaiting_attestation, pending, confirmed, unknown, manual_review, not_required | Yes | The business state of the resource. HTTP 202 alone does not indicate completion. |
version | integer | Yes | The current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991. |