Skip to main content
POST
Refund a donation

Authorizations

X-HYS-API-Key
string
header
required

Gratona API key sent with the compatibility header X-HYS-API-Key.

Headers

Idempotency-Key
string

Stable client-generated operation key. Reuse it when retrying the same refund request.

Maximum string length: 255

Path Parameters

donation_id
integer
required

ID of the donation to be refunded

Body

application/json
amount
number<float>

Amount to refund. Defaults to the donation's full remaining amount when omitted.

Required range: x >= 0.01
Example:

25

Response

Donation successfully refunded.

message
string
Example:

"Donation successfully refunded."