-
Notifications
You must be signed in to change notification settings - Fork 9
DOC-1024 Merchant doc updates #316
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
Open
ntombing
wants to merge
6
commits into
main
Choose a base branch
from
DOC-1024/merchant-doc-updates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+73
−34
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d984aaf
DOC-1024 Merchant doc updates
ntombing 9473aa0
fixup! DOC-1024 Merchant doc updates
ntombing 760ddf0
fixup! DOC-1024 Merchant doc updates
ntombing e65ce28
fixup! DOC-1024 Merchant doc updates
ntombing 12c9b17
fixup! DOC-1024 Merchant doc updates
ntombing 53d2a72
fixup! DOC-1024 Merchant doc updates
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 | ||||
---|---|---|---|---|---|---|
|
@@ -10,10 +10,13 @@ import MerchantsDefinition from '../definitions/_merchants.mdx'; | |||||
|
||||||
## Overview {#overview} | ||||||
|
||||||
Merchants are users who want to accept payments by card, SEPA Direct Debit, Internal Direct Debit, or French checks, either directly from a payment link or an invoice. | ||||||
This includes contractors, healthcare professionals, artisans, and business owners, among others. | ||||||
|
||||||
With a merchant profile and at least one active merchant payment method, you can help your merchants accept payments with Swan. | ||||||
|
||||||
:::info Pending review | ||||||
Before accepting payments, you and your merchant need to complete a risk review. | ||||||
Before accepting payments, you need to complete a risk review. | ||||||
To get started, contact your dedicated Technical Account Manager, or send an email to [email protected]. | ||||||
::: | ||||||
|
||||||
|
@@ -26,7 +29,8 @@ You might be contacted for more information before Swan accepts or rejects the r | |||||
|
||||||
To manage potential risk, if suspicious activity is detected, Swan can **change the status** of both **profiles and payment methods** to `Suspended` or `Rejected`. | ||||||
Swan can also reinstate a profile or payment method by changing the status to `Enabled`. | ||||||
Finally, if Swan assigns the status `Rejected` to a profile or payment method, the decision is final and can't be reversed. | ||||||
Finally, if Swan assigns the status `Rejected` to a profile or payment method, the decision is final and can't be reversed. | ||||||
The user must create a new request, which Swan will review as a separate submission. | ||||||
|
||||||
### Webhooks {#webhooks} | ||||||
|
||||||
|
@@ -60,26 +64,39 @@ flowchart LR | |||||
| Profile status | Explanation | | ||||||
|---|---| | ||||||
| `PendingReview` | Profile or payment method request or update was submitted and is pending a review by Swan.<br /><br />**Next steps**: <ul><li>If the request or update doesn't meet requirements or is deemed risky by Swan, the status moves directly to `Rejected`.</li><li>Otherwise, the status moves to `Enabled`.</li></ul> | | ||||||
| `Enabled` | Profile or payment method is active.<br /><br /><ul><li>Use `Enabled` merchant profiles to request payment methods and accept payments with activated payment methods.</li><li>Use `Enabled` payment methods to accept payments.</li><li>Updates to profiles and payment methods can only occur when they have the status `Enabled`.</li></ul> | | ||||||
| `Enabled` | Profile or payment method is active.<br /><br /><ul><li>Use `PendingReview` merchant profiles to request payment methods and accept payments with activated payment methods.</li><li>Use `Enabled` payment methods to accept payments.</li><li>Updates to profiles and payment methods can only occur when they have the status `Enabled`.</li></ul> | | ||||||
| `Suspended` | Status **assigned by Swan** when the merchant's use of their profile or payment method needs to be reviewed. The status can't return to `Enabled` without a review. | | ||||||
| `Rejected` | Final status **assigned by Swan** when Swan decides the risk of this profile or the risk of this payment method for the associated merchant is too high, or for some other risk-related reason. | | ||||||
| `Disabled` | Final status **set by you** using the `requestMerchantPaymentMethods` mutation. | | ||||||
|
||||||
## Merchant profiles {#profiles} | ||||||
|
||||||
A **merchant profile** is a collection of business, risk, and support information that fulfills two primary requirements: **approve the account holder** as a merchant, and **facilitate accepting payments** with Swan. | ||||||
A **merchant profile** is a collection of business, risk, and support information that fulfills two primary requirements: | ||||||
|
||||||
1. **Approve the account holder** as a merchant. | ||||||
1. **Facilitate accepting payments** with Swan. | ||||||
|
||||||
If a Swan account holder wants to accept payments from customers, they must have at least one merchant profile. | ||||||
|
||||||
The merchant profile contains the following information: | ||||||
Your users can create merchant profiles during onboarding, but only if you've requested the feature for them. | ||||||
Since merchants are considered high risk, merchant profiles should only be requested for users who qualify and will accept payments. | ||||||
Requesting merchant profiles for users that don't qualify may create false expectations about available features. | ||||||
|
||||||
- Business details | ||||||
- Description of the business activity | ||||||
- Link to the merchant's website | ||||||
- Projected volumes | ||||||
- Logo (optional), displayed online and on mandate PDFs | ||||||
- Accent color | ||||||
A merchant profile contains the following information: | ||||||
|
||||||
A merchant profile is required of all Swan account holders wanting to accept payments from customers. | ||||||
If you want to accept payments from customers, you must have at least one merchant profile. | ||||||
1. Business details | ||||||
1. Description of the business activity | ||||||
1. Link to the merchant's website or social network | ||||||
1. Projected volumes | ||||||
1. Payment frequency | ||||||
1. Logo (optional), in `.png` format and less than 1 MB. It's shown online and on the PDF of the payment mandate. | ||||||
1. Accent color | ||||||
1. Customer region | ||||||
|
||||||
:::tip | ||||||
To speed up **merchant profile enablement**, complete as many input fields as possible. | ||||||
Providing your `customerRegion`, `paymentFrequency`, and at least one `socialNetwork` or `merchantWebsite` can reduce turnaround time. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
::: | ||||||
|
||||||
The merchant profile is created with the status `PendingReview`, and is visible right away on your Dashboard. | ||||||
|
||||||
|
@@ -94,7 +111,11 @@ Updating a merchant profile produces the following events: | |||||
1. The [**merchant profile status**](#statuses) doesn't change, remaining `Enabled`. The merchant continues to use their merchant profile with the existing information. | ||||||
1. The **update status** is `PendingReview`. Swan reviews the new information to ensure it meets requirements. | ||||||
1. After Swan reviews and validates the update request, the update status changes to `Enabled` and the update is published to the merchant profile. | ||||||
1. If Swan rejects the update request, the merchant profile remains `Enabled`, but with the existing information. The update isn't published. | ||||||
1. If Swan rejects the update request, the merchant profile remains `Enabled` by default, unless Swan decides otherwise. | ||||||
The merchant profile status doesn't change. | ||||||
|
||||||
When a merchant payment method is requested, Swan may ask for additional information even if the merchant profile is already `Enabled`. | ||||||
Swan will contact you or your user directly, based on your communication preferences. | ||||||
|
||||||
If you requested an update and your update status is `PendingReview`, but you need to **make another change**, submit a new update request. | ||||||
Swan reviews both requests, but only the most recent is made public. | ||||||
|
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
:::info Webhook notification | ||
Go to your **Dashboard** > **Developers** > **Webhooks** to subscribe to the `MerchantPaymentMethod` [webhook](../../../developers/using-api/webhooks.mdx) and receive a notification when the [status](../index.mdx#statuses) of your request changes. | ||
You'll be notified when changes are made to the rolling reserve and payment amount limit. | ||
You'll also be notified when changes are made to the rolling reserve and payment amount limit. | ||
::: |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did they forget to tell you about the size or cancel the min/max pixels size requirement? I see nothing else in Notion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was previously "Logo (optional), displayed online and on mandate PDFs".
I updated it to "less than 1 MB" - no other sizing requirements were shared. The min/max pixels size are not necessary to publish this. We can update the doc when these are defined.