Skip to main content
GET
/
v1
/
aggregators
/
{raast-aggregator-id}
/
refunds
List Refunds
curl --request GET \
  --url https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/refunds \
  --header 'X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>'
{
  "api_version": "v1",
  "data": {
    "count": 1,
    "keys": [
      {
        "token": "<string>",
        "payment_id": "<string>",
        "amount": "<string>",
        "type": "<string>",
        "reason": "<string>",
        "addtl_info": "<string>",
        "status": "<string>",
        "trace_reference": "<string>",
        "msg_id": "<string>",
        "return_id": "<string>",
        "request_id": "<string>",
        "msg_created_at": "2025-03-13T09:12:34.000Z",
        "settle_at": null,
        "created_at": "2025-03-13T09:12:34.000Z",
        "updated_at": "2025-03-13T09:12:34.000Z"
      }
    ]
  }
}

Authorizations

​
X-SFPY-AGGREGATOR-SECRET-KEY
string
header
required

Path Parameters

​
raast-aggregator-id
string
required

The unique identifier for the aggregator

Example:

"agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e"

Query Parameters

​
limit
string
​
offset
string
​
payment_id
string[]

Filter refunds by one or more payment identifiers.

​
status
string[]

Filter refunds by one or more statuses.

​
trace_reference
string[]

Filter refunds by one or more trace references.

​
msg_id
string[]

Filter refunds by one or more Raast message identifiers.

​
return_id
string[]

Filter refunds by one or more return identifiers.

​
request_id
string[]

Filter refunds by one or more client request identifiers.

​
refund_id
string[]

Filter refunds by one or more refund identifiers.

​
start_date
integer

Filter refunds created on or after this UNIX timestamp.

​
end_date
integer

Filter refunds created on or before this UNIX timestamp.

​
direction
enum<string>
Available options:
ASC,
DESC

Response

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

Standard response structure for successful operations

​
api_version
string

The current version of the API spec

Example:

"v1"

​
data
object

Contains the response data