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.

We recommend using Postman for all of our API routes. Download our Postman collection using the link below: Download Postman Collection. Our respective Production and Sandbox URLs are the following: rest.policypay.io/collections/list or uat-rest.policypay.io/collections/list.

User Credentials

Email: ***

Password: ***

Public Key: ***

Secret Key: ***

URL: /collections/list

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
page (query)	String	Yes
limit (query)	String	Yes
search (query)	String	Yes

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

Get a Collection List

URL: /collections/list