Get All Cards Details

View as Markdown
### Get All Credit Cards This endpoint retrieves a list of all credit cards associated with the user. It returns details about each credit card, including identifiers and dates related to the card. #### Request - **Method**: GET - **URL**: `{{host}}/apis/external/creditCards/all` #### Response - **Status Code**: 200 OK - **Content-Type**: application/json #### Response Structure The response contains a JSON object with the following properties: - **creditCardList**: An array of credit card objects, where each object includes: - **id**: Unique identifier for the credit card (integer). - **cardHolderId**: Identifier for the cardholder (string). - **cardHolderName**: Name of the cardholder (string). - **cardNumber**: The credit card number (string). - **cardReference**: Reference for the credit card (string). - **cardType**: Type of the credit card (string). - **issueDate**: Date the card was issued (string). - **statementDate**: Date of the statement (string). - **dueDate**: Due date for payments (string). - **total**: Total number of credit cards available (integer). - **currentPage**: Current page number of the results (integer). - **totalPages**: Total number of pages available for pagination (integer). #### Example Response ``` json { "creditCardList": [ { "id": 5880155, "cardHolderId": "E0001", "cardHolderName": "karanas shrma", "cardNumber": "HDFCMF5555871111", "cardReference": "HDFCMF5555871111", "cardType": "CREDIT", "issueDate": "Jan 1, 2025 10:28:02 AM", "statementDate": "Jan 1, 2025 10:28:02 AM", "dueDate": "Jan 1, 2025 10:28:02 AM" }, { "id": 5880156, "cardHolderId": "E0001", "cardHolderName": "karanas shrma", "cardNumber": "HDFCMF5555871111", "cardReference": "HDFCMF5555871111", "cardType": "CREDIT", "issueDate": "Jan 1, 2025 10:28:02 AM", "statementDate": "Jan 1, 2025 10:28:02 AM", "dueDate": "Jan 1, 2025 10:28:02 AM" }, { "id": 5880157, "cardHolderId": "E0001", "cardHolderName": "karanas shrma", "cardNumber": "HDFCMF5555875555", "cardReference": "HDFCMF5555875555", "cardType": "CREDIT", "issueDate": "Jan 1, 2025 10:28:02 AM", "statementDate": "Jan 1, 2025 10:28:02 AM", "dueDate": "Jan 1, 2025 10:28:02 AM" }, { "id": 5880154, "cardHolderId": "E0001", "cardHolderName": "karanas shrma", "cardNumber": "XXXXXXXXXXXX0003", "cardReference": "Credit Card from Visa feed", "cardType": "CREDIT", "issueDate": "Feb 28, 2025 5:37:06 AM", "statementDate": "Feb 28, 2025 5:37:06 AM", "dueDate": "Feb 28, 2025 5:37:06 AM" } ], "total": 0, "currentPage": 0, "totalPages": 0 } ``` This example illustrates the structure and content of the response received from the API when fetching all credit cards. This endpoint retrieves a list of all credit cards associated with the user. It returns a collection of credit card details in JSON format. #### Request - **Method**: GET - **Endpoint**: `{{host}}/apis/external/creditCards/all` #### Response - **Status Code**: 200 OK - **Content-Type**: application/json #### Response Body The response body contains the following fields: - **creditCardList**: An array of credit card objects, each containing: - **id**: Unique identifier for the credit card. - **cardHolderId**: Identifier for the cardholder. - **cardHolderName**: Name of the cardholder. - **cardNumber**: The credit card number. - **cardReference**: Reference number for the card. - **cardType**: Type of the credit card (e.g., Visa, MasterCard). - **issueDate**: Date when the card was issued. - **statementDate**: Date of the statement. - **dueDate**: Due date for payments. - **total**: Total number of credit cards available. - **currentPage**: The current page number of the results. - **totalPages**: Total number of pages available for pagination. #### Notes - If there are no credit cards associated with the user, the `creditCardList` will be an empty array, and `total`, `currentPage`, and `totalPages` will all be set to zero. - Ensure that the user is authenticated to access this endpoint.

Headers

DICE-APP-IDstringOptional
X-CLIENT-IDstringOptional
X-CLIENT-SECRETstringOptional
statusstringOptional

Response

OK