-
Notifications
You must be signed in to change notification settings - Fork 10
New guide get mandate #504
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
ntombing
merged 9 commits into
main
from
DOC-892/get-a-payment-mandate-for-merchant-payments-sdd
Dec 18, 2025
Merged
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
22b86bd
New guide get mandate
ntombing c4d3a4c
Sidebar update and overview links
ntombing af1dd21
Update sidebars.js
max-koro c3b7e19
Update guide-get-mandate.mdx
max-koro aa3841e
Updates to guide
ntombing 4f16870
Update docs/topics/merchants/online/sdd/guide-get-mandate.mdx
ntombing 5b38787
Update docs/topics/merchants/online/sdd/guide-get-mandate.mdx
ntombing 01d6763
Update docs/topics/merchants/online/sdd/guide-get-mandate.mdx
ntombing 7550e88
Update docs/topics/merchants/online/sdd/guide-get-mandate.mdx
ntombing File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| title: Get mandate URL | ||
| --- | ||
|
|
||
| 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 declared using the `addSepaDirectDebitPaymentMandate` mutation. | ||
ntombing marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 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. | ||
ntombing marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 1. Call the `paymentMandate` query. | ||
| 2. Check the boxes for `id` (line 2) and `SEPAPaymentDirectDebitMandate` (line 3). | ||
ntombing marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 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} | ||
|
|
||
| <a href="https://explorer.swan.io/?query=cXVlcnkgR2V0TWFuZGF0ZSB7CiAgcGF5bWVudE1hbmRhdGUoaWQ6ICIkWU9VUl9NQU5EQVRFX0lEIikgewogICAgLi4uIG9uIFNFUEFQYXltZW50RGlyZWN0RGViaXRNYW5kYXRlIHsKICAgICAgaWQKICAgICAgbmFtZQogICAgICBtYW5kYXRlRG9jdW1lbnRVcmwKICAgIH0KICB9Cn0K&tab=api" className="explorer-badge">Open in API Explorer</a> | ||
|
|
||
| ```graphql {2,3,4-6} showLineNumbers | ||
| query GetMandate { | ||
| paymentMandate(id: "$YOUR_MANDATE_ID") { | ||
| ... on SEPAPaymentDirectDebitMandate { | ||
| id | ||
| name | ||
| mandateDocumentUrl | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Payload {#payload} | ||
|
|
||
| 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 {5,6} showLineNumbers | ||
| { | ||
| "data": { | ||
| "paymentMandate": { | ||
| "id": "$YOUR_MANDATE_ID", | ||
| "name": "B2B/Core SEPA Direct Debit Mandate", | ||
| "mandateDocumentUrl": "$YOUR_MANDATE_URL" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.