GetRefunds

post

https://{yourlidiaurl}/order/query/refunds

Queries and retrieves refunds matching the specified criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The refund query filters and pagination settings.

refundIds

array | null

Gets or sets a list of refund IDs to filter by.

refundIds

processIds

array | null

Gets or sets a list of process IDs to filter refunds by.

processIds

orderIds

array | null

Gets or sets a list of order IDs to filter refunds by.

orderIds

rootTransactionIds

array | null

Gets or sets a list of root transaction IDs to filter refunds by.

rootTransactionIds

transactionIds

array | null

Gets or sets a list of transaction IDs to filter refunds by.

transactionIds

channels

array of strings | null

Gets or sets a list of payment channels to filter refunds by.

channels

states

array of objects | null

Gets or sets a list of refund states to filter by.

states

Allowed:

environment

string | null

Gets or sets the environment identifier (e.g., Production, Staging).

applicationIP

string | null

Gets or sets the IP address of the calling application.

userToken

string | null

Gets or sets the user token for authentication context.

sessionId

string | null

Gets or sets the session identifier of the current user session.

userId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the numeric user identifier.

userIP

string | null

Gets or sets the IP address of the requesting user.

envelope

string | null

Gets or sets the envelope parameter for response shaping.

threadId

string | null

Gets or sets the thread identifier for request tracing and correlation.

includes

array of strings | null

Gets or sets the list of related entities to include in the response (e.g., Lines, Properties, Tags).

includes

searchKey

string | null

Gets or sets the search keyword used for full-text or partial matching.

pageIndex

string

^-?(?:0|[1-9]\d*)$

Gets or sets the page index for pagination (1-based).

pageSize

string

^-?(?:0|[1-9]\d*)$

Gets or sets the number of records per page for pagination.

sorting

string | null

Gets or sets the sorting expression (e.g., "Created desc", "Name asc").

status

array of objects | null

Gets or sets the list of entity statuses to filter by.

status

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200A paginated list of refunds.