Sign in
Refunds

List Refunds

Retrieve a paginated list of refunds that have been issued

get/v1/aggregators/{raast-aggregator-id}/refunds

Request

  • Base URL: https://api.getsafepay.com/raastwire
  • URL: https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/refunds
  • Auth: API key in header X-SFPY-AGGREGATOR-SECRET-KEY

Query parameters

limitstring
offsetstring
payment_idstring[]

Filter refunds by one or more payment identifiers.

statusstring[]

Filter refunds by one or more statuses.

trace_referencestring[]

Filter refunds by one or more trace references.

msg_idstring[]

Filter refunds by one or more Raast message identifiers.

return_idstring[]

Filter refunds by one or more return identifiers.

request_idstring[]

Filter refunds by one or more client request identifiers.

refund_idstring[]

Filter refunds by one or more refund identifiers.

start_dateinteger

Filter refunds created on or after this UNIX timestamp.

end_dateinteger

Filter refunds created on or before this UNIX timestamp.

direction'ASC' | 'DESC'

Response

This response contains a paginated list of refunds linked to a payment

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "count": 1,
    "keys": [
      {
        "msg_created_at": "2025-03-13T09:12:34Z",
        "created_at": "2025-03-13T09:12:34Z",
        "updated_at": "2025-03-13T09:12:34Z"
      }
    ]
  }
}

Changes

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