Skip to main content

Objects and fields

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.

Meta​

FieldTypeRequiredDescription
request_idstringYesThe API request correlation ID. Min length: 1. Max length: 40.
as_ofstring (date-time)YesThe time represented by the response, in RFC 3339 format.
sync_lag_secondsinteger or nullYesKnown reporting synchronization delay in seconds; null when unknown or not applicable.
data_sourcecn, usYesThe response source: cn for the China service or us for US reporting.

Error​

FieldTypeRequiredDescription
codeVALIDATION_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_EXPIREDYesThe machine-readable error code.
messagestringYesHuman-readable context. Do not branch on its exact wording. Min length: 1. Max length: 1024.
request_idstringYesThe API request correlation ID. Min length: 1. Max length: 40.
retryablebooleanYesWhether the request may be retried later. Preserve the original command and idempotency key.
current_versioninteger or nullYes
operation_idstring or nullYesThe asynchronous operation ID used to retrieve progress.
status_pathstring or nullYesThe relative API path used to retrieve the resource or operation. Resolve against the assigned trusted service.
detailsarray of objectYesMax items: 100.

Version​

FieldTypeRequiredDescription
expected_versionintegerYesThe resource version you most recently read, used to prevent overwriting a concurrent change. Minimum: 1. Maximum: 9007199254740991.

CreatePayment​

FieldTypeRequiredDescription
app_idstringYesThe platform application ID authorized by the credential. Min length: 1. Max length: 40.
amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991.
currencyCNYYesThe three-letter uppercase currency code.
external_order_idstringYesYour 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.
descriptionstringYesA concise customer-facing purchase description. Min length: 1. Max length: 128.
sceneobjectNoEntry-specific payment context. wechat_h5 requires client_ip and return_url_id.
scene.client_ipstring (ipv4) or string (ipv6)NoThe IP address of the customer initiating the payment.
scene.return_url_idstringNoThe ID of an approved return-URL configuration. Do not send an arbitrary URL. Min length: 1. Max length: 40.
payment_entrywechat_app, wechat_h5, wechat_native, alipay_app, alipay_wap, alipay_page, alipay_qrYesThe 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​

FieldTypeRequiredDescription
orderCnOrderYes
invocationInvocation or nullYesClient payment instructions, or null while unavailable.

VerifyPurchase​

FieldTypeRequiredDescription
app_idstringYesThe platform application ID authorized by the credential. Min length: 1. Max length: 40.
product_idstringYesThe platform HMS product mapping ID, separate from the provider product ID. Min length: 1. Max length: 40.
client_user_idstringYesA 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_idstringYesYour 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_evidencestringYesThe provider purchase evidence in the representation agreed for your HMS adapter. Min length: 1. Max length: 65536.

Verification​

FieldTypeRequiredDescription
idstringYesThe public resource identifier. Min length: 1. Max length: 40.
statuspending, verified, rejected, unknownYesThe business state of the resource. HTTP 202 alone does not indicate completion.
order_idstring or nullYesThe platform order ID. Your business order reference is external_order_id.
failure_codestring or nullYesThe failure classification, or null when there is no recorded failure.
versionintegerYesThe 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.

FieldTypeRequiredDescription
idstringYesThe public resource identifier. Min length: 1. Max length: 40.
app_idstringYesThe platform application ID authorized by the credential. Min length: 1. Max length: 40.
order_idstringYesThe platform order ID. Your business order reference is external_order_id. Min length: 1. Max length: 40.
amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991.
currencyCNYYesThe three-letter uppercase currency code.
review_statusreceived, needs_materials, under_review, awaiting_funds, approved, rejected, cancelledYesThe refund review state, separate from provider execution.
execution_statusnot_submitted, accepted, submitting, processing, unknown, succeeded, failed, cancelledYesThe provider execution state. unknown means that the result is unresolved.
valid_received_atstring (date-time)YesWhen the valid refund request was received, used to assess the request deadline.
versionintegerYesThe public refund version. Advances when the request, execution, or confirmed economics change. Minimum: 1. Maximum: 9007199254740991.
execution_idstring or nullYesThe provider-execution reference, or null before execution is created.
economicsobjectYes
economics.estimateRefundEconomics or nullYes
economics.actualRefundEconomics or nullYes

RefundInput​

FieldTypeRequiredDescription
amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991.
reasoncustomer_request, duplicate, fraud, service_issue, consumer_complaint, otherYesThe refund reason.
expected_order_versionintegerYesThe current order version used to check concurrency. Minimum: 1. Maximum: 9007199254740991.

Operation​

FieldTypeRequiredDescription
idstringYesThe public resource identifier. Min length: 1. Max length: 40.
statuspending, running, succeeded, failed, manual_reviewYesThe business state of the resource. HTTP 202 alone does not indicate completion.
resourceResourceRef or nullYes
failure_codestring or nullYesThe failure classification, or null when there is no recorded failure.
created_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
completed_atstring (date-time) or nullYesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
status_pathstringYesThe relative API path used to retrieve the resource or operation. Resolve against the assigned trusted service.

ChannelConfirmation​

FieldTypeRequiredDescription
idstringYesThe public resource identifier. Min length: 1. Max length: 40.
order_idstringYesThe platform order ID. Your business order reference is external_order_id. Min length: 1. Max length: 40.
statusawaiting_attestation, pending, confirmed, unknown, manual_review, not_requiredYesThe business state of the resource. HTTP 202 alone does not indicate completion.
versionintegerYesThe current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991.

FulfillmentAttestation​

FieldTypeRequiredDescription
expected_versionintegerYesThe resource version you most recently read, used to prevent overwriting a concurrent change. Minimum: 1. Maximum: 9007199254740991.
fulfilled_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
fulfillment_referencestringYesYour durable business fulfillment reference. Min length: 1. Max length: 191.

ResourceRef​

FieldTypeRequiredDescription
typeapp, order, refund, settlement, case, approval_case, policy, evidence, credential, webhook_endpoint, payout_attempt, ledger_entry, admin_grantYes
idstringYesThe public resource identifier. Min length: 1. Max length: 40.

CnOrder​

CN customer-server view. External reference never enters the US order projection.

FieldTypeRequiredDescription
idstringYesThe public resource identifier. Min length: 1. Max length: 40.
app_idstringYesThe platform application ID authorized by the credential. Min length: 1. Max length: 40.
environmentproductionYesThe payment environment. This edition supports production.
amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991.
currencyCNYYesThe three-letter uppercase currency code.
statuspending, processing, unknown, paid, failed, closedYesThe business state of the resource. HTTP 202 alone does not indicate completion.
paid_atstring (date-time) or nullYesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
policy_snapshot_idstring or nullYesThe public resource identifier.
versionintegerYesThe current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991.
created_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
payment_entrywechat_app, wechat_h5, wechat_native, alipay_app, alipay_wap, alipay_page, alipay_qr, hms_iapYesThe payment provider and entry method, such as wechat_h5 or alipay_qr.
paid_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
refunded_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
pending_refund_amount_minorintegerYesRefund 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_atstring (date-time) or nullYesA valid refund request must be received before this exclusive deadline. Null before payment.
external_order_idstringYesYour 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.

FieldTypeRequiredDescription
providerwechatYes
app_idstringYesThe WeChat AppID for the native SDK invocation, separate from the platform application ID. Min length: 1. Max length: 1024.
merchant_idstringYesThe payment provider merchant identifier. Min length: 1. Max length: 1024.
prepay_idstringYesThe public resource identifier. Min length: 1. Max length: 1024.
packagestringYesMin length: 1. Max length: 1024.
noncestringYesMin length: 1. Max length: 1024.
timestampstringYes
signaturestringYesMin length: 1. Max length: 1024.
signature_algorithmRSA, HMAC-SHA256, MD5Yes

InvocationSdkString​

FieldTypeRequiredDescription
kindsdk_stringYes
sdk_stringstringYesMin length: 1. Max length: 65536.
expires_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.

InvocationSdkFields​

FieldTypeRequiredDescription
kindsdk_fieldsYes
sdk_fieldsWechatSdkFieldsYes
expires_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.

InvocationRedirectUrl​

FieldTypeRequiredDescription
kindredirect_urlYes
redirect_urlstring (uri)Yes
expires_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.

InvocationQrUrl​

FieldTypeRequiredDescription
kindqr_urlYes
qr_urlstring (uri)Yes
expires_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.

InvocationHtmlForm​

FieldTypeRequiredDescription
kindhtml_formYes
html_formstringYesMin length: 1. Max length: 65536.
expires_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.

RefundEconomics​

FieldTypeRequiredDescription
developer_principal_reversal_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
platform_principal_reversal_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
original_payment_fee_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
developer_fee_already_borne_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
developer_fee_adjustment_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: -9007199254740991. Maximum: 9007199254740991.
developer_refund_cost_minorintegerYesPrincipal reversal plus signed incremental original-fee adjustment; consumer refund principal is never reduced. Minimum: -9007199254740991. Maximum: 9007199254740991.
outstanding_debt_minorintegerYesDebt as of calculated_at, not a live debt balance. Current outstanding debt is read from Balance. Minimum: 0. Maximum: 9007199254740991.
policy_snapshot_idstringYesThe public resource identifier. Min length: 1. Max length: 40.
calculated_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.

App​

FieldTypeRequiredDescription
idstringYesThe public resource identifier. Min length: 1. Max length: 40.
environmentproductionYesThe payment environment. This edition supports production.
statusonboarding, active, suspended, closing, closedYesThe business state of the resource. HTTP 202 alone does not indicate completion.
versionintegerYesThe current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991.
client_idstringYesThe public customer ID associated with the application. Min length: 1. Max length: 40.
enabled_payment_entriesarray of wechat_app, wechat_h5, wechat_native, alipay_app, alipay_wap, alipay_page, alipay_qr, hms_iapYesPayment entries enabled for this application. Max items: 100.
us_app_idstring (uuid) or nullYesThe US application UUID, separate from the payment application ID.

Order​

FieldTypeRequiredDescription
idstringYesThe public resource identifier. Min length: 1. Max length: 40.
app_idstringYesThe platform application ID authorized by the credential. Min length: 1. Max length: 40.
environmentproductionYesThe payment environment. This edition supports production.
amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991.
currencyCNYYesThe three-letter uppercase currency code.
statuspending, processing, unknown, paid, failed, closedYesThe business state of the resource. HTTP 202 alone does not indicate completion.
paid_atstring (date-time) or nullYesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
policy_snapshot_idstring or nullYesThe public resource identifier.
versionintegerYesThe current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991.
created_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
payment_entrywechat_app, wechat_h5, wechat_native, alipay_app, alipay_wap, alipay_page, alipay_qr, hms_iapYesThe payment provider and entry method, such as wechat_h5 or alipay_qr.
paid_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
refunded_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
pending_refund_amount_minorintegerYesRefund 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_atstring (date-time) or nullYesA valid refund request must be received before this exclusive deadline. Null before payment.

RefundEligibility​

FieldTypeRequiredDescription
order_idstringYesThe platform order ID. Your business order reference is external_order_id. Min length: 1. Max length: 40.
eligiblebooleanYesWhether the order is eligible at the time of the check. Revalidated on submission.
refundable_amount_minorintegerYesMaximum refundable principal at the time of the check, in minor units. Revalidated on submission. Minimum: 0. Maximum: 9007199254740991.
order_versionintegerYesMinimum: 1. Maximum: 9007199254740991.
checked_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
blocked_reasonsarray of stringYesReasons preventing the operation or release at the time of the check. Max items: 100.
refund_request_deadline_atstring (date-time) or nullYesA 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.

FieldTypeRequiredDescription
app_idstringYesThe platform application ID authorized by the credential. Min length: 1. Max length: 40.
currencyCNY, USDYesThe three-letter uppercase currency code.
as_ofstring (date-time)YesThe time represented by the response, in RFC 3339 format.
locked_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
available_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
reserve_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
pending_refund_amount_minorintegerYesRefund 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_minorintegerYesFunds reserved for a settlement that has not completed, in minor units. Minimum: 0. Maximum: 9007199254740991.
outstanding_debt_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
risk_hold_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
settlement_eligible_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.

ReleaseStage​

FieldTypeRequiredDescription
idstringYesThe public resource identifier. Min length: 1. Max length: 40.
lot_idstringYesThe public resource identifier. Min length: 1. Max length: 40.
due_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
blocked_reasonsarray of stringYesReasons preventing the operation or release at the time of the check. Max items: 100.
original_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
released_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
consumed_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.

WebhookEvent​

FieldTypeRequiredDescription
event_idstringYesThe event identifier. Retries and replays of the same event retain this value. Min length: 1. Max length: 40.
schema_version1YesThe event schema version, separate from the business resource version.
typepayment.succeeded, payment.failed, payment.closed, refund.succeeded, refund.failed, hms.confirmation.required, hms.confirmation.completedYes
app_idstringYesThe platform application ID authorized by the credential. Min length: 1. Max length: 40.
environmentproductionYesThe payment environment. This edition supports production.
occurred_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
resource_versionintegerYesThe version of the resource represented by the event. Compare versions within the same resource. Minimum: 1. Maximum: 9007199254740991.
dataEventOrder or EventRefund or EventChannelConfirmationYesThe 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​

FieldTypeRequiredDescription
event_idstringYesThe event identifier. Retries and replays of the same event retain this value. Min length: 1. Max length: 40.
schema_version1YesThe event schema version, separate from the business resource version.
typeendpoint.verificationYes
app_idstringYesThe platform application ID authorized by the credential. Min length: 1. Max length: 40.
environmentproductionYesThe payment environment. This edition supports production.
occurred_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
dataobjectYesThe response resource or resource list.
data.endpoint_idstringYesThe webhook endpoint ID. Min length: 1. Max length: 40.
data.challengestringYesMin length: 32. Max length: 256.
data.expires_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.

EventOrder​

FieldTypeRequiredDescription
idstringYesThe public resource identifier. Min length: 1. Max length: 40.
app_idstringYesThe platform application ID authorized by the credential. Min length: 1. Max length: 40.
environmentproductionYesThe payment environment. This edition supports production.
amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991.
currencyCNYYesThe three-letter uppercase currency code.
statuspending, processing, unknown, paid, failed, closedYesThe business state of the resource. HTTP 202 alone does not indicate completion.
paid_atstring (date-time) or nullYesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
policy_snapshot_idstring or nullYesThe public resource identifier.
versionintegerYesThe current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991.
created_atstring (date-time)YesAn RFC 3339 timestamp with an explicit offset. Financial business dates use Asia/Shanghai.
payment_entrywechat_app, wechat_h5, wechat_native, alipay_app, alipay_wap, alipay_page, alipay_qr, hms_iapYesThe payment provider and entry method, such as wechat_h5 or alipay_qr.
paid_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
refunded_amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 0. Maximum: 9007199254740991.
pending_refund_amount_minorintegerYesRefund 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_atstring (date-time) or nullYesA 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.

FieldTypeRequiredDescription
idstringYesThe public resource identifier. Min length: 1. Max length: 40.
app_idstringYesThe platform application ID authorized by the credential. Min length: 1. Max length: 40.
order_idstringYesThe platform order ID. Your business order reference is external_order_id. Min length: 1. Max length: 40.
amount_minorintegerYesAn integer in the smallest currency unit: fen for CNY or cents for USD. Minimum: 1. Maximum: 9007199254740991.
currencyCNYYesThe three-letter uppercase currency code.
review_statusreceived, needs_materials, under_review, awaiting_funds, approved, rejected, cancelledYesThe refund review state, separate from provider execution.
execution_statusnot_submitted, accepted, submitting, processing, unknown, succeeded, failed, cancelledYesThe provider execution state. unknown means that the result is unresolved.
valid_received_atstring (date-time)YesWhen the valid refund request was received, used to assess the request deadline.
versionintegerYesThe public refund version, updated as the refund lifecycle changes. Minimum: 1. Maximum: 9007199254740991.
execution_idstring or nullYesThe provider-execution reference, or null before execution is created.
economicsobjectYes
economics.estimateRefundEconomics or nullYes
economics.actualRefundEconomics or nullYes

EventChannelConfirmation​

FieldTypeRequiredDescription
idstringYesThe public resource identifier. Min length: 1. Max length: 40.
order_idstringYesThe platform order ID. Your business order reference is external_order_id. Min length: 1. Max length: 40.
statusawaiting_attestation, pending, confirmed, unknown, manual_review, not_requiredYesThe business state of the resource. HTTP 202 alone does not indicate completion.
versionintegerYesThe current resource version used for concurrency control. Minimum: 1. Maximum: 9007199254740991.