Finish refund

POST 
/openapi/2026-01/orders/:order_id/refund/finish

Marks the order's in-progress refund records as refunded successfully; afterwards the order is partially refunded or fully refunded.

This endpoint applies only to orders paid through a custom payment channel or the test payment channel (bogus).

Request

Path Parameters

order_id stringrequired

Order ID

application/json

Body

Bodyrequired

post_sale_idstringrequired

After-sales (post-sale) record ID

refund_record_idstringrequired

Refund record ID

refund_timestring

Time when the third-party refund completed, in RFC3339 (e.g., 2018-11-02T12:30:10Z)

transaction_numberstring

Refund transaction number

payment_channelstring

Refund payment channel

extra_info object

Extra information attached to the refund record

posstring

Additional POS information

Example

{
  "post_sale_id": "string",
  "refund_record_id": "string",
  "refund_time": "string",
  "transaction_number": "string",
  "payment_channel": "string",
  "extra_info": {
    "pos": "string"
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

order_idstring

Order ID

post_sale_idstring

After-sales (post-sale) record ID

refund_record object

Refund record

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

extra_info object

Extra information attached to the refund record

posstring

Additional POS information

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "order_id": "string",
    "post_sale_id": "string",
    "refund_record": {
      "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",
      "extra_info": {
        "pos": "string"
      }
    }
  }
}