UPupflow
Refunds

List Refunds

List refunds with optional filtering.

get/refunds

Request

  • Base URL
    https://api.upflow.io/v1
  • Auth
    API key in header X-Api-Key and API key in header X-Api-Secret

Query parameters

offsetinteger

The 0-based index of the first item to return.

pageinteger
Example:1

The page number to retrieve (1-based). If both page and offset are provided, offset takes priority.

limitinteger
Example:100

Maximum number of items to return per page.

customer.idstring
Example:00a70b35-2be3-4c43-aefb-397190134655

Filter refunds by Customer ID.

customer.externalIdstring
Example:134

Filter refunds by external Customer ID.

updatedAt.gtstring date-time

Minimum value to filter by (exclusive)

updatedAt.gtestring date-time

Minimum value to filter by (inclusive)

updatedAt.ltstring date-time

Maximum value to filter by (exclusive)

updatedAt.ltestring date-time

Maximum value to filter by (inclusive)

{
  "updatedAt.gt": "2015-05-05T12:30:00Z",
  "updatedAt.gte": "2015-05-05T12:30:00Z",
  "updatedAt.lt": "2015-05-05T12:30:00Z",
  "updatedAt.lte": "2015-05-05T12:30:00Z"
}
sortBy'updatedAt' | 'validatedAt'

Sort refunds by a specific column.

sortOrder'DESC' | 'ASC'

Sort order.

Response

Paginated list of refunds.

offsetinteger

0-based index of the first item returned. Returned when using offset-based pagination or by default.

pageinteger

Page number (1-based). Returned when using page-based pagination.

limitinteger required

Maximum number of items returned.

totalinteger required

Total items in the set.

Changes

No recorded changes to this operation across all 1 revision of this API.