Refunds
Refund a succeeded payment with
POST /gateway/sessions/{id}/refund/.
Refunds can be full or partial.
Request
Section titled “Request”curl https://api.paymee.online/api/v1/gateway/sessions/ps_3Nk8x2c9aQ.../refund/ \ -H "Authorization: Bearer sk_live_…" \ -H "Content-Type: application/json" \ -d '{ "reason": "Customer requested a refund", "refund_type": "FULL" }'| Field | Type | Required | Notes |
|---|---|---|---|
reason |
string | ✅ | Why the refund is issued. |
refund_type |
string | – | FULL (default) or PARTIAL. |
amount |
string | conditional | Required for PARTIAL. Decimal string with currency-correct precision. |
metadata |
object | – | Arbitrary key/values. |
For a partial refund:
{ "reason": "Damaged item", "refund_type": "PARTIAL", "amount": "3.000" }Response
Section titled “Response”{ "refund_id": "rf_8Qa…", "refunded_amount": "10.500", "automated_refund": true}automated_refund: true— the acquirer refund/reversal was confirmed automatically.automated_refund: false— the refund was accepted but the acquirer step could not be confirmed automatically; our operations team processes it manually. In that case the response also carries anepg_error_message.

