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.

Request Method: POST

Headers:

  • Content-Type: application/json

  • Authorization: Bearer <token

Request 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": {
        "customersID": 1234
        "customersReference": "string",
        "cardHolderName": "Test User",
        "cardLast4": "3566"
        "currency": "usd",
        "totalBalance": 0,
        "availableBalance": 0,
        "status": "Active"
      },
      "status": "1",
      "errors": []
    }

    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.

Request Method: Get

Headers:

  • Content-Type: application/json

  • Authorization: Bearer <token>

Request 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": "Test User",
        "expiryDate": "2028-06-11",
        "cardNumber": "4001200340056007",
        "cvc": 123,
        "currency": "usd",
        "totalBalance": 0,
        "availableBalance": 0,
        "status": "Active"
        "accounts": {
            "id": 4698,
            "accountNumber": "336674726730",
            "routingNumber": "021214891",
            "bankName": "Cross River Bank",
            "bankAddress": "885 Teaneck Rd Teaneck, NJ 07666"
          }
        }
      },
      "status": "1",
      "errors": []
    }

    Errors:

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

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

Last updated