Fetch Prepared Cards
This API handles requests to fetch prepared cards from Smart Card Client by issuer code, perso code, start date, end date and pagination features.
Request Parameters description
| Field # | Field name | Data type | Required | Description |
|---|---|---|---|---|
| 1 | issuerCode | string | true | Issuer Code for Data Prep |
| 2 | persoCode | string | true | Perso Code for Data Prep |
| 3 | pageNum | string | false | Page Number for paginated data |
| 5 | pageSize | string | false | Page Size for paginated data |
| 6 | startDate | string | false | Start Date in 'yyyy-MM-dd' format e.g 2022-06-01 |
| 7 | endDate | string | false | End Date in 'yyyy-MM-dd' format e.g 2022-06-30 |
GET /card-management/api/v1/data-prep
Authorization = Bearer Token
Sample Request
https://payment-api.k8.isw.la/card-management/api/v1/data-prep?issuerCode=tst&persoCode=tps&pageNum=1&pageSize=10&startDate=2022-06-23&endDate=2022-06-28
Response Message field description
| Field # | Field name | Description |
|---|---|---|
| 1 | code | Internal Response Code |
| 2 | description | Successful or Error Message |
| 3 | totalSuccessful | number of records successful |
| 4 | totalFailed | number of records failed |
| 5 | totalInProgress | number of records in progress |
| 6 | page | page number |
| 7 | count | number of records |
| 8 | data | List of card data prep details |
| 9 | errors | Errors array if any errors exists. |
Sample Response (success)
{
"code": "00",
"description": "successful",
"totalSuccessful": 0,
"totalFailed": 29,
"totalInProgress": 0,
"page": 1,
"count": 29,
"data": [
{
"id": 183,
"requestId": "10dfc5ee-d43e-42ab-bcd1-bc4314ea9839",
"issuerCode": "tst",
"persoCode": "tps",
"cardDataType": "test",
"status": "JOB_ABORTED",
"message": "Failed to retrieve Issuer Certificate(s)",
"creatorEmail": "[email protected]"
},
{
"id": 182,
"requestId": "6518f426-7a46-4919-b6ee-b12699352328",
"issuerCode": "tst",
"persoCode": "tps",
"cardDataType": "test",
"status": "JOB_ABORTED",
"message": "Failed to retrieve Issuer Certificate(s)",
"creatorEmail": "[email protected]"
}
]
}
Sample Response (failure)
{
"code": "10400",
"description": "issuerCode is required."
}
Updated 4 months ago
