Client Settlement Report V1
⚠️ WARNING
This report version is deprecated. Refer to the Client Settlement Report V2 for the latest version. This report will become unavailable after Jun 2024.
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 V1.
| Field Header | Sample Value/Format | Description |
|---|---|---|
| Batch Date | 20210121 [YYYYMMDD] | Date when settlement file is processed. |
| Effective Date | 20210118 [YYYYMMDD] | Date from when the transaction is effective. |
| Posting Date | 20210118 [YYYYMMDD] | Date from when the transaction is posted to customer account/wallet. |
| File Name | FV_MONTX_YYYYMMDDHHmmss.TXT.pgp | Name of scheme settlement file. It's a PGP encrypted file. |
| Status | Available values include:
| Transaction settlement status. |
| Client Hash ID | 5a860711-8a50-4619-1e4b-24c03560b7xz | Client hash identifier (ID) is a unique 36-char UUID. |
| Customer Hash ID | 6a450711-2r50-1211-1e4b-12c03780b7qw | Customer hash identifier (ID) is a unique 36-char UUID. |
| Card Hash Id | 3f860722-9f50-4689-9e3b-16c03560b7fc | Card hash identifier (ID) is a unique 36-char UUID. |
| Masked Card Number | 4111-XXXX-XXXX-1111 | Masked PAN |
| Authorization Code | A45FR3 | 6-character approval code for a transaction. |
| Transaction type | Available values include:
| Transaction identifier that shows if it's Debit or Credit. |
| Account Number | 7561010103710131131 | Cardholder account number/ Proxy number |
| Transaction Currency | Available values include:
| 3-character ISO3 currency code. |
| Transaction Amount | AAAAAAAAAAAAAAATDDDD | Transaction amount in format (15,1,4): A indicates the amount, T indicates the dot separating the decimal, D indicates the decimal. Example: 500.45 USD as 000000000000500.4500. |
| Billing Currency | Available values include:
| 3-character ISO3 currency code. |
| Billing Amount | AAAAAAAAAAAAAAATDDDD | Billing amount in format (15,1,4). Example: 500.45 USD as 000000000000500.4500. |
| Region | Available values include:
| 2-letter ISO country code depicting region. |
| Interchange Fee Sign | Available values include:
| + for Positive, - for Negative. |
| Interchange Fee | AAAAAAAAAAAAAAATDDDD | Transaction interchange fee as determined by the scheme. |
| Original interchange fee sign | Available values include:
| + for Positive, - for Negative. |
| Original interchange fee | AAAAAAAAAAAAAAATDDDD | Transaction interchange fee as determined by the scheme. |
| Issuer Markup | Issuer Markup if it's configured. | |
| Exchange Rate Sign | Available values include:
| + for Positive, - for Negative. |
| Exchange Rate | 0 | This field shall contain zero. |
| Transaction Code Sign | Blank | Blank/Empty |
| Transaction Code | 2051 | Identifies the nature of the transaction made and whether a debit, credit or memo. |
| Merchant ID | 233062644221291 | Unique Id of the Merchant where the card was used. |
| Merchant Category Code | 5814 | Alpha-numeric code identifying the merchant operating the POS/ATM. |
| Merchant Name Location | APC CORP Singapore SG | Merchant Name and Location details. |
| Merchant Country Code | SGP | 3-letter ISO country code of the merchant |
| Ref Number | MT233410132000010002589 | Reference number shared by the scheme. |
| Visa Transaction ID | MDH4ABC123456 | Unique transaction identifier from Visa or MasterCard. |
| Interchange Reference | 78600000317792070999001 | Interchange reference on transaction provided by merchant. |
| Original Payment Amount Sign | Available values include:
| + for Positive, - for Negative. |
| Original Payment Amount | 0 | This field usually has 0 or blank. |
| Original Transaction Code | 0 | This field usually has 0 or blank. |
| Rolled Amount Sign | Available values include:
| + for Positive, - for Negative. |
| Rolled Amount | 0 | This field usually has 0 or blank. |
| Pos Entry Mode | 07 | A Point-of-Service (POS) entry mode identifies the mode in which a transaction is initiated at the point of service. |
| Point of Service | M90901M99996 | Alphanumeric code that identifies the card acceptor for defining the point of service terminal. |
| ECOM Transaction | Available values include:
| Identifies whether the transaction is an electronic commerce transaction. |
| Matched Authorization | Available values include:
| This field will contain Y or N depending on whether the settlement was matched with an original transaction. |
| Multi Clearing | Available values include:
| Indicates if the transaction is fully or partially settled. M - Indicates Multiple, F - Indicates Final. |
| Recurring Transaction | Available values include:
| If it's a recurring transaction, then the value will be 1 else it will be 0. |
| Recurring MCC | 4101 | Recurring MCC Code. |
| Card Block Code | Black | Alphanumeric value if the card has any block code. |
| Record Type | M | 1-letter record type. It will have the value "M" |
| Payment Indicator | Available values include:
| Indicates the type of payment. Valid values are: B = Branch payment, G = GIRO payment, P = Postal payment. |
| Fraud Matched Flag | Available values include:
| Flag to indicate fraud. Valid values are: Y - Fraud Matched, N - Fraud Not Matched. |
| Digital Card Indicator | Available values include:
| If the transaction was done using Apple or Google wallets, it will have the value of 1 otherwise 0. |
| Sms Dms Indicator | Space | Single or Dual message indicator. |
| Wsp ID | Available values include:
| Wallet service provider ID. |
| Wsp | Wallet service provider. | |
| Token Requester ID | ex: 50120834693 | Unique identifier of Token requestor. |
| Token Number | 16 digit number generated by scheme | For tokenized transactions, it will have corresponding token number details that are shared by the schemes. |
| Comments | "Transaction settled" | System-generated comments based on the settlement record processing. |
| Created By | "SYSTEM" | This field contains "SYSTEM" |
| Created Date | 12/01/2021 11:13:12 pm | Creation timestamp in format DD/MM/YYYY HH:MM:SS AM/PM |
| Modified By | SYSTEM | This field contains "SYSTEM" |
| Modified Date | 12/01/2021 11:13:12 pm | Modification timestamp in format DD/MM/YYYY HH:MM:SS AM/PM |