Skip to main content

Manage Banks & Enrollment Only

To allow for enrollments, and adding/removing bank accounts without submitting a deposit or withdrawal, the web component may be invoked with the managebanks mode. This mode should be used in conjunction with API-only deposit and withdrawal operations.

Flow

Step 1: From the operator app/site, call Account Inquiry API to determine if the patron exists.

Step 2: Call the appropriate create session endpoint (simple session is recommended with this feature, but not required).

Step 3: Invoke the web component using managebanks mode. The patron will be enrolled at this time if they don't exist, and then they may manage their bank accounts.

Step 4: After the patron has closed the web component, from the operator’s site, call Account Inquiry API again to refresh the list of patron banks.

Step 5: From the operator app/site, provide a bank selection to the patron, and transaction selection (deposit/withdraw, amount, etc).

Step 6: From the operator app/site, perform an API call to perform the transaction using either Deposit Approval JSON or Withdraw Approval JSON

Step 7: Handle the result of the call, and inform the patron using the operator app/site as needed.

note

The existing patronsession/new and patronsession/existing APIs will still work with this managebanks mode. Simply set the mode on the query string parameter when invoking the web component as previously mentioned.

A callback notification will not be sent from the managebanks mode. To obtain any newly modified banks, call the patron account inquiry API to get updated information