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
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Valid token in Bearer {AccessToken} format |
| Content-Type | Yes | application/json |
Route Parameters - Single Record Retrieval
| Parameter | Type | Required | Description |
|---|---|---|---|
| CardId | string | No | If provided, only the information of the specified card is returned. |
Query Parameters – Pagination (Listing)
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number to retrieve (default: 1). |
| pageSize | integer | No | Number 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}
- Successful Response
- Listing Scenario (Paginated Response)
{
"CardId": "9s84fsd4f8sd4f4s6df4sdf84sd",
"name": "Test Akbank Card",
"CardNumber": "858563******9966",
"DealerOrCustomerName": "Test Main Dealer",
"InsertedDate": "15.08.2025",
"Status": "Active",
"Bank": "Akbank"
}
{
"data": [
{
"cardId": "56767939-3f1d-4d40-9873-084215028412",
"name": "Burak Kılıçarslan",
"cardNumber": "404308******9028",
"dealerOrCustomerName": null,
"insertedDate": "2025-08-04T10:03:54.848863",
"success": true,
"bank": "Garanti Bank"
},
{
"cardId": "8eebfde2-8a77-4198-a998-3bc5f8069bf4",
"name": "Sadık TEST",
"cardNumber": "435508******4358",
"dealerOrCustomerName": null,
"insertedDate": "2024-07-11T11:33:27.4334707",
"success": true,
"bank": "Akbank"
},
{
"cardId": "624b1eaa-69cd-4a99-9408-54dc34fb888b",
"name": "testttt",
"cardNumber": "403360******0327",
"dealerOrCustomerName": null,
"insertedDate": "2024-12-25T11:35:54.7623235",
"success": true,
"bank": "Kuveyt Türk Participation Bank"
}
],
"currentPage": 1,
"rowCount": 7,
"pageCount": 1
}
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
Statusfield indicates the card's usage state:"Active"or"Inactive". - The
InsertedDatevalue is in"dd.MM.yyyy"format. totalCount,page, andpageSizeinformation 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.