Temenos Digital
Updated On 14 March 2023 | Min(s) read

Cards

Name Description Introduced In
changePIN This API allows the user to change debit card pin. 2020.04
lockCard This API allows the user to lock the card. 2020.04
reportLost This API allows the user to report the lost//stolen card. 2020.04
replaceCard This API allows the user to request for card replacement. 2020.04
unlockCard This API allows the user to unlock the card. 2020.04
activateCards This API allows user to activate the selected card. 2020.07
applyForDebitCard This API allows the user to apply for a new debit card in the card flow. 2020.10
WithdrawalLimit This API allows the user to set withdrawal limit for a card. 2020.10
updatePurchaseLimit This API allows the user to update the purchasing limit on the card. 2020.10
CancelCard This API allows the user to cancel selected card. 2020.10
 

Description:

This API allows the user to change the debit card pin.

Method:

CustomVerb(createRequest)

URL:

{base_url}/services/data/v1/CardManagementServices/operations/ChangePIN/createRequest

Security Level:

Authorized App User

Body Request:

Parameters

cardId (Mandatory)

Specifies the card identification number.

Action (Mandatory)

Specifies the action to be performed.

newPin (Mandatory)

Specifies a new PIN.

notes (Optional)

Specifies additional notes of the user.

Reason

Specifies the reason for changing the pin.

{

    "cardId": "957",

    "Reason": "Pin leaked",

    "Action": "PinChange",

    "notes": "",

    "newPin": "1212",

    "pinNumber": "1357"

}

Response

Parameters

orderId (Mandatory)

Specifies to the unique order id.

code (Optional)

status (Mandatory)

Specifies the operation status success/failure.

errorMessage (Optional)

Specifies error message if any.

opstatus

Specifies if the service call is success(0)/failure(other than 0).

httpStatusCode 

{

    "
code ": "
",

    "
orderId ": "
DRC21243IFQ0V ",

    "
opstatus ": 0,

    "
message ": "
Service Request created successfully ",

    "
status ": "
SUCCESS ",

    "
httpStatusCode ": 0

}
Error Code(s):
  • Error code : 12403
    Error message : "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error code : 39002
    Error message : "Unable to process request, SCA verification failed."
  • Error code : 39001
    Error message : "Unable to generate service key."
  • Error code : 10152
    Error message : "Not a valid user."
Enterprise Provider: Service Request MS
Enterprise API:

{base_url}/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping:

UI Field Experience API Field MS API Field Transact API Field
NA cardId requestIn.cardId NA
NA notes requestIn.notes NA
NA Reason requestIn.Reason NA
NA pinNumber requestIn.pinNumber NA
NA newPin requestIn.newPin NA
NA Action requestIn.Action NA
 

Description:

This API allows the user to lock the card.

Method:

CustomVerb(createRequest)

URL:

{base_url}/services/data/v1/CardManagementServices/operations/LockCard/createRequest

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": "957",

    "Action": "Lock"

}

Response

Parameters

orderId (Mandatory)

Specifies to the unique order id.

code (Optional)

message (Mandatory)

status (Mandatory)

Specifies the operation status success/failure.

errorMessage (Optional)

Specifies error message if any.

opstatus

Specifies if the service call is success(0)/failure(other than 0).

httpStatusCode 

{
    "code": "",
    "orderId": "DUC213199CIRY",
    "opstatus": 0,
    "message": "Service Request created successfully",
    "status": "SUCCESS",
    "httpStatusCode": 0
}
Error Code(s):
  • Error code : 12403
    Error message : "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error code : 39002
    Error message : "Unable to process request, SCA verification failed."
  • Error code : 39001
    Error message : "Unable to generate service key."
  • Error code : 10152
    Error message : "Not a valid user."
Enterprise Provider: Service Request MS
Enterprise API:

{base_url}/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping:

UI Field Experience API Field MS API Field Transact API Field
NA cardId requestIn.cardId NA
NA Action requestIn.Action NA
 

Description:

This API allows the user to report the lost//stolen card.

Method:

CustomVerb(createRequest)

URL:

{base_url}/services/data/v1/CardManagementServices/operations/ReportLost/createRequest

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": "960",

    "Reason": "Lost",

    "notes": "Lost card in travel",

    "Action": "Report Lost"

}

Response

Parameters

orderId (Mandatory)

Specifies to the unique order id.

code (Optional)

message (Mandatory)

status (Mandatory)

Specifies the operation status success/failure.

errorMessage (Optional)

Specifies error message if any.

opstatus

Specifies if the service call is success(0)/failure(other than 0).

httpStatusCode 

{

    "code": "",

    "orderId": "CRL21243QIXGQ",

    "message": "Service Request created successfully",

    "status": "SUCCESS",

    "opstatus": 0,

    httpStatusCode ": 0

}
Error Code(s):
  • Error code : 12403
    Error message : "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error code : 39002
    Error message : "Unable to process request, SCA verification failed."
  • Error code : 39001
    Error message : "Unable to generate service key."
  • Error code : 10152
    Error message : "Not a valid user."
Enterprise Provider: Service Request MS
Enterprise API:

{base_url}/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping:

UI Field Experience API Field MS API Field Transact API Field
NA cardId requestIn.cardId NA
NA Reason requestIn.Reason NA
NA notes requestIn.notes NA
NA Action requestIn.Action NA
 

Description:

This API allows the user to request for card replacement.

Method:

CustomVerb(createRequest)

URL:

{base_url}/services/data/v1/CardManagementServices/operations/ReplaceCard/createRequest

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 (Optional)

Specifies the reason for replacing the card – Like upgrade, physical, damage, and other. 

{

    "cardId": "347",

    "Action": "Replace Request",

    "Reason": "I wish to upgrade"

}

Response

Parameters

orderId (Mandatory)

Specifies to the unique order id.

code (Optional)

message (Mandatory)

status (Mandatory)

Specifies the operation status success/failure.

errorMessage (Optional)

Specifies error message if any.

opstatus (Mandatory)

Specifies if the service call is success(0)/failure(other than 0).

httpStatusCode 

{

    "code": "",

    "orderId": "DRC21243IFQ0V",

    "opstatus": 0,

    "message": "Service Request created successfully",

    "status": "SUCCESS",

    "httpStatusCode": 0

}
Error Code(s):
  • Error code : 12403
    Error message : "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error code : 39002
    Error message : "Unable to process request, SCA verification failed."
  • Error code : 39001
    Error message : "Unable to generate service key."
  • Error code : 10152
    Error message : "Not a valid user."
Enterprise Provider: Service Request MS
Enterprise API:

{base_url}/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping:

UI Field Experience API Field MS API Field Transact API Field
NA cardId requestIn.cardId NA
NA Reason requestIn.Reason NA
NA Action requestIn.Action NA
 

Description:

This API allows the user to unlock the card.

Method:

CustomVerb(createRequest)

URL:

{base_url}/services/data/v1/CardManagementServices/operations/UnlockCard/createRequest

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

Parameters

orderId (Mandatory)

Specifies to the unique order id.

code (Optional)

message (Mandatory)

status (Mandatory)

Specifies the operation status success/failure.

errorMessage (Optional)

Specifies error message if any.

opstatus (Mandatory)

Specifies if the service call is success(0)/failure(other than 0).

httpStatusCode 

{
    "code": "",
    "orderId": "DUC21319P3JLY",
    "opstatus": 0,
    "message": "Service Request created successfully",
    "status": "SUCCESS",
    "httpStatusCode": 0
}
Error Code(s):
  • Error code : 12403
    Error message : "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error code : 39002
    Error message : "Unable to process request, SCA verification failed."
  • Error code : 39001
    Error message : "Unable to generate service key."
  • Error code : 10152
    Error message : "Not a valid user."
Enterprise Provider: Service Request MS
Enterprise API:

{base_url}/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping:

UI Field Experience API Field MS API Field Transact API Field
NA cardId requestIn.cardId NA
NA Action requestIn.Action NA
 

Description:

This API allows user to activate the selected card.

Method:

CustomVerb (createRequest)

URL:

{base_url}/services/data/v1/CardManagementServices/operations/ActivateCard/createRequest

Security Level:

Authorized App User
Request:

Parameters

cvv (Mandatory)

Specifies the Card Verification Value (CVV) number.

cardId (Mandatory)

Specifies the unique ID of the card.

oldcvv (Mandatory)

Specifies for renewal of the card.

oldcvv (Optional)

Specifies for new card activation.

{

    "cvv": "990",

    "cardId": "12344555348",

    "oldcvv": ""

}

Response

Parameters

orderId (Mandatory)

Specifies to the unique order id.

code (Optional)

message (Mandatory)

status (Mandatory)

Specifies the operation status success/failure.

errorMessage (Optional)

Specifies error message if any.

opstatus (Mandatory)

Specifies if the service call is success(0)/failure(other than 0).

httpStatusCode 

{

    "code": "",

    "orderId": "DAC21244QZ4XT",

    "opstatus": 0,

    "message": "Service Request created successfully",

    "status": "SUCCESS”

    "
    httpStatusCode ":200

}
Error Code(s):
  • Error code : 12403
    Error message : "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error code : 39002
    Error message : "Unable to process request, SCA verification failed."
  • Error code : 39001
    Error message : "Unable to generate service key."
  • Error code : 10152
    Error message : "Not a valid user."
  • Error code : 10240
    Error message : "Invalid parameters please give valid details."
  • Error code : 12000
    Error message : "Internal service error."
  • Error code : 21016
    Error message : "Incorrect CVV code Enteredy."
  • Error code : 21015
    Error message : "Card is Already in Active State."
Enterprise Provider: Service Request MS
Enterprise API:

{base_url}/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping:

UI Field Experience API Field MS API Field Transact API Field
NA cvv requestIn.cvv NA
NA oldcvv requestIn.oldvv NA
NA cardId requestIn.cardId NA
 

Description:

This API allows the user to set withdrawal limit for a card.

Method:

CustomVerb(updateLimit)

URL:

{base_url}/services/data/v1/CardManagementServices/operations/WithdrawalLimit/updateLimit

Security Level:

Authorized App User
Request:

Parameters

cardId

Specifies the unique ID of the card.

Action

Specifies the name of the action.

withdrawlLimit

Specifies the amount limit that is placed on the user withdrawals.

{
    "cardId": "959",
    "Action": "updateWithdrawalLimit",
    "withdrawlLimit": "3950.00"
}

Response

Parameters

orderId (Mandatory)

Specifies to the unique order id.

code (Optional)

message (Mandatory)

status (Mandatory)

Specifies the operation status success/failure.

errorMessage (Optional)

Specifies error message if any.

opstatus (Mandatory)

Specifies if the service call is success(0)/failure(other than 0).

httpStatusCode 

{

    "code": "",

    "orderId": "CPL21243F6WD7",

    "opstatus": 0,

    "message": "Service Request created successfully",

    "status": "SUCCESS",

    "httpStatusCode": 0

}
Error Codes:
  • Error code : 12403

    Error message : "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error code : 39002

    Error message : "Unable to process request, SCA verification failed."
  • Error code : 39001

    Error message : "Unable to generate service key."
  • Error code : 10152
    Error message : "Not a valid user."
Enterprise Provider: Service Request MS
Enterprise API:

{base_url}/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping:

UI Field Experience API Field MS API Field Transact API Field
NA cardId requestIn.cardId NA
NA withdrawlLimit requestIn.withdrawlLimit NA
NA Action requestIn.Action NA
 

Description:

This API allows the user to update the purchasing limit on the card.

Method:

CustomVerb(updateLimit)

URL:

{base_url}/services/data/v1/CardManagementServices/operations/PurchaseLimit/updateLimit

Security Level:

Authorized App User
Request:

Parameters

cardId (Mandatory)

Specifies the unique ID of the card.

Action (Mandatory)

Specifies the name of the action.

purchaseLimit (Mandatory)

Specifies the amount limit that is placed on the user purchases.

{

"cardId":"959",

"Action":"updatePurchaseLimit",

"purchaseLimit":"5.00"

}

Response

Parameters

orderId (Mandatory)

Specifies to the unique order id.

code (Optional)

message (Mandatory)

status (Mandatory)

Specifies the operation status success/failure.

errorMessage (Optional)

Specifies error message if any.

opstatus (Mandatory)

Specifies if the service call is success(0)/failure(other than 0).

httpStatusCode 

{
    "code": "",
    "orderId": "DPL21319WDM68",
    "opstatus": 0,
    "message": "Service Request created successfully",
    "status": "SUCCESS",
    "httpStatusCode": 0
}
Error Codes:
  • Error code : 12403

    Error message : "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error code : 39002

    Error message : "Unable to process request, SCA verification failed."
  • Error code : 39001

    Error message : "Unable to generate service key."
  • Error code : 10152
    Error message : "Not a valid user."
Enterprise Provider: Service Request MS
Enterprise API:

{base_url}/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping:

UI Field Experience API Field MS API Field Transact API Field
NA cardId requestIn.cardId NA
NA purchaseLimit requestIn.purchaseLimit NA
NA Action requestIn.Action NA
 
Description: This API allows user to cancel selected card..
Method: CustomVerb (createRequest)
URL: {base_url}/services/data/v1/CardManagementServices/operations/CancelCard/createRequest
Security Level: Authorized App User
Header Request:

X-Kony-Authorization

Body Request:

Parameters

cardId (Mandatory)

Specifies the identification number of the card.

Action (Mandatory)

Specifies the name of the action.

Reason (Optional)

Specifies the reason for cancelling the card.

{
"cardId": "960",
"Action": "Cancel",
"Reason": "Privacy Reasons"
}

Response

Parameters

orderId (Mandatory)

Specifies to the unique order id.

code (Optional)

message (Mandatory)

status (Mandatory)

Specifies the operation status success/failure.

errorMessage (Optional)

Specifies error message if any.

opstatus (Mandatory)

Specifies if the service call is success(0)/failure(other than 0).

httpStatusCode 

{

    "code": "",

    "orderId": "CCC212431D60Z",

    "opstatus": 0,

    "message": "Service Request created successfully",

    "status": "SUCCESS",

    "httpStatusCode": 0

}
Error Code(s): NA
Enterprise Provider: Service Request MS
Enterprise API:

{base_url}/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA cardId requestIn.cardId NA
NA Action requestIn.Action NA
NA Reason requestIn.reason NA

In this topic

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Sunday, March 23, 2025 3:08:47 PM IST