Specifications

JSON PathValueLengthDescription
summary
fileDateNS10The date file is produced by the CLOWD9 platform DD-MM-YYYY format.Mandatory
fileTimeNS8Time when the file is produced by the CLOWD9 platform HH:MM:SS format.Mandatory
numberOfRecordsN1-8Defined number of card carriers (packaging) in the file.Mandatory
transmissionReferenceANS36Unique ID for the file generated by CLOWD9 platform.Mandatory
pinMailer
cardIDANS36The Identifier of the card.Mandatory
mailer
titleA0-7Title of the cardholder for the PIN Mailer i.e Mr, Miss, Mrs, etc.Mandatory
firstNameAS0-50Forename of the cardholder for the PIN Mailer.Mandatory
lastNameAS0-50Surname of the cardholder for the PIN Mailer.Mandatory
addressLine1ANS0-100First line of the delivery address.Mandatory
addressLine2ANS0-100Second line of the delivery address.Optional
addressLine3ANS0-100Third line of the delivery address.Optional
cityANS0-50City of the delivery address.Mandatory
postcodeANS0-9Postcode or Zipcode of the delivery address.
countryA0-3Country ISO Alpha value.Mandatory
emailANS0-100Cardholder email address.Optional
phoneNumberNS0-15Cardholder mobile number.Optional
deliveryRefN0-1

Numeric value to identify the chosen delivery method. Values supported are 1, 2, 3 & 4. Value and associated delivery method will need to be agreed, for example:

1 -Standard Mail
2 -Registered Mail
3 - Direct Delivery (Courier)
4 - Special Delivery

Optional
typeN1

Defines the PIN Mailer type. Values supported are 1, 2, 3 & 4. Value and associated delivery method will need to be agreed, for example:

1 - New PIN Mailer 2 - Renewal 3 - Replacement 4 - PIN Reminder.

Mandatory
envelopeRefAN0-50Reference of the envelope to insert the PIN Mailer. Value must be agreed with the Card Manufacturer.Optional
designRefANS0-36Identifies the card design. If supported and pre agreed ID with the Card Manufacturer.Optional
fulfil1ANS0-10Additional fulfilment parameter - possible values must be agreed with the Card Manufacturer.Optional
fulfil2ANS0-10Additional fulfilment parameter - possible values must be agreed with the Card Manufacturer.Optional
languageA0-2Alpha character value (ISO 639-1) for the language to be printed on the carrier information.Optional
panN14-16Primary Account Number associated with the card_id and PIN.Mandatory
pinBlockAN16Encrypted PIN Data via a pre-shared PBK/ZPK.Mandatory

Did this page help you?