Workflows

Here’s the basic outline of the OAuth aggregation flow.

1. List the institutions and find those that support OAuth.
   In the integrations environment, you must always use mx_bank_oauth.
   
   
2. Create an OAuth member with "is_oauth": true.
   If you’re developing a mobile app, you’ll also need to set "oauth_referral_source": "APP" and "client_redirect_url": "your://custom.redirect/url"; you can set the redirect URL to any string, but we’ll use https://mx.com in this guide.
   
   
3. Load the oauth_window_uri that was returned when you created a member.

• You must open this URI in the device’s default browser.
• The end user will interact with the institution’s OAuth page and decide what data to share with MX.
• If successful, aggregation will automatically begin.

4. Check the member’s status, and keep checking until you see an end state.
   If you see "connection_status": "CONNECTED", "is_aggregating": false and the successfully_aggregated_at field has updated to the current time, the aggregation is complete.
   
   
5. Get the user’s account and transaction data.

Workflow diagrams

Browser

Mobile app