Client settlement

This report contains the end-of-day settlement data as received between Nium and the scheme. As a client administrator, you can sign in to the Nium back-office and view or download the settlement report based on the selected date range.

You can also get a once-a-day static settlement report by downloading a copy or having it delivered to you over Secure File Transfer Protocol (SFTP).

  1. Download file name convention: [ClientHashID]_SETTLEMENT_YYYYMMDDHHmmSS.TXT.pgp
  2. The extracted file naming convention is Client_Settlement_Report_{clientHashId}_YYYYMMDD.csv
  3. Fields in the settlement file are separated by a pipe ['|'] delimited
  4. Each settlement file contains three sections:
    a. Header
    b. Detail Record
    c. Trailer
  5. Current PGP encryption will apply, with no change in the logic.
  6. The last 10 columns are added for future use.

Design Abbreviations

AbbreviationDescription
ANAlpha-Numeric
AAlpha only
NNumeric only
DTDate

Header Record

Field NameField TypeField LengthSample ValueDescription
Record TypeAN1HRecord Type Indicator, H indicates Header record.
Batch DateN820210425This field indicates the posting date of the file sent to the SFTP. The file contains settlement records of the date with the format: yyyyMMdd.
Creation DateN1420210426013548This field indicates the creation date of the file. It has today's Nium cards processing date-time in UTC with the form: yyyyMMddHHmmss.
Client Hash IdAN36123e4567-e89b-12d3-a456-426655440000This field indicates the client’s unique ID.
File IdentificationAN21DAILY SETTLEMENT FILEFixed value indicating that this is a daily settlement file

Detailed Record

Field NameField TypeField LengthSample ValueDescription
Record TypeAN1DRecord Type Indicator, D indicates Detail record.
CardHashIdAN363f860722-9f50-4689-9e3b-16c03560b7fcThe unique card hash ID.
Masked Card NumberAN164111XXXXXXXX1111Masked PAN
Transaction IdAN3628b0de5c-576e-4d34-b747-db37d811fcd1The transaction's unique transaction hash ID.
Partner Transaction Reference NumberAN3628b0de5c-576e-4d34-b747-db37d811fcd1The transaction reference number provided by the partner.
Effective DateN820202004The effective date when the settlement is released.
Batch DateN820202004The batch of the settlement clearance.
Transaction SignA1D or CD = Debit or C = Credit
Transaction CurrencyA3SGD or AUD3-character ISO3 currency code.
Transaction AmountN15,1,4AAAAAAAAAAAAAAATDDDDTransaction amount in format (15,1,4):

A indicates the amount.

T indicates the dot separating the de.cimals

D indicates the decimals

500.45 USD will be displayed as 000000000000500.4500

100000 JPY will be displayed as 000000000100000.0000

Note: The client will be responsible for ensuring proper posting based on the currency’s decimal value
Billing CurrencyA3SGD or AUD3-character ISO3 currency code.
Billing AmountN15,1,4AAAAAAAAAAAAAAATDDDDTransaction amount in format (15,1,4):

A indicates the amount.

T indicates the dot separating the decimals.

D indicates the decimals

500.45 USD will be displayed as 000000000000500.4500

100000 JPY will be displayed as 000000000100000.0000

Note: The client will be responsible for ensuring proper posting based on the currency’s decimal value.
Settlement CurrencyA3SGD or AUD3-character ISO3 currency code.
Settlement AmountN15,1,4AAAAAAAAAAAAAAATDDDDTransaction amount in format (15,1,4):

A indicates the amount.

T indicates the dot separating the decimals.

D indicates the decimals

500.45 USD will be displayed as 000000000000500.4500

100000 JPY will be displayed as 000000000100000.0000

Note: The client will be responsible for ensuring proper posting based on the currency’s decimal valu
Authorization CodeAN6557B066-character approval code for a transaction.
System Trace Audit Number (STAN)N12This field contains a number assigned by the message initiator (merchant or acquirer) that uniquely identifies a cardholder transaction.
Retrieval Reference Number (RRN)N12The acquirer usually defines it, but a merchant or an electronic terminal may define it.
Scheme Transaction IdentifierN16This contains a scheme-generated Transaction Identifier (TID) unique for each original authorization and financial request.
DescriptionAN40RETAIL ONLINEDescription of transaction.
Merchant IdAN12Unique Id of the Merchant where the card was used.
Merchant Terminal IdAN8Unique Id for the Terminal where the card was used.
Merchant NameAN25Merchant Name / Card Acceptor Name or Automated Teller Machine (ATM) location
Merchant CityAN13City of the Merchant / Card Acceptor or the Automated Teller Machine (ATM)
Merchant CountryAN2Country of the Merchant / Card Acceptor or the Automated Teller Machine (ATM)
Merchant Category CodeN46011Alpha-numeric code identifying the merchant operating the POS/ATM.
Acquirer IdN12This code identifies the financial institution acting as the acquirer of this customer transaction.
Multiple Settlement IndicatorA1M or FM - Indicating Multiple

F - Indicating Final
Interchange ReferenceN2578600000317792070999001Interchange reference on transaction provided by merchant
Interchange Fee SignA1+ or -+ for Positive

- for Negative
Interchange FeeN9
Original Interchange Fee Signa1+ or -+ for Positive

- for Negative
Original Interchange FeeN15
Token Requestor IDAN1140010030273ApplePay / GooglePay Token Requester ID

Trailer Record

Field NameField TypeField LengthSample ValueDescription
Record TypeAN1TRecord Type Indicator, T indicates Trailer record.
Record CountN9000000002This field indicates the total number of detail records.