Doc 1371/update merchant documentation for the new onboarding flow #453
Conversation
✅ Deploy Preview for incomparable-tiramisu-91a96a ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
||
| ### Payload {#payload-update} | ||
|
|
||
| The new provided values appear under `requestMerchantProfileUpdate`. They will only be reflected on the merchant profile after the request has been reviewed and approved. |
There was a problem hiding this comment.
Who does this review, and can we indicate how long it may take?
| Subscribe to the `MerchantPaymentMethod.Updated` webhook to know when the status of the payment method changes. | ||
| ::: | ||
|
|
||
| ## Step 1: See which information is missing {#step-1} |
There was a problem hiding this comment.
The other guides usually start with the heading "Guide" - is there a reason this isn't here and we're doing Steps?
|
|
||
| # Providing missing information | ||
|
|
||
| If some information is missing before a review can be finalized, your merchant payment method will have the status `WaitingForInformation`. |
There was a problem hiding this comment.
This is missing what the purpose of this article is i.e. "how to provide missing information."
|
|
||
| 1. Use the `merchantProfile` query. | ||
| 1. Add the `supportingDocumentCollections` field. | ||
| 1. Optionally, use a filter to have only the collections waiting for document. |
There was a problem hiding this comment.
What does this mean? - should it be "Add the supportingdocumentcollections field, or use the waiting for document filter?
| - Payment methods and their statuses. | ||
|
|
||
| ## Query {#query} | ||
| ## Getting general information about the merchant profile {#general-info} |
There was a problem hiding this comment.
We tend not to use ing verb forms in headings - from the Google style guide
|
|
||
| ## Simulate supporting documents {#simulate-documents} | ||
|
|
||
| When `supportingDocumentPurposes` are added to the verification requirements, a supporting documents collection is created on the merchant profile. |
There was a problem hiding this comment.
| When `supportingDocumentPurposes` are added to the verification requirements, a supporting documents collection is created on the merchant profile. | |
| When `supportingDocumentPurposes` are added to the verification requirements, a supporting documents collection field is added to the merchant profile. |
There was a problem hiding this comment.
Thanks for the suggestion! However, I'm going to keep the current wording because it's more technically accurate.
The supportingDocumentCollections field always exists on the merchant profile object in the API. When documents are required, a new collection object is created within that field (not the field itself being added).
The current text avoids this technical confusion by simply stating "the merchant profile has a supporting documents collection", which is accurate and easier to understand imho :)
There was a problem hiding this comment.
Do you mean supporting documents collection ID?
There was a problem hiding this comment.
No, the ID is a parameter for the collection :)
Co-authored-by: racene-swan <[email protected]>
|
|
||
| When your merchant payment method has the status `WaitingForInformation`, you need to provide missing verification requirements and supporting documents before the review can be finalized. | ||
|
|
||
| This guide shows you how to identify what's missing and provide it. |
| 1. See which information is missing by checking the verification requirements. | ||
| 1. Check if your project requires additional information. | ||
| 1. Update the merchant profile with the missing information. | ||
| 1. Get the supporting documents collection. |
There was a problem hiding this comment.
Get the supporting documents collection ID - matches with Step 4.
|
|
||
| ## Simulate supporting documents {#simulate-documents} | ||
|
|
||
| When `supportingDocumentPurposes` are added to the verification requirements, a supporting documents collection is created on the merchant profile. |
There was a problem hiding this comment.
Do you mean supporting documents collection ID?
|
|
||
| ## Simulate supporting documents {#simulate-documents} | ||
|
|
||
| When `supportingDocumentPurposes` are added to the verification requirements, a supporting documents collection is created on the merchant profile. |
There was a problem hiding this comment.
No, the ID is a parameter for the collection :)
2 participants
No description provided.