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).

The file naming convention is Client_Settlement_Report_{clientHashId}_YYYYMMDD.csv

Field	Description
Batch Date	The date of the settlement batch, formatted `YYYYMMDD`.
Posting Date	The date of the settlement batch posted to Nium, formatted `YYYYMMDD`.
File Name	The name of the scheme settlement file, formatted `FV_MONTX_YYYYMMDDHHmmss.TXT.pgp.txt` and is a PGP-encrypted file.
Status	The settlement status. The valid values are `SUCCESS`, `PENDING`, or `FAILED`.
Client Hash ID	The universally unique identifier for the client [36 character UUID].
Customer Hash ID	The universally unique identifier for the customer [36 character UUID].
Card Hash ID	The universally unique identifier for the card [36 character UUID].
Mask Card Number	The masked card number in the format `1234-56xx-xxxx-9876`.
Authorization Code	The authorization code [6 digit] of the transaction.
Transaction Type	1 letter code: `C` for Credit or `D` for Debit.
Account Number	The 19-digit card account number.
Transaction Currency	The 3-letter ISO currency code for the transaction currency.
Transaction Amount	The transaction amount.
Billing Currency	The 3-letter ISO currency code for the billing currency.
Billing Amount	The billing amount of the transaction.
Region	The 2-letter ISO country code depicting the region.
Interchange Fee Sign	This field can be positive `+` or negative `-`.
Interchange Fee	The interchange fee on the transaction.
Issuer Markup	The issuer markup.
Exchange Rate Sign	Empty.
Exchange Rate	This field contains `0.000000000`.
Transaction Code Sign	Empty.
Transaction Code	The 5-digit code to reference debit and credit transactions.
Merchant ID	The 15-digit merchant identifier.
Merchant Category Code	The 4-digit merchant category code.
Merchant Name Location	The merchant name and location.
Merchant Country Code	The 2-letter ISO country code of the merchant.
Ref Number	The 23-character reference number.
Visa Transaction ID	The 15-digit Visa transaction ID.
Interchange Reference	The 23-digit interchange reference number.
Original Payment Amount Sign	Empty.
Original Payment Amount	This field is usually `0`.
Original Transaction Code	This field is usually `0`.
Rolled Amount Sign	Empty.
Rolled Amount	Empty.
POS Entry Mode	The 2-digit code that identifies the actual method used at the point of service to enter the cardholder account number and the card expiration date.
Point of Service	Empty.
ECOM Transaction	The e-commerce transaction code.
Matched Authorization	1 letter (`Y` or `N`) if the settlement is matched with an original transaction
Multi Clearing	1 letter (`F` or blank) if a transaction is settled completely.
Recurring Transaction	The recurring transaction identification. It's usually `0`.
Recurring MCC	The recurring Merchant Category Code (MCC). It's usually `0`.
Card Block Code	Empty.
Record Type	1-letter record type. It's usually `M`.
Payment Indicator	Empty.
Fraud Matched Flag	Empty.
Digital Card Indicator	1-digit (`0` or `1`) if a digital card is being used.
Sms Dms Indicator	Empty.
Wsp ID	The wallet service provider ID.
Wsp	The wallet service provider.
Token Requester ID	The token requestor ID.
Token Number	The token number.
Comments	The system generated comments.
Created By	This field is always `SYSTEM`.
Created Date	The creation timestamp, formatted `DD/MM/YYYY HH:mm:ss AM/PM`.
Modified By	This field is always `SYSTEM`.
Modified Date	The modification timestamp, formatted `DD/MM/YYYY HH:mm:ss AM/PM`.