THthewayl
Refunds

Retrieve Refunds

Changed on

Get a paginated list of refund requests with optional filtering by reference ID and status. Returns refunds ordered by creation date (newest first).

get/api/v1/refunds

Request

  • Base URL
    https://api.thewayl.com
  • URL
    https://api.thewayl.com/api/v1/refunds
  • Auth
    API key in header X-WAYL-AUTHENTICATION

Query parameters

referenceIdstring

Filter refunds by your order reference ID

takeinteger

Number of refunds to retrieve (default: 10)

skipinteger

Number of refunds to skip for pagination (default: 0)

statusesstring[]

Filter by refund status. Can provide multiple values. Valid statuses: Requested, Refunded, Rejected, Cancelled

[
  "Requested"
]

Response

Details of the refunds

messagestring

Changes

  • 76e77f7f7fefRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status