31 May 2023 - Release Notes
- New
client/v1/customer/list
Endpoint
Avenu API Release Notes 1.7.9
Overview
The following release notes contain a new endpoint:
client/v1/customer/list
If you have questions regarding the updates described in this document, please contact Avenu’s Support Department by email ([email protected])
What's New?
The following release notes detail the updates we have included in this release.
Client - New Customer List endpoint
GET {prefix}/client/v1/customer/list
We have created a new endpoint that allows Fintech Clients to retrieve a list of their customers. The customer list implements pagination and defaults to 10 customers per page. Optional parameters include Address, City, State, Zip, Country, Citizenship, and Mobile Phone. A detailed list is in the table below.
Example URIs:
/client/v1/customer/list
→ returns all the customers with default sort order and shows the first page
/client/v1/customer/list?page=2
→ returns all the customers with default sort order and shows second page
/client/v1/customer/list?name='smith'
→ returns all the customers with default sort order on the first page matching first or last name ‘smith’
/client/v1/customer/list?accountNumber='12323'
->returns all the customers with default sort order on the first page with accountNumber = ‘12323’
Then endpoint should implement pagination. Default value is 10 per page.
Example Response
{
"pagination": {
"next": "client/v1/list/customers?limit=1&page=2"
},
"customers": [
{
"accountNumber": "",
"firstName": "",
"lastName": "",
"emailAddress": "",
"address": "",
"city": "",
"state": "",
"zipCode": "",
"country": "",
"citizenship": "",
"mobilePhone": "",
"accountStatus": ""
}
]
}
Optional Request Parameters
Parameter | Format | Required | Example |
---|---|---|---|
accountNumber | String | N | ?accountNumber=9876543210 |
firstName | String | N | ?firstName=Mike |
lastName | String | N | ?lastName=Jones |
address | String | N | ?address=565 Main Street |
city | String | N | ?city=Fairfax |
state | String | N | ?state=VA |
zipCode | String | N | ?zipCode=22031 |
country | String | N | ?country=USA |
citizenship | String | N | ?citizenship=USA |
mobilePhone | String | N | ?mobilePhone=123-456-7890 |
Errors
Code | Message |
---|