stable · event · 0.2.0
Refund outcome
Payload for payments.refund.succeeded or payments.refund.failed.
Capability Domain: payments
Reference identifier: payment-refund-outcome
Schema ID: https://minicenter.otus.tw/events/payments.refund.outcome.v1.schema.json
Delivery: At least once; deduplicate with the Domain Event envelope id.
Event schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://minicenter.otus.tw/events/payments.refund.outcome.v1.schema.json",
"title": "Refund outcome",
"description": "Payload for payments.refund.succeeded or payments.refund.failed.",
"type": "object",
"additionalProperties": false,
"required": [
"refund_id",
"payment_transaction_id",
"project_order_reference",
"amount",
"currency"
],
"properties": {
"refund_id": {
"type": "string",
"format": "uuid"
},
"payment_transaction_id": {
"type": "string",
"format": "uuid"
},
"project_order_reference": {
"type": "string",
"maxLength": 180
},
"amount": {
"type": "integer",
"minimum": 1
},
"currency": {
"type": "string",
"const": "TWD"
}
},
"x-documentation": true,
"x-reference-id": "payment-refund-outcome",
"x-domain": "payments",
"x-stability": "stable",
"x-delivery": "At least once; deduplicate with the Domain Event envelope id.",
"example": {
"refund_id": "72000000-0000-4000-8000-000000000007",
"payment_transaction_id": "70000000-0000-4000-8000-000000000007",
"project_order_reference": "sandbox-order-1001",
"amount": 100,
"currency": "TWD"
}
}
Example
{
"refund_id": "72000000-0000-4000-8000-000000000007",
"payment_transaction_id": "70000000-0000-4000-8000-000000000007",
"project_order_reference": "sandbox-order-1001",
"amount": 100,
"currency": "TWD"
}