-
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for incomparable-tiramisu-91a96a ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| `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. |
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.
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.
Hey this is still not in a numbered list? i.e.
A merchant profile is a collection of business, risk, and support information that fulfills two primary requirements:
- Approve the account holder as a merchant.
- Facilitate accepting payments with Swan.
docs/topics/merchants/index.mdx
Outdated
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 comment
The reason will be displayed to describe this comment to others. Learn more.
same time as an onboarding? Or simultaneously with onboarding?
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.
When onboarding is Ongoing Invalid
or Valid
but not yet Finalized
. As soon as they've filled out the form, they're able to see the merchant profile request in their banking app (if the partner has requested the feature for them).
docs/topics/merchants/index.mdx
Outdated
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. | ||
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 comment
The 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.
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 is just a warning to ensure merchant features are only given to users who genuinely need them. Technically, partners can create merchant profiles for all users with company accounts, but this risks exposing the feature to users who aren't merchants and don't accept payments - which may cause problems later on.
docs/topics/merchants/index.mdx
Outdated
|
||
Merchant profiles can be created at the same time as onboarding. | ||
Since merchants are considered high risk, profiles should only be created for users who need merchant features. | ||
Requesting profiles for all users may lead to unmet expectations. |
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.
What do we mean by this? will it be rejected? what's the user impact here?
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.
I've explained this in the previous comment.
docs/topics/merchants/index.mdx
Outdated
- 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 comment
The 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 comment
The reason will be displayed to describe this comment to others. Learn more.
What's a mandate PDF?
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.
We mean 1 MB.
A PDF of a payment mandate.
docs/topics/merchants/index.mdx
Outdated
|
||
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 comment
The reason will be displayed to describe this comment to others. Learn more.
Rework this sentence - it's clunky.
docs/topics/merchants/index.mdx
Outdated
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 comment
The reason will be displayed to describe this comment to others. Learn more.
Swan will contact you or the user directly
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.
Left comments directly here :)
7f26e0e
to
43cb24b
Compare
e8850ea
to
6f462a6
Compare
If a Swan account holder wants to accept payments from customers, they must have at least one merchant profile. | ||
|
||
Users can create merchant profiles during onboarding, but only if you've requested the feature for them. | ||
Since merchants are considered high risk, request merchant profiles only for users who qualify and will accept payments. |
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.
Since merchants are considered high-risk, merchant profiles should only be requested for users who qualify and will accept payments.
What are the other qualifications? Is the only qualification that they accept payments?
|
||
Users can create merchant profiles during onboarding, but only if you've requested the feature for them. | ||
Since merchants are considered high risk, request merchant profiles only for users who qualify and will accept payments. | ||
Requesting merchant profiles for ineligible users may create false expectations about available features. |
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.
We use the term qualify above, and here we use eligible - pick one term and use it consistently.
|
||
Users can create merchant profiles during onboarding, but only if you've requested the feature for them. | ||
Since merchants are considered high risk, request merchant profiles only for users who qualify and will accept payments. | ||
Requesting merchant profiles for ineligible users may create false expectations about available features. | ||
|
||
The merchant profile contains the following information: |
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.
A merchant profile?
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 the user directly, based on your communication preferences. |
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.
user as in end user?
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.
A couple more changes
Merchant overview page ready for review. Still need to update the guides.