Explore a full, working code sample of a loan integration with our Application Programming Interface (API). This documentation will outline the basic steps of fetching a list of collections from the policyPay system. With your program set up in our production environment, it will be ready for live testing. When successful testing is completed, real collections can be retrieved.
Once you submit to the API, you can see the accounts in the UI at policypay.io by logging in with your given credentials.
You can see all the available REST methods via our Swagger at rest.policypay.io or uat-rest.policypay.io
User Credentials
Email: ***
Password: ***
Public Key: ***
Secret Key: ***
Swagger API Endpoint Definitions
Once logged in with your given credentials, navigate to /collections /collections/list.
Selecting Try it out will bring up the request body for your API endpoint definitions. Once filled in completely, selecting Execute will run the API.
A response payload will be returned which includes your API endpoints along with a successul 200 code displayed. See Response Codes below for further details.
To fetch a collection list, use page, limit, and search inputs.
| Variable | Type | Required | Notes |
|---|---|---|---|
| page (query) | String | Yes | |
| limit (query) | String | Yes | |
| search (query) | String | Yes |
Postman API Link
An alternate way of using our API is with your given Postman link. The link will take you to your already configured endpoint for you to fill out. In the Body section on Postman, you will find your configured endpoints. Once filled, selecting Send will execute the API call.
Congratulations! You have successfully retrieved your list of collections.
Sample JSON Response
{
"status": "success",
"message": "string",
"collections": [
{
"uniqueNumber": "string",
"uniqueRefType": "string",
"insuredName": "string",
"dueDate": "2023-12-07",
"startDate": "2023-12-07",
"stopDate": "2023-12-07",
"agencyName": "string",
"agentName": "string",
"collectorName": "string",
"collectorAgency": "string",
"status": "string"
}
],
"count": 0,
"fetched": 0,
"skipped": 0
}
Response Codes
| Code | Description |
|---|---|
| 200 | Collections retrieved successfully |
| 400 | Failed to fetch collection |
| 422 | Unprocessable entry |
| 500 | Internal server error |
