Skip to main content

Listing / Retrieving Registered Cards

  • Endpoint: /vendor/creditcard
  • HTTP Method: GET
  • Request Content-Type: application/json
  • Response Content-Type: application/json
  • Authorization: Valid AccessToken is required. (See: 2. Authentication – Obtaining AccessToken)

Description

This service allows listing the registered credit cards of a member. Optionally, a specific CardId parameter can be used to retrieve the details of a single card.

Note: If the CardId parameter is not provided, the system returns all registered cards of the member in a paginated format.

This endpoint is for read-only operations (GET) — no addition, deletion, or update is performed.

Header Information

HeaderRequiredDescription
AuthorizationYesValid token in Bearer {AccessToken} format
Content-TypeYesapplication/json

Route Parameters - Single Record Retrieval

ParameterTypeRequiredDescription
CardIdstringNoIf provided, only the information of the specified card is returned.

Query Parameters – Pagination (Listing)

ParameterTypeRequiredDescription
pageintegerNoPage number to retrieve (default: 1).
pageSizeintegerNoNumber of records per page (default: 10, maximum: 100).

Example Request

Listing

GET /vendor/creditcard?page=1&pageSize=10

Single Card Details

GET /vendor/creditcards/{CardId}

{  
"CardId": "9s84fsd4f8sd4f4s6df4sdf84sd",
"name": "Test Akbank Card",
"CardNumber": "858563******9966",
"DealerOrCustomerName": "Test Main Dealer",
"InsertedDate": "15.08.2025",
"Status": "Active",
"Bank": "Akbank"
}

Notes & Best Practices

  • The card number is returned in a masked format for security (only the first 6 and last 4 digits are visible).
  • The Status field indicates the card's usage state: "Active" or "Inactive".
  • The InsertedDate value is in "dd.MM.yyyy" format.
  • totalCount, page, and pageSize information are included in all paginated responses.
  • When listing, only the card records belonging to the relevant member are returned.
  • If the token has expired, the request returns 401 Unauthorized; a new token must be obtained before retrying.