### Pagination Example Source: https://developers.maverickpayments.com/index_62ccb37c-8dd2-41f3-b1a4-bdd4e4adeb5c This endpoint demonstrates how to retrieve paginated results, specifically fetching 10 items per page. ```APIDOC ## GET / ### Description Retrieves a list of resources with pagination controls. ### Method GET ### Endpoint `https://example.maverickpayments.com/` ### Query Parameters - **page** (Integer) - Optional - The page number to retrieve. - **per-page** (Integer) - Optional - The number of results to return per page. Defaults to 10. ### Request Example ```bash curl --location 'https://example.maverickpayments.com/?page=1&per-page=10' ``` ### Response #### Success Response (200) This endpoint does not return a response body. #### Response Example No response body ``` -------------------------------- ### API Authentication Example (cURL) Source: https://developers.maverickpayments.com/index Demonstrates how to authenticate API requests using a Bearer Token with cURL. This is essential for accessing protected resources. Ensure your token is kept confidential. ```cURL curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.maverickpayments.com/v1/resource ``` -------------------------------- ### API Response Structure Example (JSON) Source: https://developers.maverickpayments.com/index Shows the standard response format for successful API requests. Responses are divided into 'items' for results, '_meta' for pagination and count information, and '_links' for navigation. ```json { "items": [ // Results goes here ], "_links": { "self": { "href": "/path?page=1&per-page=10" }, "next": { "href": "/path?page=2&per-page=10" }, "last": { "href": "/path?page=5&per-page=10" } }, "_meta": { "totalCount": 50, "pageCount": 5, "currentPage": 1, "perPage": 10 } } ``` -------------------------------- ### Error Response Example (JSON) Source: https://developers.maverickpayments.com/index Illustrates the structure of an error response from the Maverick Payments API. Errors include a name, message, code, and status for clear identification of issues. ```json { "name":"Unprocessable entity", "message":"Amount cannot be blank.", "code":422, "status":422 } ``` -------------------------------- ### Sandbox Payment Gateway Welcome Message (JSON) Source: https://developers.maverickpayments.com/index_62ccb37c-8dd2-41f3-b1a4-bdd4e4adeb5c This JSON response is what you can expect when successfully connecting to the Maverick Payments sandbox gateway. It provides a confirmation message and directs users to the API documentation for further details. ```json { "message": "Welcome to Payment Gateway, please check the API Documentation for more information." } ``` -------------------------------- ### Access Sandbox Payment Gateway (cURL) Source: https://developers.maverickpayments.com/index_62ccb37c-8dd2-41f3-b1a4-bdd4e4adeb5c This cURL command shows how to connect to the Maverick Payments sandbox environment for testing purposes. It targets the sandbox gateway URL and does not require specific parameters for initial access. ```cURL curl --location 'https://sandbox-gateway.maverickpayments.com/' ``` -------------------------------- ### Fetch 10 Results Per Page (cURL) Source: https://developers.maverickpayments.com/index_62ccb37c-8dd2-41f3-b1a4-bdd4e4adeb5c This cURL command demonstrates how to fetch a specific number of results per page from the Maverick Payments API. It utilizes query parameters 'page' and 'per-page' for pagination. Ensure you replace '' with the actual API endpoint path. ```cURL curl --location 'https://example.maverickpayments.com/?page=1&per-page=10' ``` -------------------------------- ### Response Structure Source: https://developers.maverickpayments.com/index API responses are divided into 'items', '_meta', and '_links' sections. 'items' contains the results, '_meta' contains pagination info, and '_links' contains navigation URLs. ```APIDOC ## Responses ### Description Our response will be divided into 3 sections: `items` - contains the actual result of your request, `_meta` - contains meta information of your request like total results, number of pages, etc., `_links` - contains links to the next page, last page, etc. ### Response Example (Success) ```json { "items": [ // Results goes here ], "_links": { "self": { "href": "/path?page=1&per-page=10" }, "next": { "href": "/path?page=2&per-page=10" }, "last": { "href": "/path?page=5&per-page=10" } }, "_meta": { "totalCount": 50, "pageCount": 5, "currentPage": 1, "perPage": 10 } } ``` ``` -------------------------------- ### Sandbox Payment Gateway Source: https://developers.maverickpayments.com/index_62ccb37c-8dd2-41f3-b1a4-bdd4e4adeb5c The sandbox endpoint is available for testing purposes, allowing developers to interact with the payment gateway in a safe environment. ```APIDOC ## GET / ### Description Welcome message for the Sandbox Payment Gateway. Use this endpoint for testing purposes. ### Method GET ### Endpoint `https://sandbox-gateway.maverickpayments.com/` ### Request Example ```bash curl --location 'https://sandbox-gateway.maverickpayments.com/' ``` ### Response #### Success Response (200) - **message** (String) - A welcome message indicating successful connection to the sandbox gateway. #### Response Example ```json { "message": "Welcome to Payment Gateway, please check the API Documentation for more information." } ``` ``` -------------------------------- ### Filters Source: https://developers.maverickpayments.com/index Filters can be used to refine search results. Supported operators include lt, gt, lte, gte, eq, neq, in, nin, like, or, and, not. Use 'NULL' for empty values. ```APIDOC ## Filters ### Description Filters will help you find what you search. Only fields marked with `Filterable` can be used for filtering the results. ### Parameters | Parameter | Description | |---|---| | lt | Stands for the less-than sign < | | gt | Stands for the greater-than sign > | | lte | Stands for the less-than or equals sign <= | | gte | Stands for the greater-than or equals sign >= | | eq | Stands for the equals sign = | | neq | Stands for the not equals sign != | | in | IN | | nin | NOT IN | | like | LIKE | | or | OR | | and | AND | | not | Exclude specified values | Use `NULL` as a value if you want to select empty values. ``` -------------------------------- ### Error Handling Source: https://developers.maverickpayments.com/index The API uses standard HTTP response codes to indicate success or failure. Error responses include 'name', 'message', 'code', and 'status' fields. ```APIDOC ## Errors ### Description We use conventional HTTP response codes to indicate the success or failure of an API request. The `2XX` range indicates success. The `4XX` range indicates an error that failed given the information provided (e.g., a required parameter was omitted, etc.). The `5XX` range indicates an error with our servers (these are rare). In addition, `name`, `message`, `code`, and `status` will be applied to the error response. ### Response Example (Error) ```json { "name":"Unprocessable entity", "message":"Amount cannot be blank.", "code":422, "status":422 } ``` ``` -------------------------------- ### Authentication Source: https://developers.maverickpayments.com/index Maverick Payments API uses Bearer Authentication. All requests must be made over HTTPS and include an Access Token in the Authorization header. ```APIDOC ## Bearer Authentication ### Description Our API uses **Access Token** to authenticate requests. You can view and manage your **Access Token** in the Dashboard. The method we use for authentication is Bearer Authentication. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. > **Warning** `Don't share your Access Token with anybody.` ### Method All HTTP methods (GET, POST, PUT, DELETE, etc.) ### Endpoint All API endpoints ### Parameters #### Headers - **Authorization** (string) - Required - `Bearer YOUR_ACCESS_TOKEN` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.