-
Notifications
You must be signed in to change notification settings - Fork 40
Clarify the OTP flow in Sage Bank Feeds connection flow #1797
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
Changes from all commits
30744f5
1cda5b9
00fe2b3
66289c6
8083fb6
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 |
|---|---|---|
|
|
@@ -48,6 +48,7 @@ To add a call-to-action-link: | |
| 4. Enter the link URL in the **Call-to-action URL** box. | ||
| 5. Click **Save**. | ||
|
|
||
|
|
||
| ## Optional: Add your organization's logo | ||
|
|
||
| You can customize the appearance of the default Codat authentication site by adding your organization's logo. It will appear to the left of the Sage logo. | ||
|
|
@@ -133,6 +134,16 @@ To upload a logo, go to the <a className="external" href="https://app.codat.io/s | |
|
|
||
| Next, make the data connection ID from step two (above) available to the SMB user by, for example, surfacing the ID in your application. They'll need to enter this ID when connecting a bank account to Sage, as described in the next procedure. | ||
|
|
||
| ## Surface the one-time password (OTP) to the user | ||
|
|
||
| In order to authenticate the connection, your user needs to enter a one-time password in their Sage product. Call the OTP endpoint to retrieve the OTP, then display it to the user in your application. | ||
|
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.
|
||
|
|
||
| Let the user know they need to enter it when connecting a source bank account. | ||
|
|
||
| ``` | ||
| GET https://api.codat.io/companies/{{companyId}}/connections/{{dataConnectionId}}/bankFeeds/otp | ||
| ``` | ||
|
|
||
| ## SMB user flow: Connect a source bank account to Sage | ||
|
|
||
| To connect a source bank account to a target bank account in Sage, your SMB user uses the **Connect Bank** functionality in a supported Sage product. The exact steps depend on which Sage product they're using. | ||
|
|
@@ -146,19 +157,18 @@ Alternatively, you can [authenticate users through your own web app](/integratio | |
|
|
||
| 2. They click **Connect Bank** on the account and then select your institution from the list of banks and other financial institutions. | ||
|
|
||
| 3. The default Codat authentication site is loaded in a new browser tab: | ||
|
|
||
|  | ||
| 3. They enter their data connection ID in the **Connection ID** feld and the one-time password in the **One-time password** field, then click **Submit**: | ||
|
|
||
| 4. They enter their data connection ID in the **Connection ID** box, then click **Submit**. | ||
|  | ||
|
|
||
| 5. If the SMB user was authenticated with Codat successfully, a dialog listing the available source bank accounts (created using the `POST / bankFeedAccounts` endpoint) is displayed. For example: | ||
| 4. If the SMB user successfully authenticated with Codat, the flow displays a list of available source bank accounts created using the [Create single source account](/bank-feeds-api#/operations/create-source-account) or [Create source accounts](/bank-feeds-api#/operations/create-batch-source-account) endpoints. | ||
| For example: | ||
|
|
||
|  | ||
|  | ||
|
|
||
| 6. The SMB user selects the bank account they want to connect, then clicks **OK**. | ||
| 7. The SMB user selects the bank account they want to connect, then clicks **OK**. | ||
|
|
||
| 7. The SMB user is redirected to the Sage product from which they started the connection flow. | ||
| 8. The SMB user is redirected to the Sage product from which they started the connection flow. | ||
|
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. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| You can now use the [GET /bankFeedAccounts](/bank-feeds-api#/operations/get-bank-feeds) endpoint to retrieve the source bank accounts. The `status` property of a source bank account must have changed to `connected` before you can begin to write bank transactions from the account. | ||
|
|
||
|
|
||
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.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.