Payment Refund

Sent when a payment attempt refund reaches its final state, either succeeded or failed.

Event metadata

  • name: ACQUIRING
  • types:
    • acquiring.refund.created
    • acquiring.refund.succeeded
    • acquiring.refund.failed

Request body

FieldsData TypeDescription
event_idstringA unique ID for the event.
event_namestringEvent name.
event_typestringEvent type.
source_idstringPayment refund ID.
versionstringAPI Version number.
dataobjectRelated business objects.

Notification example

{
  "version": "V1.6.0",
  "event_name": "ACQUIRING",
  "event_type": "acquiring.refund.created",
  "event_id": "7c052afa-30f8-4c9b-9fbc-a7557c581a5f",
  "source_id": "RF1944640274735042560",
  "data": {
    "amount": "0.01",
    "complete_time": null,
    "create_time": "2025-07-14T14:09:06+08:00",
    "currency": "SGD",
    "metadata": null,
    "payment_attempt_id": "PA1934457413516136448",
    "payment_intent_id": "PI1934457413415473152",
    "payment_refund_id": "RF1944640274735042560",
    "reason": "Return good",
    "refund_status": "INITIATED"
  }
}
{
  "version": "V1.6.0",
  "event_name": "ACQUIRING",
  "event_type": "acquiring.refund.succeeded",
  "event_id": "84d92a3b-a262-4987-9bea-2283542cf7fc",
  "source_id": "RF1944640274735042560",
  "data": {
    "amount": "0.01",
    "complete_time": "2025-07-14T14:09:10+08:00",
    "create_time": "2025-07-14T14:09:06+08:00",
    "currency": "SGD",
    "metadata": null,
    "payment_attempt_id": "PA1934457413516136448",
    "payment_intent_id": "PI1934457413415473152",
    "payment_refund_id": "RF1944640274735042560",
    "reason": "Return good",
    "refund_status": "SUCCEEDED"
  }
}