From 22b86bdb25b3b48ce94778ddd94c3e1c8e713f91 Mon Sep 17 00:00:00 2001 From: ntombing Date: Thu, 11 Dec 2025 13:25:38 +0200 Subject: [PATCH 1/9] New guide get mandate --- .../online/sdd/guide-get-mandate.mdx | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 docs/topics/merchants/online/sdd/guide-get-mandate.mdx diff --git a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx new file mode 100644 index 0000000000..72c267c427 --- /dev/null +++ b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx @@ -0,0 +1,56 @@ +--- +title: Get mandate URL +--- + +## Get mandate URL + +After a SEPA Direct Debit (SDD) B2B mandate has been declared, you may need to retrieve the **mandate information**. +This is particularly useful for making the mandate available to **merchants**, who can then share it with their clients (the debtors). +You can retrieve a specific mandate using the **payment mandate ID**. + +:::tip Prerequisites +1. **Mandate declaration:** A SEPA Direct Debit mandate must have been previously **added** using the `addSepaDirectDebitPaymentMandate` mutation. +1. **Mandate ID:** You must know the **unique payment mandate ID** of the mandate you want to retrieve. +::: + +## API {#api} + +Queries are highly customizable. This guide focuses solely on using the **`paymentMandate`** query to get the mandate URL. Learn more about this query in the guide to [get payment information](link_to_get_payment_information_guide). + +1. Call the **`paymentMandate`** query. +2. Check the boxes for **`id`** and **`SEPAPaymentDirectDebitMandate`**. +3. Under **`SEPAPaymentDirectDebitMandate`**, check the boxes for **`id`**, **`name`** and **`mandateDocumentUrl`**. + * `mandateDocumentUrl` allows you to receive a **download URL** in the payload. + +### Query {#query} + +Open in API Explorer + +```graphql {4,6-7,11} showLineNumbers +query GetMandate { + paymentMandate(id: "$YOUR_MANDATE_ID") { + ... on SEPAPaymentDirectDebitMandate { + id + name + mandateDocumentUrl + } + } +} +``` + +### Payload {#payload} + +1. The response includes the download URL (line 4), which begins with `bank-details.swan.io`. +1. Paste the URL into your browser, then press enter. This triggers the download of your PDF. + +```json {4} showLineNumbers +{ + "data": { + "paymentMandate": { + "id": "$YOUR_MANDATE_ID", + "name": "B2B/Core SEPA Direct Debit Mandate", + "mandateDocumentUrl": "$YOUR_MANDATE_URL" + } + } +} +``` \ No newline at end of file From c4d3a4c44c76f831da62fa8abb50ff32f65f8b53 Mon Sep 17 00:00:00 2001 From: ntombing Date: Thu, 11 Dec 2025 15:34:23 +0200 Subject: [PATCH 2/9] Sidebar update and overview links --- docs/topics/merchants/online/sdd/index.mdx | 1 + sidebars.js | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/topics/merchants/online/sdd/index.mdx b/docs/topics/merchants/online/sdd/index.mdx index b4e0595af3..43c3008a4b 100644 --- a/docs/topics/merchants/online/sdd/index.mdx +++ b/docs/topics/merchants/online/sdd/index.mdx @@ -280,6 +280,7 @@ They can investigate the reason for return and take whatever action is necessary - [Accept payments with SEPA Direct Debit (step-by-step)](./guide-sdd.mdx) - [Request SEPA Direct Debit payment method](./guide-request.mdx) - [Declare a payment mandate](./guide-declare.mdx) +- [Get SEPA Direct Debit mandate URL](./guide-get-mandate.mdx) - [Initiate a SEPA Direct Debit transaction](./guide-initiate.mdx) - [Update SEPA Direct Debit payment method](./guide-update.mdx) - [Sandbox](./sandbox.mdx) \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 8c1dee1306..0a650be90e 100644 --- a/sidebars.js +++ b/sidebars.js @@ -321,6 +321,7 @@ module.exports = { "topics/merchants/online/sdd/guide-sdd", "topics/merchants/online/sdd/guide-request", "topics/merchants/online/sdd/guide-declare", + "topics/merchants/online/sdd/get-mandate", "topics/merchants/online/sdd/guide-initiate", "topics/merchants/online/sdd/guide-update", "topics/merchants/online/sdd/guide-create-link", From af1dd215e8f270f30ddb31e2d75aea8838ffb7d5 Mon Sep 17 00:00:00 2001 From: Maxence Busson Date: Thu, 11 Dec 2025 18:12:04 +0100 Subject: [PATCH 3/9] Update sidebars.js --- sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sidebars.js b/sidebars.js index 0a650be90e..82a56628b0 100644 --- a/sidebars.js +++ b/sidebars.js @@ -321,7 +321,7 @@ module.exports = { "topics/merchants/online/sdd/guide-sdd", "topics/merchants/online/sdd/guide-request", "topics/merchants/online/sdd/guide-declare", - "topics/merchants/online/sdd/get-mandate", + "topics/merchants/online/sdd/guide-get-mandate", "topics/merchants/online/sdd/guide-initiate", "topics/merchants/online/sdd/guide-update", "topics/merchants/online/sdd/guide-create-link", From c3b7e199f3c6f1126fd5a5804f5f08e1387b1bd0 Mon Sep 17 00:00:00 2001 From: Maxence Busson Date: Thu, 11 Dec 2025 18:22:37 +0100 Subject: [PATCH 4/9] Update guide-get-mandate.mdx --- docs/topics/merchants/online/sdd/guide-get-mandate.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx index 72c267c427..4fc01ae51a 100644 --- a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx +++ b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx @@ -15,7 +15,7 @@ You can retrieve a specific mandate using the **payment mandate ID**. ## API {#api} -Queries are highly customizable. This guide focuses solely on using the **`paymentMandate`** query to get the mandate URL. Learn more about this query in the guide to [get payment information](link_to_get_payment_information_guide). +Queries are highly customizable. This guide focuses solely on using the **`paymentMandate`** query to get the mandate URL. Learn more about this query in the guide to [get payment information](/topics/payments/overview/guide-get-payment-info). 1. Call the **`paymentMandate`** query. 2. Check the boxes for **`id`** and **`SEPAPaymentDirectDebitMandate`**. From aa3841eecf575e4f79bdbb0d5af7d4cbdfcdb186 Mon Sep 17 00:00:00 2001 From: ntombing Date: Fri, 12 Dec 2025 10:00:24 +0200 Subject: [PATCH 5/9] Updates to guide --- .../online/sdd/guide-get-mandate.mdx | 21 ++++++++----------- 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx index 4fc01ae51a..cbef315a0b 100644 --- a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx +++ b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx @@ -2,31 +2,28 @@ title: Get mandate URL --- -## Get mandate URL - -After a SEPA Direct Debit (SDD) B2B mandate has been declared, you may need to retrieve the **mandate information**. -This is particularly useful for making the mandate available to **merchants**, who can then share it with their clients (the debtors). +After a SEPA Direct Debit (SDD) B2B mandate has been declared, you may need to retrieve the mandate information. You can retrieve a specific mandate using the **payment mandate ID**. :::tip Prerequisites -1. **Mandate declaration:** A SEPA Direct Debit mandate must have been previously **added** using the `addSepaDirectDebitPaymentMandate` mutation. +1. **Mandate declaration:** A SEPA Direct Debit mandate must have been previously declared using the `addSepaDirectDebitPaymentMandate` mutation. 1. **Mandate ID:** You must know the **unique payment mandate ID** of the mandate you want to retrieve. ::: ## API {#api} -Queries are highly customizable. This guide focuses solely on using the **`paymentMandate`** query to get the mandate URL. Learn more about this query in the guide to [get payment information](/topics/payments/overview/guide-get-payment-info). +Queries are highly customizable. This guide focuses solely on using the `paymentMandate` query to get the mandate URL. -1. Call the **`paymentMandate`** query. -2. Check the boxes for **`id`** and **`SEPAPaymentDirectDebitMandate`**. -3. Under **`SEPAPaymentDirectDebitMandate`**, check the boxes for **`id`**, **`name`** and **`mandateDocumentUrl`**. +1. Call the `paymentMandate` query. +2. Check the boxes for `id` (line 2) and `SEPAPaymentDirectDebitMandate` (line 3). +3. Under `SEPAPaymentDirectDebitMandate`, check the boxes for `id`, `name` and `mandateDocumentUrl` (lines 4-6). * `mandateDocumentUrl` allows you to receive a **download URL** in the payload. ### Query {#query} Open in API Explorer -```graphql {4,6-7,11} showLineNumbers +```graphql {2,3,4-6} showLineNumbers query GetMandate { paymentMandate(id: "$YOUR_MANDATE_ID") { ... on SEPAPaymentDirectDebitMandate { @@ -40,10 +37,10 @@ query GetMandate { ### Payload {#payload} -1. The response includes the download URL (line 4), which begins with `bank-details.swan.io`. +1. The response includes a mandate name (line 5), and the download URL (line 6). 1. Paste the URL into your browser, then press enter. This triggers the download of your PDF. -```json {4} showLineNumbers +```json {5,6} showLineNumbers { "data": { "paymentMandate": { From 4f16870ee59602b489ae76193a5ea783832728ee Mon Sep 17 00:00:00 2001 From: ntombing Date: Wed, 17 Dec 2025 16:30:29 +0200 Subject: [PATCH 6/9] Update docs/topics/merchants/online/sdd/guide-get-mandate.mdx Co-authored-by: Max B. <17831738+max-koro@users.noreply.github.com> --- docs/topics/merchants/online/sdd/guide-get-mandate.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx index cbef315a0b..07f5d0f887 100644 --- a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx +++ b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx @@ -15,7 +15,7 @@ You can retrieve a specific mandate using the **payment mandate ID**. Queries are highly customizable. This guide focuses solely on using the `paymentMandate` query to get the mandate URL. 1. Call the `paymentMandate` query. -2. Check the boxes for `id` (line 2) and `SEPAPaymentDirectDebitMandate` (line 3). +2. Add your payment mandate ID (line 2). Include the `SEPAPaymentDirectDebitMandate` fragment with the fields you need (line 3). 3. Under `SEPAPaymentDirectDebitMandate`, check the boxes for `id`, `name` and `mandateDocumentUrl` (lines 4-6). * `mandateDocumentUrl` allows you to receive a **download URL** in the payload. From 5b3878745a9d2d3fceb1382bda819a54106fa531 Mon Sep 17 00:00:00 2001 From: ntombing Date: Wed, 17 Dec 2025 16:30:53 +0200 Subject: [PATCH 7/9] Update docs/topics/merchants/online/sdd/guide-get-mandate.mdx Co-authored-by: Max B. <17831738+max-koro@users.noreply.github.com> --- docs/topics/merchants/online/sdd/guide-get-mandate.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx index 07f5d0f887..cef592998a 100644 --- a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx +++ b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx @@ -6,7 +6,7 @@ After a SEPA Direct Debit (SDD) B2B mandate has been declared, you may need to r You can retrieve a specific mandate using the **payment mandate ID**. :::tip Prerequisites -1. **Mandate declaration:** A SEPA Direct Debit mandate must have been previously declared using the `addSepaDirectDebitPaymentMandate` mutation. +1. **Mandate declaration:** A SEPA Direct Debit mandate must have been previously declared using the [`addSepaDirectDebitPaymentMandate`](./guide-declare) mutation. 1. **Mandate ID:** You must know the **unique payment mandate ID** of the mandate you want to retrieve. ::: From 01d6763e683c12a8f61ec8e8800cfe7adef1766a Mon Sep 17 00:00:00 2001 From: ntombing Date: Wed, 17 Dec 2025 16:31:15 +0200 Subject: [PATCH 8/9] Update docs/topics/merchants/online/sdd/guide-get-mandate.mdx Co-authored-by: Max B. <17831738+max-koro@users.noreply.github.com> --- docs/topics/merchants/online/sdd/guide-get-mandate.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx index cef592998a..32572808cf 100644 --- a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx +++ b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx @@ -12,7 +12,7 @@ You can retrieve a specific mandate using the **payment mandate ID**. ## API {#api} -Queries are highly customizable. This guide focuses solely on using the `paymentMandate` query to get the mandate URL. +Queries are customizable. This guide focuses solely on using the `paymentMandate` query to get the mandate URL. 1. Call the `paymentMandate` query. 2. Add your payment mandate ID (line 2). Include the `SEPAPaymentDirectDebitMandate` fragment with the fields you need (line 3). From 7550e883d33c78294574c1ba9526f6e41dc1be96 Mon Sep 17 00:00:00 2001 From: ntombing Date: Thu, 18 Dec 2025 15:59:51 +0200 Subject: [PATCH 9/9] Update docs/topics/merchants/online/sdd/guide-get-mandate.mdx Co-authored-by: Max B. <17831738+max-koro@users.noreply.github.com> --- docs/topics/merchants/online/sdd/guide-get-mandate.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx index 32572808cf..1e6f7f2307 100644 --- a/docs/topics/merchants/online/sdd/guide-get-mandate.mdx +++ b/docs/topics/merchants/online/sdd/guide-get-mandate.mdx @@ -2,7 +2,7 @@ title: Get mandate URL --- -After a SEPA Direct Debit (SDD) B2B mandate has been declared, you may need to retrieve the mandate information. +After a SEPA Direct Debit (SDD) mandate has been declared, you may need to retrieve the mandate information. You can retrieve a specific mandate using the **payment mandate ID**. :::tip Prerequisites