Client transactions

Overview

The Nium One platform generates a daily client transaction static report for you. The report includes all the transactions that you and your customers do in a 24-hour period.

You can start using the report as soon as you're ready. Just ask one of your system administrators to set it up for you.

How to get the report

Use the secure SSH File Transfer Protocol.

The file naming convention is: Client_Transaction_Report_<CLIENTHASHID>_<YYYYMMDD>.csv.

Terminology

This guide includes terms and descriptions that Nium One platform customers use.

Refer to Transaction types for more information.

API field	Display name	Description
`startDate`	start date	The date when a transaction occurs is known as the start date. It's the date at which ownership changes hands. However, the transaction date isn't necessarily the date at which the seller receives payment. That date is known as the settlement date and typically occurs a few days after the transaction start date. The date and time of the transaction are displayed in the `DD/MM/YYYY HH:mm:ss AM/PM` format.
`endDate`	end date	The date when a transaction, which is backed by general credit rather than by a specified asset, is converted or paid in full.
`settlementStatus`	settlement status	The settlement or the state or condition of the transaction status settlement. The values are `Unsettled`, `Settled`, `Released`, `Waived`, `Disputed`, and `Dispute closed`.
`status`	status	The status of the transaction. The values are `Approved`, `Pending`, `Declined`, `Reversal`, `Blocked`, and `Rejected`.
`transactionType`	transaction type	A transaction type is a particular kind of record of a debit or credit event that impacts the wallet balance. The platform supports a number of transaction types. For more information, refer to Transaction types user guide.
`billingCurrencyCode`	billing currency Code	The International Organization for Standardization (ISO) 4217 numeric currency code of the specified card transaction amount.
`billingAmount`	billing amount	The total card transaction amount, in the equivalent billing currency, of the cost of goods or services, billed to the customer. The billing amount usually covers purchases made or services rendered within a specified period of time.
`transactionCurrencyCode`	transaction currency code	The ISO 4217 currency code of the specified card transaction amount. The transaction currency is a currency in which the client performs the payment.
`cardTransactionAmount`	card transaction amount	The transaction amount that's debited from the balance in connection with the use of your card.
`authCurrencyCode`	auth currency	The ISO 4217 currency code of the authorized amount that's debited or credited.
`authAmount`	auth amount	The authorized monetary amount that's placed on hold in your bank account when you use a credit or debit card linked to that bank account to make a purchase. The merchant does this to ensure that your card can be used to make the purchase.
`effectiveAuthAmount`	effective auth amount	The effective authorized monetary amount in credit or debit card transactions. It's the authorized amount that's approved to be charged. After the transaction is approved, the authorized amount is deducted from the amount of available credit. The authorization amount includes fees, charges, etc.
`billingConversionRate`	billing conversion rate	The billing conversion rate is the ratio between the transaction currency to the billing currency. It's commonly used in foreign exchange markets, which designate how much of one currency is needed to exchange for the equivalent value of another currency.
`settlementDate`	settlement date	The settlement date is the date when a debit or credit card transaction is final and when the buyer pays the seller, and the seller delivers cleared assets to the buyer.
`settlementCurrency`	settlement currency	The ISO 4217 currency code settlement currency that the vendor selects to be paid out in and the currency in which funds are sent to the vendor's bank account. You can have one settlement currency or multiple, depending on the functionality of your payment processor and the availability of accounts.
`settlementAmount`	settlement amount	A credit or debit card settlement amount is the monetary sum that a card issuer offers to settle a card balance for a portion of the amount due, in a brief period of time, usually fewer than six months. The cardholder pays the settlement amount in any increments that the program indicates or by the final due date.
`settlementBillingAmount` or `settlementTransactionAmount`	settlement billing amount -or- settlement transaction amount	The total credit or debit card settlement billing amount for the cost of goods or services billed to a customer, usually covering purchases made or services rendered within a specified period of time.
`settlementTransactionAmount`	settlement transaction amount	A credit or debit card settlement transaction amount is the monetary sum that a card issuer offers to settle a card balance for a portion of the amount due, in a brief period of time, usually fewer than six months. The cardholder pays the settlement amount in any increments that the program indicates or by the final due date.
`settlementAuthAmount`	settlement auth amount	The total credit or debit card settlement authorization amount for the cost of goods or services billed to a customer, usually covering purchases made or services rendered within a specified period of time.
`previousBalance`	previous balance	The balance carried over from your last credit or debit card statement or last billing cycle. It's also the last payment you made toward the outstanding balance on your card.
`pocket`	pocket	The transaction pocket that a pocket user may carry out, linked to the pocket account, including electronic funds transfers, withdrawals, internal transfers, payments, and ATM transactions from the pocket account.
`clientHashId`	client hash ID	The client hash identifier (ID) is a unique, non-sequential, numerical 128-bit UUID.
`customerHashId`	customer hash ID	The customer hash identifier (ID) is a unique, non-sequential, numerical 128-bit UUID.
`walletHashId`	wallet hash ID	The wallet hash identifier (ID) is a unique, non-sequential, numerical 128-bit UUID.
`cardHashId`	card hard ID	The card hash identifier (ID) is a unique, non-sequential, numerical 128-bit UUID.
`childCustomerHashId`	child customer hash ID	The child customer hash identifier (ID) is a unique, non-sequential, numerical 128-bit UUID.
`maskedCardNumber`	masked card number	A masked credit card, or a virtual credit card, has a new unique credit card number, expiration date, and security code. You use the masked card number to make purchases without ever exposing your real credit card details. A masked card number follows the `1234-56XX-XXXX-9876` format.
`merchantCategory`	merchant category	A merchant category is the classification of a merchant or business by the type of goods or services provided.
`merchantCategoryCode`	merchant category code	A Merchant Category Code (MCC) is a unique 4-digit number that a credit or debit card issuer uses to categorize the transactions consumers complete using a particular card.
`merchantName`	merchant name	The name of a given merchant used in a transaction record. It's the primary name a merchant uses to identify itself to its customers.
`merchantCity`	merchant city	The city or geographical location of the merchant who accepts credit and debit card digital payments from their clients.
`merchantCountry`	merchant country	The country or particular geographical territory where a merchant is located.
`merchantID`	merchant ID	A merchant ID (MID) is a unique 15-digit identification number attached to a business that tells the payment processing systems involved in a transaction where to send which funds.
`debit`	debit	A debit is a record of the money taken from your bank account, for example, when paying for something with your credit or debit card. It's also a byte unit of the data field that's where the number `1` is a debit transaction and the number `0` is a credit.
`authCode`	auth code	An authorization code is a unique 6-digit sequence of letters, numbers, or a combination of both, that validates a person's identity and approves a transaction.
`originalAuthorizationCode`	original authorized code	The first instance of an authorization code, which is used in case of a payment reversal, when funds from a transaction are returned to a cardholder's bank. It's the authorization code of the original transaction being reversed.
`systemTraceAuditNumber`	system trace audit number	A System Trace Audit Number (STAN) is a 6-digit number that NIUM generates to identify a transaction.
`retrievalReferenceNumber`	retrieval reference number	A retrieval reference number is a 12-digit number used with other data elements as a key to identify and track a transaction. A merchant provides this number to uniquely identify the transaction in its system. This data element is used for reconciliation, payment reversal matching, and duplicate checking purposes.
`posEntryMode`	POS entry mode	A 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.
`posEntryCapabilityCode`	POS entry capability code	A POS entry capability code is a 1-digit code for the capability of the POS terminal at which the transaction takes place.
`posConditionCode`	POS condition code	A POS condition code is a 2-digit code for the condition under which the transaction takes place at the point of service.
`terminalID`	terminal ID	A terminal ID (TID) number is an alphanumeric 8-digit sequence of characters that a financial institution uses to monitor which merchant terminal processes a transaction.
`processingCode`	processing code	A processing code is a 6-character code that specifies the bank, currency, and merchant account used to process a credit or debit card transaction. Before you can process card transactions, you need to set up at least one processing code with the merchant ID and merchant key for a merchant account.
`billingReplacementAmount` or `transactionReplacementAmount`	billing replacement amount or transaction replacement amount	A billing or transaction amount is a replacement corrected amount as in the case of a partial payment reversal.
`dateOfTransaction`	date of transaction	The date or timestamp of when the original transaction occurs, in case of a payment reversal. It's the date at which ownership changes hands. The transaction date isn't necessarily the date at which the seller receives payment. That date is known as the settlement date and typically occurs a few days after the transaction date.
`acquiringInstitutionCode`	acquiring institution code	The acquiring institution code identifies the acquiring financial institution, for example, a merchant bank or its agent as the acquirer of the transaction.
`originalAcquiringInstitutionCode`	original acquiring institution code	The first instance of the original acquiring institution code to identify it as acting as the acquirer of the original transaction. It's typically used in case of a payment reversal.
`acquirerCountryCode`	acquirer country code	The short ISO 3166 country code for the country, and its dependent areas, of the acquiring institution.
`comments`	comments	The system-generated comments that let users comment on the NIUM portal, typically at the end of pages. System comments give website visitors the chance to engage with NIUM by leaving their views or reactions to the content on the pages.
`merchantLatitude`	merchant latitude	The merchant's transaction latitude point of sale location that the customer tags. This information is used for fraud detection and risk assessment, as well as for mapping and analyzing sales data. The latitude is determined using GPS or IP geolocation. By comparing the location of the transaction to the billing address on file, payment processors identify potentially fraudulent transactions and take appropriate action to prevent fraud.
`merchantLongitude`	merchant longitude	The merchant's transaction longitude point of sale location that the customer tags. This information is used for fraud detection and risk assessment, as well as for mapping and analyzing sales data. The longitude is determined using GPS or IP geolocation. By comparing the location of the transaction to the billing address on file, payment processors identify potentially fraudulent transactions and take appropriate action to prevent fraud.
`merchantTaggedName`	merchant tagged name	The merchant's name that the customer tags.
`merchantZoomIndex`	merchant zoom index	The merchant zoom index is the level of zoom you want in a web service map. You can zoom in or zoom out on the graphical user interface.
`businessTransaction`	business transaction	A business transaction is an economic event with a third party, usually the customer, that's recorded in an organization's accounting system.
`receiptURL`	receipt URL	The response or receipt URL is a web address to which the payment gateway sends a transaction response and redirects customers to your website from the payment gateway-hosted receipt page.
`receiptType`	receipt type	A digital receipt or e-receipt type is a different form of receipt that a merchant sends directly to your customer's phone or email.
`receiptFileName`	receipt file name	The name of the receipt file.
`labels`	labels	The labels that capture the miscellaneous information about the transaction.
`tags`	tags	The client-defined key-value pairs mapped to the transaction.