View Payment Card Nicknames

The View Payment Card Nicknames endpoint retrieves all payment cards associated with the authenticated user's profile, returning card identifiers alongside their user-defined nicknames. This enables partners to display friendly card names in their interfaces, making it easier for customers to identify and manage their cards. The response includes full card metadata such as card type, status, network, expiration date, and spending limits.

Endpoint

GET /api/paymentCards/viewNickNames

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when displaying a card selection screen or card management dashboard for a customer, where friendly card names improve usability. It is also useful when building card-switching flows, verifying which cards a user has available, or syncing card metadata for display in partner applications.

Response

200 OK

Returns an array of payment card objects. Each object contains the following fields:

[
  {
    "highnotePaymentCardId": "pc_01HXYZ1234ABCD5678EFGH90IJ",
    "userProfileId": 10042,
    "paymentCardName": "My Business Visa",
    "maxTotalSpending": 500000,
    "maxTransactionsCount": 100,
    "totalSpending": 123400,
    "totalTransactionsCount": 17,
    "type": 1,
    "expirationDate": "2027-08-31T23:59:59Z",
    "active": true,
    "last4": "4321",
    "bin": "411111",
    "network": "VISA",
    "formFactor": "PHYSICAL",
    "status": 1,
    "partnerId": 5001,
    "authorizationControls": [],
    "cardProfileSetId": "cps_01HXYZ9876MNOP1234QRST56UV",
    "financialAccountId": "fa_01HXYZ5678WXYZ9012ABCD34EF",
    "cardProfileSet": {
      "id": "cps_01HXYZ9876MNOP1234QRST56UV",
      "name": "Standard Business Card",
      "intent": "SPENDING",
      "network": "VISA",
      "status": "ACTIVE",
      "cardProductId": "cp_01HXYZ1111BBBB2222CCCC3333",
      "displayName": "Netevia Business Visa",
      "isDefault": true,
      "description": "Standard card product for business customers"
    },
    "syncSubDate": "2026-06-07T14:30:00Z",
    "reissuedCardId": null
  },
  {
    "highnotePaymentCardId": "pc_02HXYZ9999AAAA1111BBBB2222",
    "userProfileId": 10042,
    "paymentCardName": "Online Shopping Card",
    "maxTotalSpending": null,
    "maxTransactionsCount": null,
    "totalSpending": 45000,
    "totalTransactionsCount": 8,
    "type": 2,
    "expirationDate": "2026-12-31T23:59:59Z",
    "active": true,
    "last4": "8890",
    "bin": "424242",
    "network": "VISA",
    "formFactor": "VIRTUAL",
    "status": 1,
    "partnerId": 5001,
    "authorizationControls": [],
    "cardProfileSetId": "cps_01HXYZ9876MNOP1234QRST56UV",
    "financialAccountId": "fa_01HXYZ5678WXYZ9012ABCD34EF",
    "cardProfileSet": null,
    "syncSubDate": "2026-06-07T14:30:00Z",
    "reissuedCardId": null
  }
]

Error Codes

Common Mistakes

• The paymentCardName field contains the user-defined nickname; do not confuse it with the card network name stored in network.
• The type and status fields return integer enum values, not string labels — map them in your application (e.g., type: 2 = Virtual Card, status: 1 = Active).
• A card with active: true may still have a status other than 1 (Active) if it is in a transitional state; always check both fields when determining usability.
• Spending values (maxTotalSpending, totalSpending) are returned as integers in the smallest currency unit (cents). Divide by 100 to display dollar amounts.
• The endpoint returns cards for the authenticated user only; use the appropriate token scoped to the target user profile.

Related Endpoints

• POST /api/paymentCards/setNickName — Assign or update the nickname for a specific payment card
• GET /api/paymentCards — Retrieve full payment card details for the authenticated user
• POST /api/paymentCards/createVirtualCard — Create a new virtual payment card
• POST /api/paymentCards/createPhysicalCard — Create a new physical payment card
• POST /api/paymentCards/createBurnerCard — Create a new burner payment card

Example

curl -X GET https://api.banking.netevia.dev/api/paymentCards/viewNickNames \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"