Get Payment card ID

Get Payment Card ID

The GET /api/paymentCards/viewPaymentCard endpoint retrieves the unique ID and relevant details of a specific payment card. By supplying the card's identifier as a query parameter, callers receive card status, form factor, expiration, linked financial accounts, and restricted card details. This endpoint is useful for referencing a specific card before performing update or deletion operations.

Deprecated: This endpoint is marked as deprecated. Use the current payment card retrieval endpoint where available.

Endpoint

GET /api/paymentCards/viewPaymentCard

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 you need to look up the full details of a payment card using its identifier — for example, before updating card settings, suspending the card, or displaying card information to an account holder. It is also useful for confirming the linked financial account and card form factor (Physical, Virtual, or Burner) prior to further operations.

Query Parameters

ParameterTypeRequiredDescription
paymentCardIdstringYesThe unique identifier of the payment card to retrieve.

Response

200 OK

The response contains a node object with full card details.

Top-level response object (bank.client.paymentcard.viewpaymentcard):

FieldTypeDescription
nodeobjectCard detail object. See fields below.

node object (bank.client.paymentcard.nodecardview):

FieldTypeDescription
typenamestringThe GraphQL type name of the card node.
idstringUnique identifier of the payment card.
statusstringCurrent status of the card (e.g., ACTIVE, SUSPENDED, CLOSED).
binstringBank Identification Number — the first 6 digits of the card number.
last4stringLast 4 digits of the card number.
formFactorstringCard form factor: PHYSICAL_CARD, VIRTUAL_CARD, or BURNER_CARD.
expirationDatestring (date-time)Card expiration date and time in ISO 8601 format.
financialAccountsstringIdentifier(s) of the financial account(s) linked to this card.
restrictedDetailsobjectSensitive card details. See fields below.

restrictedDetails object (bank.client.paymentcard.restricteddetails):

FieldTypeDescription
numberstringFull card number (masked in most contexts).
cvvstringCard verification value.
typenamestringThe GraphQL type name of the restricted details node.
{
  "node": {
    "typename": "PaymentCard",
    "id": "pc_01HXYZ1234ABCDEF5678",
    "status": "ACTIVE",
    "bin": "411111",
    "last4": "1234",
    "formFactor": "VIRTUAL_CARD",
    "expirationDate": "2027-05-31T23:59:59Z",
    "financialAccounts": "fa_01HXYZ9876ZYXWVU4321",
    "restrictedDetails": {
      "number": "XXXX-XXXX-XXXX-1234",
      "cvv": "***",
      "typename": "PaymentCardRestrictedDetails"
    }
  }
}

Error Codes

CodeWhen it happens
400paymentCardId is missing or malformed.
401Token missing, expired, or invalid.
403Insufficient permissions to access the specified card.
404No payment card found for the provided paymentCardId.
500Internal server error.

Common Mistakes

  • Omitting the paymentCardId query parameter — it is required and the request will fail with a 400 error without it.
  • Using an expired Bearer token — tokens last only 10 minutes; refresh via POST /api/auth/refresh before making calls.
  • Expecting a card number in plain text — the restrictedDetails.number field is masked for security; never log or display this value directly.
  • This endpoint is deprecated; plan migration to the current payment card retrieval endpoint to avoid breakage when it is retired.

Related Endpoints

  • POST /api/paymentCards/createPaymentCard — Create a new Physical, Virtual, or Burner payment card.
  • PATCH /api/paymentCards/updatePaymentCard — Update settings or status of an existing payment card.
  • DELETE /api/paymentCards/deletePaymentCard — Remove a payment card from the account.
  • GET /api/paymentCards/listPaymentCards — List all payment cards associated with a customer profile.

Example

curl -X GET "https://api.banking.netevia.dev/api/paymentCards/viewPaymentCard?paymentCardId=pc_01HXYZ1234ABCDEF5678" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
Query Params
string
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json