Client Settlement Report V2

Overview

The Client Settlement Report serves to update you on the final status of transactions following card scheme settlements. This report is purely for informational purposes, and clients are not required to undertake any additional processing on their part. The balances within the Nium platform have already been adjusted accordingly, and the transaction status will be updated accordingly. This report is applicable for all models of dynamic authorization.

📌

IMPORTANT

If you are using the Delegated Model of Dynamic Authorization, you should continue to receive and process the daily settlement file outlined in section 2.2. The Nium platform generates a daily report for you, encompassing all settlements sent by schemes within the last 24 hours.

To start receiving settlement reports, contact your Nium representative. Once enabled, this report can be downloaded from the Nium Portal or delivered to you over Secure File Transfer Protocol (SFTP).

Terminology

The below table provides descriptions for the data provided in the client settlement report V2.

Field HeaderSample Value/FormatField Description
Authorization Date01/04/2021 Date when transaction was authorized by NIUM.
Settlement Date03/04/2021Date from when the transaction was settled by NIUM.
StatusValid values are SUCCESS, PENDING, or FAILEDSettlement status.
Client Hash ID5a860711-8a50-4619-1e4b-24c03560b7xzClient hash identifier (ID) is a unique 36-char UUID.
Customer Hash ID6a450711-2r50-1211-1e4b-12c03780b7qwCustomer hash identifier (ID) is a unique 36-char UUID.
Card Hash Id3f860722-9f50-4689-9e3b-16c03560b7fcCard hash identifier (ID) is a unique 36-char UUID.
Masked Card Number4111-XXXX-XXXX-1111Masked PAN
Authorization CodeA45FR36-character approval code for a transaction.
Transaction SignD or CTransaction identifier that shows if it's Debit or Credit.
Card Proxy NumberEx: 7561010103710131131Cardholder account number/ Proxy number
Transaction CurrencySGD or AUD3-character ISO3 currency code.
Transaction AmountAAAAAAAAAAAAAAATDDDDTransaction amount in format (15,1,4):

A indicates the amount.

T indicates the dot separating the decimal.

D indicates the decimal.

500.45 USD is displayed as 000000000000500.4500

100000 JPY is displayed as 000000000100000.0000

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

A indicates the amount.

T indicates the dot separating the decimal

D indicates the decimal

500.45 USD will be displayed as 000000000000500.4500

100000 JPY will be displayed as 000000000100000.0000

Note: The client is responsible for ensuring proper posting based on the currency’s decimal value.
Billing CurrencySGD or AUD3-character ISO3 currency code.
Billing AmountAAAAAAAAAAAAAAATDDDDBilling 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 must ensure proper posting based on the currency’s decimal value.
Settlement CurrencySGD or AUD3-character ISO3 currency code.
Settlement AmountAAAAAAAAAAAAAAATDDDDSettlement 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 must ensure proper posting based on the currency’s decimal value.
RegionSG, HK, AU2-letter ISO country code depicting region.
Interchange Fee Sign(+), (-) or blank+ for Positive

- for Negative
Interchange FeeAAAAAAAAAAAAAAATDDDDA indicates the amount.

T indicates the dot separating the decimals.

D indicates the decimals. The scheme determines the transaction interchange fee.
Original interchange fee sign(+), (-) or blank+ for Positive

- for Negative
Original interchange feeAAAAAAAAAAAAAAATDDDDA indicates the amount.

T indicates the dot separating the decimals.

D indicates the decimals. The scheme determines the transaction interchange fee.
Issuer MarkupIssuer Markup if it's configured.
Exchange Rate Sign(+), (-) or blank+ for Positive

- for Negative
Exchange Rate0This field shall contain zero.
Transaction Code SignBlankBlank/Empty
Transaction Code2051Identifies the nature of the transaction made and whether a debit, credit or memo.
Merchant ID233062644221291Unique Id of the Merchant where the card was used.
Merchant Category Code5814Alpha-numeric code identifying the merchant operating the POS/ATM.
Merchant Name LocationABC CORP Singapore SGMerchant Name and Location details.
Merchant Country CodeSGP3-letter ISO country code of the merchant
Ref NumberMT233410132000010002589 Reference number shared by the scheme.
Scheme Transaction IdMDH4ABC123456Unique transaction identifier from Visa or MasterCard.
STAN636181Field contains a number assigned by the message initiator (merchant or acquirer) that uniquely identifies a cardholder transaction.
RRN383810121011Acquirer usually defines it, but a merchant or an electronic terminal may define it.
Interchange Reference78600000317792070999001Interchange reference on transaction provided by the merchant.
Pos Entry Mode07A Point-of-Service (POS) entry mode identifies the mode in which a transaction is initiated at the point of service with a 2-digit code. The online entry mode applies to only web-related transactions that would never fit the description of other entry modes such as – manual, card swipe, barcode scan, or chip read.
ECOM Transaction5,6,7 or SIdentifies whether the transaction is an electronic commerce transaction.
Matched AuthorizationY or NThis field will contain - Y or N depending on whether the settlement was matched with an original transaction.
Multi ClearingM or FThis field indicates if the transaction is fully or partially settled. contain "F" when a transaction is settled completely settled.
M - Indicates Multiple, F - Indicates Final.
Recurring Transaction1 or 0 If it's a recurring transaction, then the value will be '1' else it will be 0.
Wallet Provider216- Google
103- Apple
Wallet service provider Id
Batch Date12/01/2021Date when settlement transactions were processed.
Comments"Transaction settled"System-generated comments based on the settlement record processing.
Created By"SYSTEM"This field contains "SYSTEM"
Created Date12/01/2021 11:13:12 pmCreation timestamp in format DD/MM/YYYY HH:MM:SS AM/PM
Modified BySYSTEMThis field contains "SYSTEM"
Modified Date12/01/2021 11:13:12 pmModification timestamp in format DD/MM/YYYY HH:MM:SS AM/PM