You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/topics/merchants/online/sdd/guide-get-mandate.mdx
+9-12Lines changed: 9 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,31 +2,28 @@
2
2
title: Get mandate URL
3
3
---
4
4
5
-
## Get mandate URL
6
-
7
-
After a SEPA Direct Debit (SDD) B2B mandate has been declared, you may need to retrieve the **mandate information**.
8
-
This is particularly useful for making the mandate available to **merchants**, who can then share it with their clients (the debtors).
5
+
After a SEPA Direct Debit (SDD) B2B mandate has been declared, you may need to retrieve the mandate information.
9
6
You can retrieve a specific mandate using the **payment mandate ID**.
10
7
11
8
:::tip Prerequisites
12
-
1.**Mandate declaration:** A SEPA Direct Debit mandate must have been previously **added** using the `addSepaDirectDebitPaymentMandate` mutation.
9
+
1.**Mandate declaration:** A SEPA Direct Debit mandate must have been previously declared using the `addSepaDirectDebitPaymentMandate` mutation.
13
10
1.**Mandate ID:** You must know the **unique payment mandate ID** of the mandate you want to retrieve.
14
11
:::
15
12
16
13
## API {#api}
17
14
18
-
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).
15
+
Queries are highly customizable. This guide focuses solely on using the `paymentMandate` query to get the mandate URL.
19
16
20
-
1. Call the **`paymentMandate`** query.
21
-
2. Check the boxes for **`id`**and **`SEPAPaymentDirectDebitMandate`**.
22
-
3. Under **`SEPAPaymentDirectDebitMandate`**, check the boxes for **`id`**, **`name`** and **`mandateDocumentUrl`**.
17
+
1. Call the `paymentMandate` query.
18
+
2. Check the boxes for `id` (line 2) and `SEPAPaymentDirectDebitMandate` (line 3).
19
+
3. Under `SEPAPaymentDirectDebitMandate`, check the boxes for `id`, `name` and `mandateDocumentUrl` (lines 4-6).
23
20
*`mandateDocumentUrl` allows you to receive a **download URL** in the payload.
24
21
25
22
### Query {#query}
26
23
27
24
<ahref="https://explorer.swan.io/?query=cXVlcnkgR2V0TWFuZGF0ZSB7CiAgcGF5bWVudE1hbmRhdGUoaWQ6ICIkWU9VUl9NQU5EQVRFX0lEIikgewogICAgLi4uIG9uIFNFUEFQYXltZW50RGlyZWN0RGViaXRNYW5kYXRlIHsKICAgICAgaWQKICAgICAgbmFtZQogICAgICBtYW5kYXRlRG9jdW1lbnRVcmwKICAgIH0KICB9Cn0K&tab=api"className="explorer-badge">Open in API Explorer</a>
28
25
29
-
```graphql {4,6-7,11} showLineNumbers
26
+
```graphql {2,3,4-6} showLineNumbers
30
27
queryGetMandate {
31
28
paymentMandate(id: "$YOUR_MANDATE_ID") {
32
29
...onSEPAPaymentDirectDebitMandate {
@@ -40,10 +37,10 @@ query GetMandate {
40
37
41
38
### Payload {#payload}
42
39
43
-
1. The response includes the download URL (line 4), which begins with `bank-details.swan.io`.
40
+
1. The response includes a mandate name (line 5), and the download URL (line 6).
44
41
1. Paste the URL into your browser, then press enter. This triggers the download of your PDF.
0 commit comments