json icon

Refund Requested

v1.0.0events

Published when the Payment Processing System requests a refund from the payment processor.

1{
2  "$schema": "http://json-schema.org/draft-07/schema#",
3  "title": "RefundRequested",
4  "description": "Published when a refund is requested from the payment processor",
5  "type": "object",
6  "properties": {
7    "refundId": { "type": "string", "format": "uuid" },
8    "paymentId": { "type": "string", "format": "uuid" },
9    "orderId": { "type": "string", "format": "uuid" },
10    "amount": {
11      "type": "integer",
12      "minimum": 0,
13      "description": "Amount to refund, in minor units (e.g. cents)"
14    },
15    "currency": { "type": "string", "pattern": "^[A-Z]{3}$" },
16    "reason": { "type": "string" },
17    "requestedAt": { "type": "string", "format": "date-time" }
18  },
19  "required": ["refundId", "paymentId", "amount", "currency", "requestedAt"]
20}
21

Details

Format
JSON Schema
Resource
events
Filename
schema.json

Versions