Get Card Details By ID

Get Card Details By ID

Description: This endpoint allows you to retrieve detailed information about a specific card using its unique identifier. It's particularly useful for accessing card attributes such as balance, expiry date, and associated account details.

Endpoint: /api/v1/customer/cards/carddetails

Request Method: Get

Headers:

  • Content-Type: application/json

  • Authorization: Bearer <token>

  • otp: 1234

Request Query Parameters:

  • CardId (integer, required): The unique identifier for the top-up card whose details are being requested.

Response Body Example (200 OK):

  • {
      "id": 0,
      "details": {
        "nameOnCard": "string",
        "bHasPin": true,
        "bHasCvc": true,
        "bHasFullCardNumber": true,
        "expiryDate": "2025-12-05T18:26:02.935Z",
        "product": "Disabled",
        "cardExternalId": "string",
        "obfuscatedCardNumber": "string",
        "cardNumber": "string",
        "cardIssuer": "string",
        "pin": "string",
        "cvc": "string",
        "companyName": "string",
        "companyAddrees": "string",
        "fullCardNumber": "string",
        "currency": "string",
        "totalBalance": 0,
        "availableBalance": 0,
        "status": "string",
        "accounts": [
          {
            "id": 0,
            "accountNumber": "string",
            "routingNumber": "string",
            "reference": "string",
            "bankName": "string",
            "bankAddress": "string",
            "productDisplayName": "string",
            "productAddress": "string"
          }
        ]
      },
      "status": "string",
      "errors": [
        {
          "fieldName": "string",
          "messageCode": "string"
        }
      ]
    }

    Errors:

    • 404 Not Found: Returned if the card ID does not exist.

    • 401 Unauthorized: If the request does not include valid authentication.


Get Sensitive Card Details By ID

Description: This endpoint allows you to retrieve sensitive information about a specific card using its unique identifier. It's particularly useful for accessing card attributes such as card number, bank details, and cvc.

Endpoint: /api/v1/customer/cards/sensitive-details

Request Method: Get

Headers:

  • Content-Type: application/json

  • Authorization: Bearer <token>

  • otp: 1234

Request Query Parameters:

  • CardId (integer, required): The unique identifier for the top-up card whose details are being requested.

Response Body Example (200 OK):

  • {
      "id": 0,
      "details": {
        "cardHolderName": "string",
        "expiryDate": "2025-12-05T18:28:08.228Z",
        "cardNumber": "string",
        "cvc": "string",
        "currency": "string",
        "totalBalance": 0,
        "availableBalance": 0,
        "status": "string",
        "accounts": [
          {
            "id": 0,
            "accountNumber": "string",
            "routingNumber": "string",
            "bankName": "string",
            "bankAddress": "string"
          }
        ]
      },
      "status": "string",
      "errors": [
        {
          "fieldName": "string",
          "messageCode": "string"
        }
      ]
    }

    Errors:

    • 404 Not Found: Returned if the card ID does not exist.

    • 401 Unauthorized: If the request does not include valid authentication.

Last updated