Get application data for all applications created using the authenticated client key. Results are returned in descending order of the application’s creation timestamp. Users can optionally pass query parameters to assist when navigating the results. For example, if a user has created 30 applications and wishes to view applications 21 to 30, set pageSize to 10 and pageNumber to 3.
The following is an example of a URL with the pageNumber, pageSize, and findBy query parameters:
https://enrollment-api.paymentshub.com/enroll/search?pageNumber=3&pageSize=10&findBy=byAgent:12345,submission:open
Merchant Boarding API
Get Application Data
get /enroll/search
Parameters
pageNumber
integer
Default:
1
Example:
pageNumber=3
Loading...
pageSize
integer
Default:
100
Example:
pageSize=10
Loading...
findBy
string
Example:
findBy=byAgent:12345,submission:open
Loading...
Example Response
200 Successful search results with non-empty data result.
400 Bad Request response for JSON search complete application.
403 Forbidden response.
500 Internal Server Error response.
Get List of Document Types
get /enroll/document/type/list
This endpoint is used to retrieve a list of all available document types that can be attached to an application.
Example Response
200 Returns list of available document types
Get Application Plan Details by Agent
get /enroll/plan/list-all-by-agent/{agentId}
List all application plans and their details available to an agent by agent ID.
Parameters
agentId required
integer
Example:
12345
Loading...
Example Response
200 Return list of all application plans and their details.
400 Bad request error response
403 Invalid agent client affiliation response
Get Agent Groups by Agent ID
get /enroll/agent/{agentId}/group/list
Get a list of all agent groups by agent ID.
Parameters
agentId required
integer
Example:
12345
Loading...
Example Response
200 Returns a list of all agent group related details.
403 Invalid agent client affiliation response.
422 Unprocessable entity error response.
500 Internal server error response.
Get List of Merchant Category Codes
get /enroll/mcc/list
Get a list of all Merchant Category Codes with details.
Example Response
200 Returns list of all Merchant Category Codes and details.
404 Unable to retrieve merchant category codes list and details.
Get Bank Details
get /enroll/bank/details/aba-routing/{abaRouting}
Get bank related details by ABA routing number.
Parameters
abaRouting required
string^\d{9}$9 to 9 characters
Example:
00000001
Loading...
Example Response
200 Return bank details by ABA routing number
401 Unauthorized response - Need authorized permission to access the resource
422 Unprocessable entity error response