| Bookmark Name | Actions |
|---|
Cards
| Name | Description | Introduced In |
|---|---|---|
| changePIN | This API allows the user to change the PIN code for a card. | 2020.04 |
| lockCard | This API allows the user to lock the card. This API can be used in situations where there is a breach in the privacy of card details for the user. | 2020.04 |
| reportLost | This API allows the user to report the lost card. | 2020.04 |
| replaceCard | This API allows the user to replace the card. | 2020.04 |
| unlockCard | This API allows the user to unlock the card. | 2020.04 |
| activateCards | This API allows the user to activate new card or replace the existing card. | 2020.07 |
| applyForDebitCard | This API allows the user to apply for a new debit card in the card flow. | 2020.10 |
| updateWithdrawalLimit | This API allows the user to update the withdrawal limit on the card. | 2020.10 |
| updatePurchaseLimit | This API allows the user to update the purchasing limit on the card. | 2020.10 |
|
Description: |
This API allows the user to change the PIN code for a card. |
|||||
|
Method: |
Custom Verb (changePIN) |
|||||
|
URL: |
/services/data/v1/RBObjects/operations/Cards/changePIN |
|||||
|
Security Level: |
Authorized App User |
|||||
|
Body Request: |
Parameters cardId (Mandatory) Specifies the card identification number. Action (Mandatory) Specifies the action possible for the card – “PinChange” newPin (Mandatory) Specifies a new PIN. notes Specifies additional notes of the user. Reason Specifies the reason for action {
"cardId":"346","Reason":"lb1","Action":"PinChange","notes":"",
"newPin":"678678"
}
|
|||||
|
Response: |
{
"opstatus":0,
"httpStatusCode":0,
"updatedRecords":1
}
|
|||||
| Service Flow: |
|
|
Description: |
This API allows the user to lock the card. This API can be used in situations where there is a breach in the privacy of card details for the user. |
|||||
|
Method: |
Custom Verb (lockCard) |
|||||
|
URL: |
services/data/v1/RBObjects/operations/Cards/lockCard |
|||||
|
Security Level: |
Authorized App User |
|||||
|
Header Request: |
X-Kony-Authorization |
|||||
|
Body Request: |
Parameters cardId (Mandatory) Specifies the card Id number. Action (Mandatory) Specifies the action on the card - Lock. {
"cardId":"346",
"Action":"Lock"
}
|
|||||
|
Response: |
{
"opstatus":0,
"httpStatusCode":0,
"updatedRecords":1
}
|
|||||
| Service Flow: |
|
|
Description: |
This API allows the user to report the lost card. |
|||||
|
Method: |
Custom Verb - reportLost |
|||||
|
URL: |
/services/data/v1/RBObjects/operations/Cards/reportLost |
|||||
|
Security Level: |
Authorized App User |
|||||
|
Header Request: |
X-Kony-Authorization |
|||||
|
Body Request: |
Parameters cardId (Mandatory) Specifies the card Id number Action (Mandatory) Specifies the action on the card – Report Lost Reason (Mandatory) Specifies the reason for reporting – Like Lost, Stolen Notes Any notes user wants to enter. "cardId":"347","Reason":"Stolen","notes":"","Action":"Report Lost"} |
|||||
|
Response: |
{
"opstatus":0,
"httpStatusCode":0,
"updatedRecords":1
}
|
|||||
| Service Flow: |
|
|
Description: |
This API allows the user to replace the card. |
|||||
|
Method: |
Custom Verb (replaceCard) |
|||||
|
URL: |
services/data/v1/RBObjects/operations/Cards/replaceCard |
|||||
|
Security Level: |
Authorized App User |
|||||
|
Header Request: |
X-Kony-Authorization |
|||||
|
Body Request: |
Parameters cardId (Mandatory) Specifies the card Id number. Action (Mandatory) Specifies the action on the card – Replace Request. reason (Mandatory) Specifies the reason for replacing the card – Like upgrade, physical, damage, and other. {
"cardId":"346",
"Action":"Replace Request",
"reason":"My card is damaged "
}
|
|||||
|
Response: |
{
"opstatus":0,
"httpStatusCode":0,
"updatedRecords":1
}
|
|||||
| Service Flow: |
|
|
Description: |
This API allows the user to unlock the card. |
|||||
|
Method: |
Custom Verb (unlockCard) |
|||||
|
URL: |
/services/data/v1/RBObjects/operations/Cards/unlockCard |
|||||
|
Security Level: |
Authorized App User |
|||||
|
Header Request: |
X-Kony-Authorization |
|||||
|
Body Request: |
Parameters cardId (Mandatory) Specifies the unique ID card of the card. Action (Mandatory) Specifies the action on the card – Activate {
"cardId":"346",
"Action":"Activate"
}
|
|||||
|
Response: |
{
"opstatus":0,
"httpStatusCode":0,
"updatedRecords":1
}
|
|||||
| Service Flow: |
|
|
Description: |
This API allows the user to activate new card or replace the existing card. |
|
Method: |
Custom Verb |
|
URL: |
services/data/v1/RBObjects/operations/Cards/activateCards |
|
Security Level: |
Authorized App User |
|
Description: |
This API allows the user to apply for a new debit card in the cards flow. |
|||||
|
Method: |
Custom Verb (applyForDebitCard) |
|||||
|
URL: |
{{URL}}/services/data/v1/RBObjects/operations/Cards/applyForDebitCard |
|||||
|
Security Level: |
Authorized App User |
|||||
|
Header Request: |
X-Kony-Authorization |
|||||
|
Body Request: |
None |
|||||
|
Response: |
Parameters /pinNumber Specifies the PIN. /accountId Specifies the unique ID of the user. /cardProductName Specifies the product name of the card. /withdrawlLimit Specifies the range of limits for the withdrawing through the card. /withdrawalMinLimit Specifies the lower limit for withdrawing through the card. /withdrawalMaxLimit Specifies the upper limit for withdrawing through the card. /purchaseLimit Specifies the range for limits for the purchases. /purchaseMinLimit Specifies the lower limit for the purchases. /purchaseMaxLimit Specifies the upper limit for the purchases. /bankName Specifies the name of the bank. /cardHolderName Specifies the name of the card holder. /currentBalance Specifies the current balance in the account. /availableBalance Specifies the available balance in the account. /currencyCode Specifies the currency code (Example: USD). /cardDisplayName Specifies the display name of the card /billingAddress Specifies the billing address for the card. /AccountType Specifies the type of account. {
"pinNumber":"3471",
"accountId":"200128223242830",
"cardProductName":"jkhjk",
"withdrawlLimit":"$10000",
"withdrawalMinLimit":"$100",
"withdrawalMaxLimit":"$10000",
"withdrawalStepLimit":"$10000",
"purchaseLimit":"$10000",
"purchaseMinLimit":"$10000",
"purchaseMaxLimit":"$10000",
"bankName":"kyc",
"cardHolderName":"alex",
"currentBalance":"$44455",
"availableBalance":"$444",
"currencyCode":"usd",
"cardDisplayName":"alex",
"billingAddress":"usd fgjk jh",
"AccountType":"Savings"
}
|
|||||
| Error Codes: |
|
|||||
| Service Flow: |
|
|
Description: |
This API allows the user to update the withdrawal limit on the card. |
|
Method: |
Custom Verb |
|
URL: |
services/data/v1/RBObjects/operations/Cards/updateWithdrawalLimit |
|
Security Level: |
Authorized App User |
|
Description: |
This API allows the user to update the purchasing limit on the card. |
|
Method: |
Custom Verb |
|
URL: |
services/data/v1/RBObjects/operations/Cards/updatePurchaseLimit |
|
Security Level: |
Authorized App User |
Add Bookmark
save your best linksView Bookmarks
Visit your best linksIn this topic
Are you sure you want to log-off?