Change Card Pin

Change Card Pin

This endpoint handles requests to change card PINs. To change a card pin successfully, make a POST Request to the change card pin endpoint.

POST /card-management/api/v1/card/changePin

These are the parameters of the request:

Query Parameters

Parameter #Parameter NameData TypeRequiredDescription
1isActiveActivebooleantrueTrue: Select this option when you want to create a backup for the card.
False: Select this option when you don't want a backup.

Body Parameters

📘

Pin Encryption

To change a PIN, you will need to encrypt both the old PIN and the new PIN you wish to use. To learn more about PIN encryption, please follow the link here.

Field #Field nameData typeMax lengthRequiredDescription
1pinstring4trueNew PIN for the Card in Encrypted Form. Actual PIN Value can only contain digits and have a length of 4.
2userIdstring3 to 20trueUser Id or Name e.g Alex
3panstring16 to 19trueCard Personal Account Number (PAN)
4seqNrstring3 to 3trueCard Sequence Number
5expiryDatestring4 to 4trueCard Expiry Date
6accountTypestring2 to 2trueCard Account Type
7oldPinstring4false/trueCurrent PIN for the Card in Encrypted Form. Actual PIN Value can only contain digits and have a length of 4. (required for active active)
8cvv2string3 to 3false/trueCard CVV2 (required for some cards)
9ridstring1 to 11falseReceiving Institution Identifier for Postilion

This is what a typical request would look like

{
  "pan": "5060990000000151002",
  "seqNr": "001",
  "expiryDate": "5004",
  "pin": "3a6938700f7f4587ffb326c184b609c342da5e1fef0dcf77e45f7b17319682916a1bbd337cd356f2ee41c3c09bd92159feb85ecdf45f4b7a831cb57fabd0d3e90b59cc8d10d384a7ad6450700eb0bd7f0172660b7a6cc15ec40b2cdc2e0a738c5457c76ee2247eb1e0d7f01ee88ab7c8fb9e5ca1f8b36d115742270c0af66d38e45940101d812e2aa64979d52fe6a180a390a77fb21b0e94cc12ff9a83559ab7fd879238eec65e5b2ee5d4a9f9834c341a1fe0f121947485a14e1c9b70edf79544a9953a573ddf15d7ec447f356227249f01726f9cc61407f6f057d90a8c4f2c8dbe344989c10a4e6f26299122591269d025fb4e5a40b316d7ede0b1e60e5e81",
  "oldPin": "3a6938700f7f4587ffb326c184b609c342da5e1fef0dcf77e45f7b17319682916a1bbd337cd356f2ee41c3c09bd92159feb85ecdf45f4b7a831cb57fabd0d3e90b59cc8d10d384a7ad6450700eb0bd7f0172660b7a6cc15ec40b2cdc2e0a738c5457c76ee2247eb1e0d7f01ee88ab7c8fb9e5ca1f8b36d115742270c0af66d38e45940101d812e2aa64979d52fe6a180a390a77fb21b0e94cc12ff9a83559ab7fd879238eec65e5b2ee5d4a9f9834c341a1fe0f121947485a14e1c9b70edf79544a9953a573ddf15d7ec447f356227249f01726f9cc61407f6f057d90a8c4f2c8dbe344989c10a4e6f26299122591269d025fb4e5a40b316d7ede0b1e60e5e81",
  "accountType": "20",
  "userId": "Alex",
  "cvv2": "123"
}

Response Message  field description

Field #Field nameDescription
1codeInternal Response Code
2descriptionSuccessful or Error Message
3correlationIdRequest identifier
4errorsErrors array if any errors exist.

This is what a typical successful or failed response would look like

{
  "code": "00",
  "description": "Successful",
  "correlationId": "5daa9a3f6ce9497d84c559aea9f924b3"
}
{
  "code": "10404",
  "description": "No result found",
  "correlationId": "2aa197eda43540a4ad85b8d0bf570871"
}