From dbe814fc5cb21b3a925deba919db83e250d6f085 Mon Sep 17 00:00:00 2001 From: "Pimm \"de Chinchilla\" Hogeling" Date: Sun, 17 Sep 2023 16:32:00 +0200 Subject: [PATCH] Pull documentation from docs.mollie.com. --- src/data/orders/data.ts | 6 +++++- src/data/payments/data.ts | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/data/orders/data.ts b/src/data/orders/data.ts index b0bf154d..b94acf22 100644 --- a/src/data/orders/data.ts +++ b/src/data/orders/data.ts @@ -115,7 +115,11 @@ export interface OrderData extends Model<'order'> { */ redirectUrl: Nullable; /** - * The optional redirect URL you provided during payment creation. Consumer that explicitly cancel the order will be redirected to this URL if provided, or otherwise to the `redirectUrl` instead — see above. + * The optional redirect URL you provided during payment creation. Consumer that explicitly cancel the order will be redirected to this URL if provided, or otherwise to the `redirectUrl` instead — + * see above. + * + * Mollie will always give you status updates via webhooks, including for the `canceled` status. This parameter is therefore entirely optional, but can be useful when implementing a dedicated + * consumer-facing flow to handle order cancellations. * * The URL will be `null` for recurring orders. * diff --git a/src/data/payments/data.ts b/src/data/payments/data.ts index 645ecf3f..c7b5df0f 100644 --- a/src/data/payments/data.ts +++ b/src/data/payments/data.ts @@ -113,7 +113,11 @@ export interface PaymentData extends Model<'payment'> { */ redirectUrl?: string; /** - * The optional redirect URL you provided during payment creation. Consumer that explicitly cancel the payment will be redirected to this URL if provided, or otherwise to the `redirectUrl` instead — see above. + * The optional redirect URL you provided during payment creation. Consumer that explicitly cancel the payment will be redirected to this URL if provided, or otherwise to the `redirectUrl` instead — + * see above. + * + * Mollie will always give you status updates via webhooks, including for the `canceled` status. This parameter is therefore entirely optional, but can be useful when implementing a dedicated + * consumer-facing flow to handle payment cancellations. * * The URL will be `null` for recurring payments. *