Skip to main content
POST
/
v1
/
refunds
/
initiate
Initiate Refund
curl --request POST \
  --url https://api.peere.network/v1/refunds/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transactionId": "<string>",
  "amount": 123,
  "reason": "<string>",
  "refundType": "full",
  "metadata": {}
}
'
{
  "statusCode": 201,
  "success": true,
  "message": "Refund initiated successfully",
  "data": {
    "refundId": "<string>",
    "status": "<string>",
    "estimatedProcessingTime": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
transactionId
string
required
​
amount
number
required
​
reason
string
required
​
refundType
enum<string>
required
Available options:
full,
partial
​
metadata
object

Response

Refund initiated successfully

​
statusCode
integer
Example:

201

​
success
boolean
Example:

true

​
message
string
Example:

"Refund initiated successfully"

​
data
object