Skip to content

Commit aa3841e

Browse files
committed
Updates to guide
1 parent c3b7e19 commit aa3841e

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

docs/topics/merchants/online/sdd/guide-get-mandate.mdx

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,28 @@
22
title: Get mandate URL
33
---
44

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.
96
You can retrieve a specific mandate using the **payment mandate ID**.
107

118
:::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.
1310
1. **Mandate ID:** You must know the **unique payment mandate ID** of the mandate you want to retrieve.
1411
:::
1512

1613
## API {#api}
1714

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.
1916

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).
2320
* `mandateDocumentUrl` allows you to receive a **download URL** in the payload.
2421

2522
### Query {#query}
2623

2724
<a href="https://explorer.swan.io/?query=cXVlcnkgR2V0TWFuZGF0ZSB7CiAgcGF5bWVudE1hbmRhdGUoaWQ6ICIkWU9VUl9NQU5EQVRFX0lEIikgewogICAgLi4uIG9uIFNFUEFQYXltZW50RGlyZWN0RGViaXRNYW5kYXRlIHsKICAgICAgaWQKICAgICAgbmFtZQogICAgICBtYW5kYXRlRG9jdW1lbnRVcmwKICAgIH0KICB9Cn0K&tab=api" className="explorer-badge">Open in API Explorer</a>
2825

29-
```graphql {4,6-7,11} showLineNumbers
26+
```graphql {2,3,4-6} showLineNumbers
3027
query GetMandate {
3128
paymentMandate(id: "$YOUR_MANDATE_ID") {
3229
... on SEPAPaymentDirectDebitMandate {
@@ -40,10 +37,10 @@ query GetMandate {
4037

4138
### Payload {#payload}
4239

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).
4441
1. Paste the URL into your browser, then press enter. This triggers the download of your PDF.
4542

46-
```json {4} showLineNumbers
43+
```json {5,6} showLineNumbers
4744
{
4845
"data": {
4946
"paymentMandate": {

0 commit comments

Comments
 (0)