Learn how to seamlessly integrate our APIs into your application.
Property | Type | Description |
---|---|---|
statusCode | number | This is the request status code that lets you know if your request was succesful or not. We recommend that you use this to determine the result of an API call. |
message | string | This is a summary of the response and its status. For instance when trying to retrieve a list of customers, message might read “Transactions fetched successfully”. In the event of an error, the message key will contain a description of the error as with the authorization header situation above. This is the only key that is universal across requests. |
data | object | This contain the results of your request. It can either be an object, or an array depending on the request made. For instance, a request to retrieve a single transaction will return a transaction object in the data key, while the key would be an array of transactions if a list is requested instead. |
Property | Description |
---|---|
totalItems | The total number of items available. This represents the complete count of items across all pages. |
itemCount | The number of items on the current page. This indicates how many items are being returned in the current response. |
itemsPerPage | The maximum number of items per page. This defines the pagination limit set for each page. Default: 100 |
totalPages | The total number of pages available. This is calculated based on the total number of items and the number of items per page. |
currentPage | The current page number. This indicates which page of the pagination is being returned in the current response. Default: 1 |