Sign in

v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB
Query

Search for acquired payments and refunds

Supports querying multiple payment or refund orders using either the system order number or the merchant order number. Settlement information is not currently available for these orders, and no fee or charge details are provided. A reconciliation (settlement) API will be introduced later as needed.

post/open-api/v3/acquiring/search

Request body

pageinteger

Current page

limitinteger

Limit

tradeNostring

Order number

merchantTradeNostring

Merchant-generated order number, globally unique/idempotent

orderStatus'PENDING' | 'READY' | 'PAID' | 'FAILED' | 'CANCELED' | 'REFUNDED' | 'CANCELING' | 'AUTHORIZED' | 'REFUNDING' | 'CAPTURED' | 'CLOSED'

Order status PENDING: Order Creation in Progress READY: Waiting for Customer Payment PAID: Order Paid FAILED: Order Failed CANCELED: Order Canceled by Customer REFUNDED: Order Refunded CANCELING: Order Canceling AUTHORIZED: Order Authorized REFUNDING: Order Refunding CAPTURED: Payment Captured CLOSED: Order Closed (Typically due to Expiration)

orderType'UNDEFINED' | 'PAYMENT' | 'REFUND'

Order type

subMerchantIdstring

Sub-merchant ID (acquiring system sub-merchant ID)

paymentMethodstring

Payment method Type

Example request

{
  "tradeNo": "202506100638470951564431961",
  "merchantTradeNo": "d7f9c511-9b7c-4a4c-a3eb-59a28b414d63",
  "orderStatus": "PENDING",
  "orderType": "PAYMENT",
  "subMerchantId": "125324345435443",
  "paymentMethod": "CARD"
}

Response

OK

codeinteger

Return code

messagestring

Error message