Generic API's
Please find below the API details for the Card Management Interface module.
The API will only be useable if the module has been licenced by the client.
| API Name | Description | Domain | Method | URL | Resource | Operation Id | End Point Description |
|---|---|---|---|---|---|---|---|
| holdings-ca-card-service | API to manage card order, card issuance/reissuance, cards details, update pin window details, retrieve card details and cancel card. | holdings | PUT | /holdings/ca/cards/{cardIssueId}/cancellations | CARD.ISSUE,CACARD.API.CANCEL.1.0.0 | cancelCaCard | Perform card cancellation/terminate and update the card status accordingly |
| holdings | PUT | /holdings/ca/cards/cardIssuances/{cardIssueId}/replacements | CARD.ISSUE,CACARD.API.REISSUE.1.0.0 | updateCaCardReplacement | Perform card replacement and update the card status and other details | ||
| holdings | GET | /holdings/ca/cards/ | CACARD.API.CARD.DETAILS.1.0.0 | getCaCardDetails | Retrieve the card details | ||
| holdings | POST | /holdings/ca/cards/cardIssuances/{cardIssueId} | CARD.ISSUE,CACARD.API.GENERIC.1.0.0 | createCaCardIssuance | Create card issue request with details such as linking, delinking of accounts, card status, expiry date, etc | ||
| holdings | POST | /holdings/ca/cards/cardIssuances/{cardIssueId}/pinSettingTimelines | CAPL.CARD.GEN.MSG,CACARD.API.GENERIC.1.0.0 | createCaCardPinTimeline | Create card PIN resetting timeline details such as date, time and expiry | ||
| holdings | POST | /holdings/ca/cards/debitCardOrders/{cardOrderId} | CARD.ORDER,CACARD.API.GENERIC.1.0.0 | createCaCardOrder | Create a request for ordering of debit cards such as personal cards, business cards, etc | ||
| holdings | PUT | /holdings/ca/cards/cardIssuances/{cardIssueId} | CARD.ISSUE,CACARD.API.GENERIC.1.0.0 | updateCaCardIssuance | Update card details such as linking, delinking of accounts, card status, expiry date, etc | ||
| holdings | PUT | /holdings/ca/cards/cardAccessControls/{cardAccessControlId} | CARD.ACCESS,CACARD.API.GENERIC.1.0.0 | updateCaCardAccessDetails | Update access details of the card such as limit details, access details, transaction details etc based on card access id | ||
| holdings | GET | /holdings/ca/cards/cardAccessControls/{cardAccessControlId} | CARD.ACCESS,CACARD.API.GENERIC.1.0.0 | getCaCardAccessDetails | Retrieve the access details of the card such as access flag, limit details etc based on card access id | ||
| holdings | GET | /holdings/ca/cards/debitCardOrders/{cardOrderId} | CARD.ORDER,CACARD.API.GENERIC.1.0.0 | getCaCardOrder | Retrieve card ordered details such as card type, date, time, etc | ||
| holdings | GET | /holdings/ca/cards/{cardId}/customers | CACARD.API.LOGIN.MEMBER.1.0.0 | getCaCardCustomers | Retrieves the list of members associated with a card through online banking or telephone banking | ||
| reference-ca-cards-service | APIs to retrieve the list of card formats, card types and card access types | reference | GET | /reference/ca/cards/cardTypes | CACARD.API.GET.CARD.TYPE.1.0.0 | getCaCardType | Retrieves the list of card types. Possible values of card types are VISA, MASTER, etc |
| reference | GET | /reference/ca/cards/businessAccessTypes | CACARD.API.GET.CARD.ACCESS.TYPE.1.0.0 | getCaCardAccessType | Retrieves the list of access types available for cards. Possible values of card access are 1 - only deposits. 2 - only withdrawal, 3 - no access. 6 - all access, etc. | ||
| reference | GET | /reference/ca/cards/cardFormats | CACARD.API.GET.CARD.FORMAT.1.0.0 | getCaCardFormat | Retrieves the list of card formats available. Possible values of card formats are BUSINESS, PERSONAL, etc |
In this topic