stable · event · 0.2.0
Recurring payment renewal outcome
Payload for payments.recurring.renewal.succeeded or payments.recurring.renewal.failed.
Capability Domain: payments
Reference identifier: payment-recurring-renewal-outcome
Schema ID: https://minicenter.otus.tw/events/payments.recurring.renewal.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.recurring.renewal.outcome.v1.schema.json",
"title": "Recurring payment renewal outcome",
"description": "Payload for payments.recurring.renewal.succeeded or payments.recurring.renewal.failed.",
"type": "object",
"additionalProperties": false,
"required": [
"recurring_payment_id",
"renewal_id",
"project_order_reference",
"amount",
"currency"
],
"properties": {
"recurring_payment_id": {
"type": "string",
"format": "uuid"
},
"renewal_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-recurring-renewal-outcome",
"x-domain": "payments",
"x-stability": "stable",
"x-delivery": "At least once; deduplicate with the Domain Event envelope id.",
"example": {
"recurring_payment_id": "71000000-0000-4000-8000-000000000007",
"renewal_id": "71100000-0000-4000-8000-000000000007",
"project_order_reference": "sandbox-order-1001",
"amount": 100,
"currency": "TWD"
}
}
Example
{
"recurring_payment_id": "71000000-0000-4000-8000-000000000007",
"renewal_id": "71100000-0000-4000-8000-000000000007",
"project_order_reference": "sandbox-order-1001",
"amount": 100,
"currency": "TWD"
}