-
Notifications
You must be signed in to change notification settings - Fork 10
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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 integration@swan.io. | ||
::: | ||
|
||
|
@@ -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,32 @@ 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: **approve the account holder** as a merchant, and **facilitate accepting payments** with Swan. | ||
If a Swan account holder wants to accept payments from customers, they must have at least one merchant profile. | ||
|
||
Merchant profiles can be created at the same time as onboarding. | ||
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. same time as an onboarding? Or simultaneously with onboarding? |
||
Since merchants are considered high risk, profiles should only be created for users who need merchant features. | ||
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. high-risk - what do we mean by "users who need merchant features" - this is unclear since this whole section is about Merchant profiles. |
||
Requesting profiles for all users may lead to unmet expectations. | ||
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. What do we mean by this? will it be rejected? what's the user impact here? |
||
|
||
The merchant profile contains the following information: | ||
|
||
- Business details | ||
- Description of the business activity | ||
- Link to the merchant's website | ||
- Link to the merchant's website or social network | ||
- Projected volumes | ||
- Logo (optional), displayed online and on mandate PDFs | ||
- Payment frequency | ||
- Logo (optional), in `.png` format and less than 1 mb, displayed online and on mandate PDFs | ||
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. Do we mean 1Mb or MB? 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. What's a mandate PDF? |
||
- Accent color | ||
- Customer region | ||
|
||
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. | ||
To speed up enabling your merchant profile, complete as many information fields as possible. | ||
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. Rework this sentence - it's clunky. |
||
|
||
The merchant profile is created with the status `PendingReview`, and is visible right away on your Dashboard. | ||
|
||
|
@@ -94,7 +104,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 the you or the user directly, based on your communication preferences. | ||
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. Swan will contact you or the user directly |
||
|
||
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. | ||
|
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.
This should be in a numbered list.