Transaction Types
Prepaid Transaction Types
| Transaction type | Description | Transaction info field |
|---|---|---|
| Transfer | Transfers to or from this card. | • If the client initiates the transfer, this field contains NULL. • If Nium initiates the transfer, this field contains comments entered by the Nium officer. |
| Authorisation | An authorisation is a real-time request sent by a merchant (via the card network) to the issuer to hold, approve or decline a transaction. | Contains the authorisation reason. |
| Authorisation release | The cancellation of a previous authorisation request by the merchant or in cases when the merchant hasn’t settled the transaction by a stipulated time defined by the Schemes (8 days MC / 10 days Visa). In such cases the funds are automatically released by the system (8 days MC / 10 days Visa) | Contains the authorisation reason. |
| Purchase | A purchase refers to the cleared or settled transaction that follows a successful authorization. | NULL |
| Merchant refund | A merchant refund is a transaction where the merchant returns funds to the cardholder, reversing a prior purchase. Refunds may take a few days to process and reflect on the cardholder's account. It is initiated by the merchant, not the cardholder. | NULL |
| Manual credit | A positive manual adjustment on a card. | Contains comments entered by the Nium officer. |
| Manual debit | A negative manual adjustment on a card. | Contains comments entered by the Nium officer |
| Card created | A new virtual card is issued. This could involve fund transfers. | NULL |
| Card deleted | A virtual card is destroyed. This could involve fund transfers. | NULL |
| Freeze | The card is deactivated. Transactions will be declined due to the card’s inactive status. | NULL |
| Thaw | The card is reactivated. Transactions can resume as normal. | NULL |
| Loss recovery | A negative card balance recovery — used to recover any negative balance that may be present on a virtual card. | NULL |
| Field | Description |
|---|---|
| Transaction Amount | The total monetary value represented in transactionCurrency, including the cost of goods or services and any applicable taxes, fees, or charges. This is the amount that is authorized and charged to the customer’s payment method at the time of the transaction. |
| Source Type | The source participant initiating transaction. |
| Source Details | A friendly name identifying the transaction's source participant. |
| Destination Type | The destination participant in the transaction. |
| Destination Details | A friendly name identifying the transaction's destination participant. |
| Participation Type | The type of transaction participant (this can be a source or a destination participant). |
Participation Type
| Funding Account | An account maintained with Nium, used by the client to issue and load cards. |
| Virtual Card | A virtual card issued through Nium for corporate purchasing or payments. |
| Bank Account | A bank account registered in Nium for bank transfers. |
Manual Account
Tagged accounts used by Nium for manual adjustments. These include the following:
| Revshare | This account is used to show revenue share credits/debits. |
| Forex_Fee | This account is used to adjust forex credits/debits. |
| Misc_Clearing | This account adjusts one-off, occasional adjustments (supported by a note). |
| Testing | This account is used to adjust testing credits/debits. |
| Settlement_Loss | This account is used to collect losses on client settlement processing. |
| Settlement_Charge | This account collects fees associated with settlement charges (not managed by the system). |
| Dispute_Fee | This account is used to collect dispute fees on client requests. |
| Dispute_Won | This account is used to credit funds won related to disputes processed. |
| Card_Fee | This account is used to collect/refund card fee charges manually. |
| Transfer_Fee | This account is used to collect/refund fees generated on a transfer manually. |
| Bank_Charge | This account is used to collect/refund fees associated with a bank transfer. |
| Tracing_Charge | This account is used to collect/refund fees associated with a bank transfer trace. |
| Professional_Fee | This account is used to collect fees associated to a bespoke task that had previously communicated a charge |
| Setup_Fee | This account is used to collect/refund setup fees. |
For card reports, participantType is always Virtual Card.
| Field | Description |
|---|---|
| Participation Details | A friendly name of the participant. For example, bank account information (if the participant type is Bank Account), funding account name (if the participant type is Funding Account), and so on. |
| Participation Sink | The possible values are SOURCE or DESTINATION. |
| Original Transaction Amount | The amount requested by the client. This is independent of the participant's currency. For example, if the client requested 1000 GBP and participantCurrency is EUR, originalAmount is 1000. |
| Participant Amount | The value portion of the authorized or settled transaction in the currency of the participant excluding the forex (see: participantCurrency). For example, if the client requested 1000 GBP, participantCurrency is EUR, and the current GBP to EUR exchange rate is 1.1, participantAmount is 1100. |
| Exchange Rate | The exchange rate used between source currency and destination currency (if they are different). |
| Non-Forex Fee | Contains non-Forex fees for the reported transaction, where applicable. |
| Forex Fee | Contains Forex fees for the reported transaction, where applicable. |
| Balance Before Transaction | The balance on the card before the transaction was processed. |
| Adjusted Amount | The final value of a transaction after modifications such as currency conversion, fee application, partial captures, reversals, or refunds. This reflects the amount that is ultimately settled against the cardholder’s account, which may differ from the originally authorized amount. |
This is used to keep track of transactions and can be one of six states:
Transaction status
| Completed | The transaction was completed successfully. |
| Failed | Transaction failed, and no fund movements happened. |
| Initialised | The transaction is suspended, and funds have only been partially moved. |
| Initialised completed | The transaction was previously suspended but has been resumed and completed. Funds have also been fully moved. |
| Initialised failed | The previously suspended transaction has been resumed and is now in a failed state. Any fund movements that happened initially have been reversed, and a new balance movement entry has been created. |
| Field | Description |
|---|---|
| Transaction Direction | Indicates whether a transaction is an Advance or a Reversal. |
| Merchant Name | The name of the merchant. |
| Merchant Country | The base country for the merchant as registered with their acquirer. |
| Merchant Category Code | An identifier for the merchant category that a merchant belongs to. |
| Acquirer Reference Number | A unique reference number that identifies the acquirer for each merchant. |
| Authorisation Code | The authorisation code used in authorisations and settlements. This can be used to match a settlement to its corresponding authorisation. |
| Processor Date | The date on which the transaction was processed at the card processor level. This is usually reported only for the authorisations and settlements. |
| Card Reference | A unique code assigned to a card for tracking purposes stored in the Nium system. |
| Card Number | The first six and the last four digits of a card (for example, 406742****8806). This should not be used to match or map card numbers because multiple cards can share the same set of first six and last four digits. The card reference should be used instead. |
| Card Brand | The card scheme of the issued card (Visa, Mastercard, etc.) |
| Card Type | The card factory (card type) that a card is linked to. |
| Custom Field 1 to Custom Field 20 | You may choose to pass specific information related to the transaction using custom fields and the IssueVirtualCard() API. This information is passed as name:value pairs. Custom fields like this are typically used to reconcile card activity (payments and refunds). For example, custom fields may contain the following information: • Client Customer Identifier : John123 • Client Customer Booking Identifier : Paris321• Client Travel Package Type Descriptor : LOWCOST • Client Travel Package Identifier : LC21• Client Company Subsidiary Descriptor : SpainNOTE: In the Nium Portal, custom fields are referred to as additional details. |
Balanceless Card Transaction Types
Balance Transaction Types
| Balance-less Cards Transaction Type | Balance-less Cards Transaction Description |
|---|---|
| BALANCE CREATE | Represent the creation of a Balance (Wallet). |
| BALANCE BLOCK | Represent the change of Balance state from active to block. |
| BALANCE UNBLOCK | Represent the change of Balance state from block to active. |
| BALANCE CLOSE | Represent the closure of a Balance. |
| FUNDS DEPOSIT | Represent funds being deposited in a Balance. |
| FUNDS TRANSFER | Represent a transfer between two Balances when the operator initiates the transfer. |
| FUNDS WITHDRAW | Represent a transfer of funds from a Balance to a bank account. |
| FUNDS WITHDRAW REVERSAL | Represent a reversal for a transfer of funds from a Balance to a bank account. |
| FEE DEDUCT | Represents a deduction of a fee from the Balance. |
| FEE RETURN | Represent the reversal of a DEDUCT_FEE transaction. |
| FUNDS CREDIT | Represent a manual balance modification credit by a financial operator. |
| FUNDS DEBIT | Represent a manual balance modification debit by a financial operator. |
| REVENUE SHARE | Represents a distribution of revenue to the account, based on a predetermined agreement or contract. |
Balance-less Cards Transaction Types
| Balance-less Cards Transaction Type | Balance-less Cards Transaction Description |
|---|---|
| CARD CREATE | Represent the creation of a card. |
| CARD BLOCK | Represent the change of the card state from active to block. |
| CARD UNBLOCK | Represent the change of the card state from blocked to active. |
| CARD CLOSE | Represent the closure of a card. |
| SPEND LIMIT UPDATE | Represent is updating to spend the limit of the balance-less card. |
Autorisation Transaction Types
| Balance-less Cards Transaction Type | Balance-less Cards Transaction Description |
|---|---|
| AUTHORIZATION | Represents an accepted authorization for a transaction that reduces the balance. |
| AUTHORIZATION | REVERSAL Represents an accepted reversal of a NORMAL_TAKE authorization. The merchant initiates a reversal. |
| AUTHORIZATION | EXPIRY Represents an expiry of a NORMAL_TAKE authorization. The issuer initiates expiry. |
| AUTHORIZATION | DECLINE Represents a declined request for a NORMAL_TAKE authorization. |
| AUTHORIZATION | REVERSAL DECLINE Represents a declined request for the reversal of a NORMAL_TAKE authorization. |
| AUTHORIZATION | REFUND Represents an accepted authorization for a transaction that increases the balance. |
| AUTHORIZATION | REFUND REVERSAL Represents an accepted reversal of a NORMAL_PUT authorization. The merchant initiates reversal. |
| AUTHORIZATION | REFUND EXPIRY Represents an expiry of a NORMAL_PUT authorization. The issuer initiates expiry. |
| AUTHORIZATION | REFUND DECLINE Represents a declined request for a NORMAL_PUT authorization. |
| AUTHORIZATION | REFUND REVERSAL DECLINE Represents a declined request for the reversal of a NORMAL_PUT authorization. |
| PRE-AUTHORIZATION | Represents an accepted pre-authorization, a temporary hold placed on a virtual card. It's used to verify that the card is valid. |
| PRE-AUTHORIZATION EXPIRY | Represents an expiry of the pre-authorisation. The issuer initiates expiry. |
| PRE-AUTHORIZATION REVERSAL | Represents an accepted reversal of a pre-authorization. The merchant initiates reversal. |
Settlement Transaction Types
| Balance-less Cards Transaction Type | Balance-less Cards Transaction Description |
|---|---|
| PURCHASE REFUND | Represents a refund of a purchase made using the card. (Settlement refund) |
| PURCHASE REVERSAL | Represents the reversal of the settlement of a purchase made using the card. (Settlement reversal) |
| PURCHASE | Represents a settled purchase made using the card. (Settlement). Containing both full and partial settlement purchase types (mismatch). |
| PURCHASE REFUND REVERSAL | Represents the reversal of the refund of a purchase made using the card. (Settlement refund reversal). |
Dispute Transaction Types
| Balance-less Cards Transaction Type | Balance-less Cards Transaction Description |
|---|---|
| DISPUTE WON | Represents a chargeback transaction. The case is closed with a Win. |
| DISPUTE LOST | Represents a chargeback transaction. The case is closed with a Loss. |
| DISPUTE PARTIALLY WON | Represents a chargeback transaction. The case is closed with a Partial Won. |
| DISPUTE OPENED | A dispute was opened. This is the first step in a dispute process. No funds are transferred with this type of transaction. |
| DISPUTE REVERSED | A dispute was reversed. No funds are transferred with this type of transaction. |