-
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
Conversation
✅ Deploy Preview for incomparable-tiramisu-91a96a ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
docs/topics/merchants/index.mdx
Outdated
| `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 :)
e8850ea
to
6f462a6
Compare
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. | ||
|
||
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?
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.
No, it's not the only one.
To qualify for a merchant profile, the user must:
- Be an account holder for a company account.
- They must be approved as a merchant.
- They're engaging in an activity that involves accepting payments from end users.
Not all company accounts qualify to accept payments. Some only perform transactions and account management actions (e.g., managing beneficiaries), similar to individual accounts. Final approval depends on Swan’s risk review, which includes checks on other qualifications.
docs/topics/merchants/index.mdx
Outdated
|
||
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.
docs/topics/merchants/index.mdx
Outdated
|
||
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?
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 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.
Yes. Yes, we're referring to the partner’s users, our end users. Noted this to discuss, may need to define and adjust throughout the docs. Happy to leave this as is for now.
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
93d70a1
to
8346ad5
Compare
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.
Great stuff! Your writing quality is impeccable, I have no suggestions :)
Quick question in addition to the ones below:
typical implementations of payment links include the ability to add a payment link in an invoice, share it via QR Code, or email or SMS
-> Was this requirement cancelled?
docs/topics/merchants/index.mdx
Outdated
1. Accent color | ||
1. Customer region | ||
|
||
Complete as many information fields as possible to decrease the turnaround time for enabling the merchant profile. |
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.
Recommended information: at least one of
socialNetwork
ormerchantWebsite
, as well ascustomerRegion
,paymentFrequency
.
We should probably callout this specific information makes onboarding faster. I'd make this a tip callout :)
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.
Done ✅
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. |
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’d recommend giving more information about size and format of the logo.
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.
2ec87cb
to
12c9b17
Compare
Hey, Thanks for the review. The recommendation wasn't canceled, it was already addressed in a previous ticket: Cards for merchants overview. I made some missed changes to the Sandbox, Request a merchant profile and Request card payment method pages. Thanks! :) |
Co-authored-by: Max B. <[email protected]>
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.
LGTM
Merchant overview page ready for review. Still need to update the guides.