Payment Refund

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

Event metadata

  • name: ACQUIRING
  • types:
    • 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.succeeded", 
    "event_id": "c26e83c3-8d3e-4886-94cf-db22472cad6f", 
    "source_id": "2024102509915950201", 
    "data": {
      "payment_refund_id":"b1c2d3e4-f5a6-b7c8-d9e0-f1a2b3c4d5e6",
      "payment_intent_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", 
      "payment_attempt_id": "550e8400-e29b-41d4-a716-446655440000",
      "amount": 10.01,
      "currency": "USD",
      "refund_status": "",
      "reason": "Order 1234 has been returned",
      "metadata": {
        "customer_id": "cust_12345",
        "order_id": "order_6789"
      },
      "create_time": "2024-03-01T00:00:00+08:00",
      "complete_time": "2024-03-01T00:00:00+08:00"
    }
}