POST
/
payments
/
{payment_id}
/
refund
curl --request POST \
  --url https://api.live.paisr.tech/{version}/payments/{payment_id}/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "full",
  "amount": 123,
  "note": "<string>"
}'
{
  "success": true,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
payment_id
string
required

The Payment ID.

Body

application/json
The details required to refund a approved payment.
​
type
enum<string>
required

Type of refund to perform

Available options:
full,
partial
​
note
string
required

Reason for refund.

​
amount
number

Amount to refund. Required when type is set to partial.

Response

200
application/json
Successfully refunded payment.
​
success
boolean

Indicates if the request was successful.

​
message
string

A descriptive message regarding the result.