Specifications

JSON Path

Value

Length

Description

summary

fileDate

NS

10

The date file is produced by the CLOWD9 platform DD-MM-YYYY format.

Mandatory

fileTime

NS

8

Time when the file is produced by the CLOWD9 platform HH:MM:SS format.

Mandatory

numberOfRecords

N

1-8

Defined number of card carriers (packaging) in the file.

Mandatory

transmissionReference

ANS

36

Unique ID for the file generated by CLOWD9 platform.

Mandatory

pinMailer

cardID

ANS

36

The Identifier of the card.

Mandatory

mailer

title

A

0-7

Title of the cardholder for the PIN Mailer i.e Mr, Miss, Mrs, etc.

Mandatory

firstName

AS

0-50

Forename of the cardholder for the PIN Mailer.

Mandatory

lastName

AS

0-50

Surname of the cardholder for the PIN Mailer.

Mandatory

addressLine1

ANS

0-100

First line of the delivery address.

Mandatory

addressLine2

ANS

0-100

Second line of the delivery address.

Optional

addressLine3

ANS

0-100

Third line of the delivery address.

Optional

city

ANS

0-50

City of the delivery address.

Mandatory

postcode

ANS

0-9

Postcode or Zipcode of the delivery address.

country

A

0-3

Country ISO Alpha value.

Mandatory

email

ANS

0-100

Cardholder email address.

Optional

phoneNumber

NS

0-15

Cardholder mobile number.

Optional

deliveryRef

N

0-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

type

N

1

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

envelopeRef

AN

0-50

Reference of the envelope to insert the PIN Mailer. Value must be agreed with the Card Manufacturer.

Optional

designRef

ANS

0-36

Identifies the card design. If supported and pre agreed ID with the Card Manufacturer.

Optional

fulfil1

ANS

0-10

Additional fulfilment parameter - possible values must be agreed with the Card Manufacturer.

Optional

fulfil2

ANS

0-10

Additional fulfilment parameter - possible values must be agreed with the Card Manufacturer.

Optional

language

A

0-2

Alpha character value (ISO 639-1) for the language to be printed on the carrier information.

Optional

pan

N

14-16

Primary Account Number associated with the card_id and PIN.

Mandatory

pinBlock

AN

16

Encrypted PIN Data via a pre-shared PBK/ZPK.

Mandatory