List order refund records

GET 
/openapi/2026-07/orders/:order_id/refund

Returns all refund records attached to the specified order, along with the order's payment and order status at the moment of query.

Request

Path Parameters

order_id stringrequired

Order ID

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object
order_financial_statusstring
Payment status of the order:
• waiting: pending payment
• paying: payment under review
• authorized: authorized
• partially_paid: partially paid
• paid: paid
• cancelled: cancelled
• failed: payment failed
• refunding: refund in progress
• refund_failed: refund failed
• refunded: fully refunded
• partially_refunded: partially refunded
order_statusstring
Order status:
• opened: pending payment
• cancelled: cancelled
• placed: in progress
• finished: completed
records object[]
List of refund records associated with the order
Array [
idstring
Refund record ID
refund_pricestring
Refund price
refund_shippingstring
Shipping refund
refund_shipping_taxstring
Refund Shipping Tax
refund_methodstring
Refund method
refund_statusstring
Refund status:
• pending: refund in progress
• finished: refund completed
• failed: refund failed
notestring
Note
created_atstring
Time when the refund record was created (e.g., 2018-11-02T12:30:10Z)
updated_atstring
Time when the refund record was last updated (e.g., 2018-11-02T12:30:10Z)
refund_line_items object[]
List of refund line items
Array [
line_item_idstring
ID of the order line item being refunded
refund_quantityint32
Refund quantity
taxstring
Tax
discountstring
Discount
sub_totalstring
Subtotal
totalstring
Total
delete_quantityint32
Delete quantity
]
payment_details object[]
Payment details
Array [
idstring
Refund record ID
payment_line_idstring
Payment line ID
payment_channelstring
Payment channel
payment_methodstring
Payment method
refund_pricestring
Refund price
refund_statusstring
Refund status:
• pending: refund in progress
• finished: refund completed
• failed: refund failed
finished_atstring
Time when the refund was completed
]
additional_totalstring
Additional total
additional_prices object[]
Additional prices
Array [
namestring
Name of the additional charge
pricestring
Amount of the additional charge
biz_idstring
Business ID
fee_titlestring
Custom Charge Name
]
refund_tipstring
Tip refund amount
order_idstring
Order ID
]

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "order_financial_status": "string",
    "order_status": "string",
    "records": [
      {
        "id": "string",
        "refund_price": "string",
        "refund_shipping": "string",
        "refund_shipping_tax": "string",
        "refund_method": "string",
        "refund_status": "string",
        "note": "string",
        "created_at": "string",
        "updated_at": "string",
        "refund_line_items": [
          {
            "line_item_id": "string",
            "refund_quantity": 0,
            "tax": "string",
            "discount": "string",
            "sub_total": "string",
            "total": "string",
            "delete_quantity": 0
          }
        ],
        "payment_details": [
          {
            "id": "string",
            "payment_line_id": "string",
            "payment_channel": "string",
            "payment_method": "string",
            "refund_price": "string",
            "refund_status": "string",
            "finished_at": "string"
          }
        ],
        "additional_total": "string",
        "additional_prices": [
          {
            "name": "string",
            "price": "string",
            "biz_id": "string",
            "fee_title": "string"
          }
        ],
        "refund_tip": "string",
        "order_id": "string"
      }
    ]
  }
}