Skip to main content
POST
/
v1
/
aggregators
/
{raast-aggregator-id}
/
refunds
Create Refund
curl --request POST \
  --url https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/refunds \
  --header 'Content-Type: application/json' \
  --header 'X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>' \
  --data '
{
  "request_id": "9af69842-3011-4d6b-98d0-c3de1caa96d3",
  "payment_id": "pm_54b6bcee-aa58-454d-aed9-ce97d6bdd797",
  "amount": 500,
  "reason": "TechnicalProblem",
  "addtl_info": "",
  "debitor_iban": "PK12ALFH0031001006540005"
}
'
{
  "api_version": "v1",
  "data": {
    "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"

Body

application/json

Request to create Refund

request_id
string
required
payment_id
string
required
amount
integer
required
reason
enum<string>
required
Available options:
TechnicalProblem,
DuplicatePayment
debitor_iban
string
required
addtl_info
string

Response

200 - application/json

This response contains details of a refund

Standard response structure for successful operations

api_version
string

The current version of the API spec

Example:

"v1"

data
object

Contains the response data