List refund orders

GET 
/openapi/2026-07/shoplazza-payment/refunds

Returns a paginated list of refund orders, optionally filtered by status and creation time range.

Request

Query Parameters

cursor string

Cursor for pagination

page_size int32

Page size (1-100, default 10)

status string
Filter refund orders by status:
• succeeded: refund processed successfully
• failed: refund attempt failed; no funds were returned
• processing: refund is being processed; final result pending
created_at_min string

Filter refund orders initiated at or after this time. Accepts Unix timestamp (e.g., 1730548810) or ISO datetime string (e.g., 2018-11-02T12:30:10Z)

created_at_max string

Filter refund orders initiated at or before this time. Accepts Unix timestamp (e.g., 1730548810) or ISO datetime string (e.g., 2018-11-02T12:30:10Z)

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

list object[]

List of refund order records

Array [

idstring

Refund ID

store_idstring

Store ID associated with the refund

balance_currencystring

Currency used for the balance

transaction_order_idstring

ID of the transaction order associated with the refund

statusstring

Refund status:

• succeeded: Refund successfully processed
• failed: Refund failed
• processing: Refund is pending processing

amountstring

Refund amount

currencystring

Currency code of the refund (e.g., USD)

original_order_amountstring

Original order amount prior to the refund

created_atstring

Refund creation timestamp (ISO-8601 format)

completed_atstring

Timestamp indicating when the refund was completed (ISO-8601 format)

]

cursorstring

Cursor for pagination

has_moreboolean

Whether there are more records

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "list": [
      {
        "id": "string",
        "store_id": "string",
        "balance_currency": "string",
        "transaction_order_id": "string",
        "status": "string",
        "amount": "string",
        "currency": "string",
        "original_order_amount": "string",
        "created_at": "string",
        "completed_at": "string"
      }
    ],
    "cursor": "string",
    "has_more": true
  }
}