Partner Program

View Details for a Specific Program

A user can view the program name and program type of a specific program, as long as the user has the program ID. To view these details, a user can initiate a GET request directed to the following endpoint:

https://cubi-sandbox-api.customersbank.com/consumerlending/v1/program/{id}

This request requires the additional data to be included in the path of the request.

Path Parameter Data Element Details:

Name	Type	Description
id	string	requiredFormat - uuid. Program id to retrieve

Example Request:

curl --request GET \
     --url https://cubi-sandbox-api.customersbank.com/consumerlending/v1/program/a3cf82e1-14ff-477a-9459-b1bf010a1b8e \
     --header 'accept: application/json'

A successful request will generate a response of 200 - Ok.

Example Response:

{
    "id": "a3cf82e1-14ff-477a-9459-b1bf010a1b8e",
    "name": "HIL",
    "programType": "HomeImprovement"
}

Response Data Element Details:

Name	Type	Description
id	string	The id of the Program
name	string \| null	The name of the Program
programType	string	Options are: `Other` `HomeImprovement`

Error Handling:

Common errors will include:
400 – Bad Request
401 – Unauthorized
403 - Forbidden
404 – Not Found
422 – Unprocessable Content
500 – Internal Server Error

For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.

View Details for All Programs (with pagination)

Similar to the above request, a user has the ability to view the same level of details for all of their programs. This endpoint includes pagination which allows a user to request a subset of applications. To view these details, a user can initiate a GET request directed to the following endpoint:

https://cubi-sandbox-api.customersbank.com/consumerlending/v1/program

This request requires the additional data to be included in the query of the request.

Query Parameter Data Element Details:

Name	Type	Description
paginateResults	boolean	indicates whether the request should be paginated
page	int32	indicates the page to return
perPage	int32	indicates how many items are on a page
sortOn	string	indicates the attribute by which the data is sorted
sortAscending	string	indicates if the data is sorted in ascending or descending order

Example Request:

curl --request GET \
     --url 'https://cubi-sandbox-api.customersbank.com/consumerlending/v1/program?paginateResults=true&page=1&perPage=100' \
     --header 'accept: application/json'

A successful request will generate a response of 200 - Ok.

Example Response:

{
    "pageSize": 100,
    "pageOffset": 0,
    "totalPages": 1,
    "totalItemCount": 2,
    "items": [
        {
            "id": "a3cf82e1-14ff-477a-9459-b1bf010a1b8e",
            "name": "HIL",
            "programType": "HomeImprovement"
        },
        {
            "id": "218f0b73-1efb-4eab-b4bd-b1c500de9839",
            "name": "Test Program HIL22",
            "programType": "HomeImprovement"
        }
    ]
}

Response Data Element Details:

Name	Type	Description
pageSize	int32	Number of items displayed on a page
pageOffset	int32	Offset index indicating starting point for page items
totalPages	int32	Total number of pages
totalItemCount	int32	Total count of items across all pages
items	array of objects	The object contains the following data:
> id	string	The id of the Program
> name	string \| null	The name of the Program
> programType	string	Options are: `Other` `HomeImprovement`

Error Handling:

Common errors will include:
400 – Bad Request
401 – Unauthorized
403 - Forbidden
404 – Not Found
422 – Unprocessable Content
500 – Internal Server Error

For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.

View Details for All Programs (without pagination)

Similar to the above request, a user has the ability to view the same level of details for all of their programs. This endpoint does not allow for pagination and provides a complete list of applications for all of time. To view these details, a user can initiate a GET request directed to the following endpoint:

https://cubi-sandbox-api.customersbank.com/consumerlending/v1/program/download

This request requires the additional data to be included in the query of the request.

Query Parameter Data Element Details:

Name	Type	Description
paginateResults	boolean	indicates whether the request should be paginated
page	int32	indicates the page to return
perPage	int32	indicates how many items are on a page
sortOn	string	indicates the attribute by which the data is sorted
sortAscending	string	indicates if the data is sorted in ascending or descending order

Example Request:

curl --request GET \
     --url 'https://cubi-sandbox-api.customersbank.com/consumerlending/v1/program/download?paginateResults=true&page=1&perPage=100' \
     --header 'accept: application/json'

A successful request will generate a response of 200 - Ok.

Example Response:

{
    "pageSize": 100,
    "pageOffset": 0,
    "totalPages": 1,
    "totalItemCount": 2,
    "items": [
        {
            "id": "a3cf82e1-14ff-477a-9459-b1bf010a1b8e",
            "name": "HIL",
            "programType": "HomeImprovement"
        },
        {
            "id": "218f0b73-1efb-4eab-b4bd-b1c500de9839",
            "name": "Test Program HIL22",
            "programType": "HomeImprovement"
        }
    ]
}

Response Data Element Details:

Name	Type	Description
id	string	The id of the Program
name	string \| null	The name of the Program
programType	string	Options are: `Other` `HomeImprovement`

Error Handling:

Common errors will include:
400 – Bad Request
401 – Unauthorized
403 - Forbidden
404 – Not Found
422 – Unprocessable Content
500 – Internal Server Error

For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.