API

Refunds API


Refund

POST /merchant/refund-payment
X-API-KEY: <key>
FieldTypeRequiredNotes
track_idstringYesOriginal payment
amountnumberNoDefaults to full refundable amount

Response

{
  "success": true,
  "refund_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}

Refundable balance

POST /merchant/get-refundable-balance
X-API-KEY: <key>
{ "track_id": "..." }

Response fields

track_id, total_amount, total_refunded, refundable_balance, currency, status


Provider notes

  • Mastercard / Apple Pay: refunds available
  • Benefit: refunds available
  • Benefit Web Checkout (benefit_web_checkout): refunds not available