Query Refunds

Return a paginated list of matching refunds.

SecurityMarketplace Api Key | Merchant Secret Token | Admin JWT | Merchant JWT | Marketplace JWT
Request
query Parameters
limit
integer <int32>

Maximum results per page. Default to 20, must be between 1 and 500.

page
integer <int32>

Page number of results to show (starting at page 1).

sort
string

Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a - character.

createdAfter
string <date-time>

Return transactions that were created at or after this timestamp in ISO-8601 format

Example: createdAfter=2024-09-06T05:56:26.51312831Z
createdBefore
string <date-time>

Return transactions that were created at or before this timestamp in ISO-8601 format

amount
integer <int64>

Amount of the refund in minor currency units

referenceOrderId
string

Filter by reference order id

orderId
Array of strings

Filter by order identifier

customerId
Array of strings

Filter by customer identifier

merchantId
Array of strings

Filter by merchant identifier

transactionId
Array of strings

Filter by transaction identifier

Responses
200

Matching items sorted as specified

400
401
403
404
405
406
409
422
429
500
503
get/transactions/refunds
Request samples 
Response samples 
application/json
[
  • {
    }
]
Copyright © April Solutions 2023. All right reserved.