You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/bank-feeds/sage-bank-feeds/sage-bank-feeds-setup.md
+18-8Lines changed: 18 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,6 +48,7 @@ To add a call-to-action-link:
48
48
4. Enter the link URL in the **Call-to-action URL** box.
49
49
5. Click **Save**.
50
50
51
+
51
52
## Optional: Add your organization's logo
52
53
53
54
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
133
134
134
135
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.
135
136
137
+
## Surface the one-time password (OTP) to the user
138
+
139
+
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.
140
+
141
+
Let the user know they need to enter it when connecting a source bank account.
142
+
143
+
```
144
+
GET https://api.codat.io/companies/{{companyId}}/connections/{{dataConnectionId}}/bankFeeds/otp
145
+
```
146
+
136
147
## SMB user flow: Connect a source bank account to Sage
137
148
138
149
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
146
157
147
158
2. They click **Connect Bank** on the account and then select your institution from the list of banks and other financial institutions.
148
159
149
-
3. The default Codat authentication site is loaded in a new browser tab:
150
-
151
-

160
+
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**:
152
161
153
-
4. They enter their data connection ID in the **Connection ID** box, then click **Submit**.
162
+

154
163
155
-
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:
164
+
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.
165
+
For example:
156
166
157
-

167
+

158
168
159
-
6. The SMB user selects the bank account they want to connect, then clicks **OK**.
169
+
7. The SMB user selects the bank account they want to connect, then clicks **OK**.
160
170
161
-
7. The SMB user is redirected to the Sage product from which they started the connection flow.
171
+
8. The SMB user is redirected to the Sage product from which they started the connection flow.
162
172
163
173
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.
0 commit comments