Get Credit Card Details

View as Markdown
### Endpoint Description This endpoint retrieves the details of a specific credit card identified by its unique ID. The request is made via an HTTP GET method, and it returns comprehensive information about the credit card, including details about the cardholder and the card's financial limits. ### Request - **Method:** GET - **URL:** `{{host}}/apis/external/creditCards/{cardId}/details` - **Path Parameter:** - `cardId` (integer): The unique identifier for the credit card whose details are being requested. ### Response Upon a successful request, the API returns a JSON object with the following structure: ``` json { "id": 5880154, "cardHolder": { "empId": 841676, "code": "E0001", "name": "karanas shrma", "email": "testuser1@yopmail.com", "departmentId": 38362, "officeId": 74549, "currency": "INR" }, "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", "cardStatus": "ACTIVE", "initialLimit": 20000.0, "actualLimit": 20000.0, "availableLimit": 0.0, "data": { "expiredOn": "null", "cardType": "Visa First Corporate Employee Card - Primary" } } ``` ### Response Fields - `id` (integer): The unique identifier of the credit card. - `cardHolder` (object): Information about the cardholder, including: - `empId` (integer): Employee ID of the cardholder. - `code` (string): Code associated with the cardholder. - `name` (string): Name of the cardholder. - `email` (string): Email address of the cardholder. - `departmentId` (integer): ID of the department the cardholder belongs to. - `officeId` (integer): ID of the office where the cardholder works. - `currency` (string): Currency used for the card. - `cardNumber` (string): The credit card number. - `cardReference` (string): Reference number for the card. - `cardType` (string): Type of the credit card. - `issueDate` (string): Date when the card was issued. - `statementDate` (string): Date of the statement. - `dueDate` (string): Due date for payment. - `cardStatus` (string): Current status of the card. - `initialLimit` (integer): Initial credit limit set for the card. - `actualLimit` (integer): Current credit limit on the card. - `availableLimit` (integer): Available credit limit for transactions. - `data` (object): Additional card data, including: - `expiredOn` (string): Expiration date of the card. - `cardType` (string): Type of card related data. ### Status Codes - **200 OK**: The request was successful, and the credit card details are returned in the response. This endpoint retrieves the details of a specific credit card associated with a given identifier. The request is made using an HTTP GET method, and it returns a comprehensive JSON response containing various attributes related to the credit card. ### Request - **Method**: GET - **URL**: `{{host}}/apis/external/creditCards/{id}/details` - **Path Parameter**: - `id` (integer): The unique identifier of the credit card whose details are being requested. ### Response Upon a successful request (HTTP Status 200), the response will be in JSON format and includes the following fields: - **id** (integer): The unique identifier of the credit card. - **cardHolder** (object): Contains information about the cardholder. - **empId** (integer): Employee ID of the cardholder. - **code** (string): Code associated with the cardholder. - **name** (string): Name of the cardholder. - **email** (string): Email address of the cardholder. - **departmentId** (integer): ID of the department associated with the cardholder. - **officeId** (integer): ID of the office associated with the cardholder. - **currency** (string): Currency used for the card. - **cardNumber** (string): The number of the credit card. - **cardReference** (string): Reference number for the card. - **cardType** (string): Type of the credit card. - **issueDate** (string): Date when the card was issued. - **statementDate** (string): Date of the statement. - **dueDate** (string): Due date for payments. - **cardStatus** (string): Current status of the card. - **initialLimit** (number): The initial credit limit assigned to the card. - **actualLimit** (number): The current credit limit of the card. - **availableLimit** (number): The available credit limit for transactions. - **data** (object): Additional data related to the credit card. - **expiredOn** (string): Expiration date of the card. - **cardType** (string): Type of the card as per additional data. ### Notes - Ensure that the `id` parameter is correctly specified in the request URL to retrieve the appropriate credit card details. - The response provides detailed information about both the cardholder and the credit card itself, which can be useful for various applications, including account management and financial tracking. **Method:** GET **Endpoint:** `{{host}}/apis/external/creditCards/{cardId}/details` This endpoint retrieves the details of a specific credit card identified by the `cardId`. The request must include the `cardId` as part of the URL path. #### Request Parameters: - **Path Parameter:** - `cardId` (string): The unique identifier for the credit card whose details are being requested. #### Example Request Body: The last call to this endpoint used the following payload: #### Expected Response: Upon a successful request, the API will return a response with a status code of `200` and a content type of `application/json`. The response body will contain the following structure: #### Response Fields: - `id`: The unique identifier for the credit card. - `cardHolder`: An object containing details about the cardholder, including their ID, name, email, and department. - `cardNumber`: The number associated with the credit card. - `cardReference`: A reference number for the card. - `cardType`: The type of credit card. - `issueDate`: The date the card was issued. - `statementDate`: The date of the latest statement. - `dueDate`: The due date for payment. - `cardStatus`: The current status of the card. - `initialLimit`: The initial credit limit set for the card. - `actualLimit`: The current credit limit. - `availableLimit`: The available credit limit. - `data`: Additional information about the card, such as expiration date and type. This endpoint is essential for obtaining detailed information about a credit card, which can be used for various financial operations and reporting.

Headers

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

Response

OK