Client Settlement Report V2
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 Header | Sample Value/Format | Field Description |
|---|---|---|
| Authorization Date | 01/04/2021 | Date when transaction was authorized by NIUM. |
| Settlement Date | 03/04/2021 | Date from when the transaction was settled by NIUM. |
| Status | Available values include:
| 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 Sign | Available values include:
| Transaction identifier that shows if it's Debit or Credit. |
| Card Proxy Number | Ex: 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. |
| Local Transaction Currency | Available values include:
| 3-character ISO3 currency code. |
| Local Transaction Amount | AAAAAAAAAAAAAAATDDDD | Transaction amount in format (15,1,4). 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. |
| Settlement Currency | Available values include:
| 3-character ISO3 currency code. |
| Settlement Amount | AAAAAAAAAAAAAAATDDDD | Settlement 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 | ABC 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. |
| Scheme Transaction Id | MDH4ABC123456 | Unique transaction identifier from Visa or MasterCard. |
| STAN | 636181 | Field contains a number assigned by the message initiator that uniquely identifies a cardholder transaction. |
| RRN | 383810121011 | Acquirer usually defines it, but a merchant or an electronic terminal may define it. |
| Interchange Reference | 78600000317792070999001 | Interchange reference on transaction provided by the merchant. |
| Pos Entry Mode | 07 | A Point-of-Service (POS) entry mode identifies the mode of transaction initiation at the point of service. |
| ECOM Transaction | Available values include:
| Identifies whether the transaction is an electronic commerce transaction. |
| Matched Authorization | Available values include:
| Indicates if 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. |
| Wallet Provider | Available values include:
| Wallet service provider Id |
| Batch Date | 12/01/2021 | Date 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 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 |