​
Getting started

​
Start the flow

​
Receive transactions

​
New transactions

To be notified about new transactions in a merchant account, listen to the NEW_TRANSACTIONS_AVAILABLE webhook. You will receive this event shortly after a user authenticates to a merchant account for the first time and on any subsequent instance where new transactions are created in the merchant account.

Upon receiving the NEW_TRANSACTIONS_AVAILABLE webhook, make a request (or multiple) to Sync Transactions to sync new transactions for a user’s specific merchant account. In the development environment, you will receive 205 new transactions.

​
Updated transactions

Receiving updated transaction information is entirely optional and may not be relevant for your use case.

To be notified about updates to existing transactions, listen to the UPDATED_TRANSACTIONS_AVAILABLE webhook. You will receive this event for a merchant account each time there are existing transactions for which data has changed (e.g. orderStatus: SHIPPED -> orderStatus: DELIVERED).

Upon receiving the UPDATED_TRANSACTIONS_AVAILABLE webhook with an array of transaction IDs, make a request to Get Transaction By Id for each transaction ID, passing the ID received in the webhook as a path parameter.

​
Handle disconnected merchant accounts

If for example a user changes their password to a merchant account, the connection.status in Get Merchant Accounts will be returned as disconnected and you will not receive transaction data for the user’s merchant account until it is reconnected. In this case, you’ll want to display a UX in your app to allow users to reconnect their account. For example, you may choose to display a button that says “Reconnect” or similar.

To unlink a user’s specific merchant account if they request it, make a request to Unlink Merchant Account.