API – Get Customer Bank Account Information

Introduction

To retrieve customer bank account information through the API, you will need to send a GET request to the /Loans() endpoint. You can expand the regular loan endpoint to include the bank account information with the $expand token. This URL is unique to each loan because it includes their individual loan ID. This example endpoint is for a loan ID of 2:

GET  https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(id=2)?$expand=Customers/PaymentAccounts/CheckingAccount

More information on that $expand token

The "$expand" expression is an example of an endpoint parameter. These are used to filter the results you receive from endpoint requests; or, like in this instance, they can also expand upon endpoint requests. If you would like to learn more about endpoint parameters, check out our API - Paginating Results article.

The StackBlitz example below will demonstrate how this works.

StackBlitz Example

Many of our articles use StackBlitz examples like this. These examples are like a window into a REST client right here in your browser. The window is divided into two sides. Developers can use info in the editor on the left side when configuring your API integration, and the right side shows a preview of a REST client. Click 'Preview' on the bottom, and you'll only see the REST client.

The entire request is set up and connected to a demo API tenant in LMS. Just scroll down and click 'send' and you should get a 200 response. If you want to get some practice with error codes, try editing the endpoint, headers, method and payload to see what responses you get.


How did we do?


Powered by HelpDocs (opens in a new tab)