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).
- Download file name convention: [ClientHashID]_SETTLEMENT_YYYYMMDDHHmmSS.TXT.pgp
- The extracted file naming convention is
Client_Settlement_Report_{clientHashId}_YYYYMMDD.csv - Fields in the settlement file are separated by a pipe ['|'] delimited
- Each settlement file contains three sections:
a. Header
b. Detail Record
c. Trailer - Current PGP encryption will apply, with no change in the logic.
- The last 10 columns are added for future use.
Design Abbreviations
| Abbreviation | Description | |
|---|---|---|
| AN | Alpha-Numeric | |
| A | Alpha only | |
| N | Numeric only | |
| DT | Date |
Header Record
| Field Name | Field Type | Field Length | Sample Value | Description |
|---|---|---|---|---|
| Record Type | AN | 1 | H | Record Type Indicator, H indicates Header record. |
| Batch Date | N | 8 | 20210425 | This 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 Date | N | 14 | 20210426013548 | This 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 Id | AN | 36 | 123e4567-e89b-12d3-a456-426655440000 | This field indicates the client’s unique ID. |
| File Identification | AN | 21 | DAILY SETTLEMENT FILE | Fixed value indicating that this is a daily settlement file |
Detailed Record
| Field Name | Field Type | Field Length | Sample Value | Description |
|---|---|---|---|---|
| Record Type | AN | 1 | D | Record Type Indicator, D indicates Detail record. |
| CardHashId | AN | 36 | 3f860722-9f50-4689-9e3b-16c03560b7fc | The unique card hash ID. |
| Masked Card Number | AN | 16 | 4111XXXXXXXX1111 | Masked PAN |
| Transaction Id | AN | 36 | 28b0de5c-576e-4d34-b747-db37d811fcd1 | The transaction's unique transaction hash ID. |
| Partner Transaction Reference Number | AN | 36 | 28b0de5c-576e-4d34-b747-db37d811fcd1 | The transaction reference number provided by the partner. |
| Effective Date | N | 8 | 20202004 | The effective date when the settlement is released. |
| Batch Date | N | 8 | 20202004 | The batch of the settlement clearance. |
| Transaction Sign | A | 1 | D or C | D = Debit or C = Credit |
| Transaction Currency | A | 3 | SGD or AUD | 3-character ISO3 currency code. |
| Transaction Amount | N | 15,1,4 | AAAAAAAAAAAAAAATDDDD | Transaction 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 Currency | A | 3 | SGD or AUD | 3-character ISO3 currency code. |
| Billing Amount | N | 15,1,4 | AAAAAAAAAAAAAAATDDDD | Transaction 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 Currency | A | 3 | SGD or AUD | 3-character ISO3 currency code. |
| Settlement Amount | N | 15,1,4 | AAAAAAAAAAAAAAATDDDD | Transaction 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 Code | AN | 6 | 557B06 | 6-character approval code for a transaction. |
| System Trace Audit Number (STAN) | N | 12 | This field contains a number assigned by the message initiator (merchant or acquirer) that uniquely identifies a cardholder transaction. | |
| Retrieval Reference Number (RRN) | N | 12 | The acquirer usually defines it, but a merchant or an electronic terminal may define it. | |
| Scheme Transaction Identifier | N | 16 | This contains a scheme-generated Transaction Identifier (TID) unique for each original authorization and financial request. | |
| Description | AN | 40 | RETAIL ONLINE | Description of transaction. |
| Merchant Id | AN | 12 | Unique Id of the Merchant where the card was used. | |
| Merchant Terminal Id | AN | 8 | Unique Id for the Terminal where the card was used. | |
| Merchant Name | AN | 25 | Merchant Name / Card Acceptor Name or Automated Teller Machine (ATM) location | |
| Merchant City | AN | 13 | City of the Merchant / Card Acceptor or the Automated Teller Machine (ATM) | |
| Merchant Country | AN | 2 | Country of the Merchant / Card Acceptor or the Automated Teller Machine (ATM) | |
| Merchant Category Code | N | 4 | 6011 | Alpha-numeric code identifying the merchant operating the POS/ATM. |
| Acquirer Id | N | 12 | This code identifies the financial institution acting as the acquirer of this customer transaction. | |
| Multiple Settlement Indicator | A | 1 | M or F | M - Indicating Multiple F - Indicating Final |
| Interchange Reference | N | 25 | 78600000317792070999001 | Interchange reference on transaction provided by merchant |
| Interchange Fee Sign | A | 1 | + or - | + for Positive - for Negative |
| Interchange Fee | N | 9 | ||
| Original Interchange Fee Sign | a | 1 | + or - | + for Positive - for Negative |
| Original Interchange Fee | N | 15 | ||
| Token Requestor ID | AN | 11 | 40010030273 | ApplePay / GooglePay Token Requester ID |
Trailer Record
| Field Name | Field Type | Field Length | Sample Value | Description |
|---|---|---|---|---|
| Record Type | AN | 1 | T | Record Type Indicator, T indicates Trailer record. |
| Record Count | N | 9 | 000000002 | This field indicates the total number of detail records. |
Updated 2 days ago