Customer account statement

An account statement lists every transaction you make on the Nium One platform, including deposits, withdrawals, spending, fees, payments, refunds, and so forth.

As a client offering a financial account to your customers, you can give your customers an account statement either periodically or based on their specific requests. An account statement helps your customers keep the information for their records to reconcile their transactions. It also helps them analyze their account activity.

You can generate an account statement for your customers via the Account Statement API and the user interface.

Below are the key features of an account statement:

  • Clients can generate an account statement via an API and user interface.
  • A multicurrency account statement is a single document that lists all transactional activity across the currencies.
  • A currency-wise statement gives the flexibility to download statements in your desired currency.
  • A customizable frequency to download account statements.
  • An account statement can be downloaded any time and contain up to six months' worth of data.
  • An account statement is available in CSV and PDF file formats.
FormatBest used forOther benefits
CSVCustomization, data analysis, and integration with other software.This format is standard for all clients.
PDFAn accurate representation for reviewing and printing.Client-specific template with the client's logo and support email address.

Configure your account statement

If you want to use this feature, you need to contact your Nium representative and provide the below details:

  • Your logo to be included in the statement.
    • Logo file — Saved in a public-domain file type, such as JPG, PNG, and PDF.
    • Logo dimensions — The maximum height is 60 pixels. The width is taken based on the logo's aspect ratio.
    • Logo size — The maximum file size is 250 KB.
  • The email address of your customer support team for customers to raise any issue regarding the statement. It's placed under the Important section at the bottom of the PDF.

Nium makes use of the above details and works with you to finalize the statement template to be defined in the system and ready for use.

Use your account statement

A typical account statement contains the following:

  • Account holder's name and address
  • Period of statement
  • Wallet hash ID of the customer
  • Balance summary—the opening and closing balance of each currency
  • Currency-wise transaction details. The transactions made in each currency during the statement period, including deposits, withdrawals, transfers, fees, and exchange rates used for currency conversations.

The filename uses dates in YYYY-MM-DD format and its naming convention is either:

  • Account_statement_<startdate>-<enddate>.csv
  • Account_statement_<startdate>-<enddate>.pdf

Example file name: Account_statement_2023-02-15-2023-03-14.csv

Generate your account statement

You can generate an account statement via an API. Use the following cURL statement, replaced with your own parameters.

curl --location 'https://gateway.nium.com/api/v1/client/{CleintHashId}/customer/{CustomerHashId}/accounts/statement?startDate={startdate}&endDate={enddate}&fileType={CSV/PDF}¤cies={USD,SGD}

  --header 'x-API-key: Clients API key

Path parameters

FieldDescriptionRequired
clientHashIdThe unique client identifier generated and shared before the API handshake.Yes
customerHashIdThe unique customer identifier generated on customer creation.Yes

Query parameters

FieldDescriptionRequired
startDateThe starting date for fetching the transaction details, formatted as YYYY-MM-DD. This field cannot be greater than the endDate.Yes
endDateThe ending date for fetching the transaction details, formatted as YYYY-MM-DD.Yes
fileTypeEither pdf or csv.Yes
currenciesThe 3-digit ISO currency code. If no currency is sent, then all currencies listed in the client program setup are returned.No

⚠️

CAUTION

The date range cannot be longer than six consecutive months.

The statement requested date needs to be later than the creation date.

Response

CodeDescriptionRemarks
200OKNo errors

Response body

The response body contains the generated statement as a PDF or a CSV file attachment with the content type as application/octet-stream and the file naming convention as Account_statement_<startdate> -<end date>.pdf/.csv where the date format is yyyy-mm-dd.

CodeDescriptionRemarks
401Unauthorized
403Forbidden
404Not Found

Naming convention

The below tables list transaction types and their naming convention on the account statements.

Payin and Payout transactions

Transaction typeNaming conventionDescription
Customer wallet credit fund transferAccount-to-account transferThe funds received in the wallet from another customer’s wallet of the same client.
Customer wallet debit fund transferAccount-to-account transferThe funds sent from a wallet to another customer’s wallet of the same client.
Customer wallet debit intra regionAccount-to-account transferThe funds sent from a wallet to another customer’s wallet of a different client but of the same regulatory region.
Customer wallet credit intra regionAccount-to-account transferThe funds received from a wallet to another customer’s wallet of a different client but of the same regulatory region.
Customer wallet debit cross regionAccount-to-account transferThe funds sent from a wallet to another customer’s wallet of a different client and of a different regulatory region
Customer wallet credit cross regionAccount-to-account transferThe funds received from a wallet to another customer’s wallet of a different client and of a different regulatory region
Regulatory auto sweepPLAIS auto sweepFor European Economic Area (EEA) regulatory requirements, this transaction includes the amount moved from any other currency to the European Monetary Unit (EUR). This is the requested block currency by the regulator, in case of a block instruction. In addition, this is valid if there's insufficient balance in EUR for blocking.
Regulatory blockPLAIS blockFor EEA regulatory requirements, this transaction includes the amount moved to the blocked amount from EUR. This is the requested block currency by the regulator, in case of a block instruction.
Regulatory debitPLAIS debitFor EEA regulatory requirements, this transaction includes the amount debited from the block amount or wallet balance of EUR. This is the requested block currency by the regulator. This is valid when the regulator asks to send the blocked amount to a beneficiary.

Remittance debit

Remittance debit external

Outward fund transferRemittance debit: The debit from the wallet for remittance to one's own account.
Remittance debit external: The debit from the wallet for remittance to another account.
Remittance reversalOutward fund transfer—returnedThe reversal of a remittance transaction.
Wallet credit mode cardFundingThe fund credit to a wallet using a card.
Wallet credit mode offlineInward fund transferThe fund credit to a wallet using an offline mode, such as a bank transfer, from the customer’s own account.
Wallet credit mode prefundfundingThe fund credit to a wallet using a client prefund.
Wallet credit mode prefund cross currencyfundingThe cross-currency fund credit to a wallet using a client prefund.
Wallet credit mode offline third-partyInward fund transferThe fund credit to a wallet, in the same currency, using an offline mode, such as a bank transfer from a third party.
Wallet fund transferExchangedThe fund transfer within a wallet, from one currency pool to another.
Wallet refundUnloadThe refund money from the wallet back to the client.
Regulatory debit reversalPLAIS reversalFor EEA regulatory requirements, this transaction includes the amount returned in case of a failed Regulatory_Debit remittance.
Transfer localLocal fund transferThe local payments debited from the wallet through the payment initiation service (PIS) open banking.
Transfer local reversalLocal fund transfer—ReturnedThe local payments that are credited or reversed from the wallet through the PIS open banking.

Card transactions

Transaction typeNaming conventionDescription
Auto sweepExchangedAutomatically sweep from one currency to another within a wallet to authorize a transaction if multicurrency auto-sweep is set up.
Chargeback creditDispute creditCredit transaction in the case of a chargeback.
DebitSpendCard transactions, such as POS and ECOM.
DebitCash withdrawalCard transactions — ATM only.
Original creditMerchant creditReceiving incoming Original Credit Transfer (OCT) and credit to the wallet linked to the cardholder's card.
ReversalReversalOnline reversal of a transaction.
Reversal adviceReversal adviceReversal is initiated when a timeout scenario happens. If Visa or Mastercard time out a card transaction, they generate a reversal advice to roll back the transaction. In the case of wallet clients, Nium applies the reversal advice and provides the credit back to the customer. In the case of Delegated Model authorization clients, Nium reverses funds on the client prefund account and forwards the reversal advice to the Delegated Model authorization client for crediting funds back to the customer.
Settlement creditRefundFunds are credited to the cardholder's wallet when the settlement amount, processed during clearing, is less than the transaction amount, processed during the authorization.
Settlement debitAdditional chargeFunds are debited from the cardholder's wallet when the settlement amount, processed during clearing, is more than the transaction amount, processed during the authorization.
Settlement direct debitSpendFunds are debited from the cardholder's wallet for transactions based on the settlement file; for example, force posting.
Settlement direct reversalTransaction reversalFunds are credited to the cardholder's wallet for the reversal of a debited transaction based on the settlement file.
Settlement reversalRefundFunds are credited to the cardholder's wallet for the reversal of a debited transaction.

Fee transactions

Transaction typeNaming conventionDescription
Account inactive feeMonthly account inactivity feeMonthly fee charged for inactive accounts.
Account maintenance feeMonthly account maintenance feeMonthly fee charged for account maintenance.
Add-on card feeNew add-on card feePer card issuance fee charged for each add-on card issuance
ATM decline feeFee for declined cash withdrawalPer transaction fee charged on an ATM transaction decline.
ATM feeFee for cash withdrawalPer transaction fee charged on an ATM transaction.
Ecom feeFee for online purchasesPer transaction fee charged on e-commerce or online transactions.
International ATM feeFee for international cash withdrawalPer transaction fee charged on an international ATM transaction.
Non-ATM Decline FeeFee for a declined transactionPer transaction fee charged on a non-ATM transaction decline
P2P feeFee for account-to-account transferPer transaction fee charged on a P2P fund transfer.
Plastic feeNew plastic card issuance feeOne-time physical card issuance fee.
Remit bank feeFee for outward fund transferPer transaction fee charged on Remittance_Debit and Remittance_Debit_External transactions when the payoutMethod = LOCAL.
Remit bank fee swiftFee for outward fund transferPer transaction fee charged on Remittance_Debit and Remittance_Debit_External transactions when the payoutMethod = SWIFT.
Remit card feeFee for outward fund transferPer transaction fee charged on Remittance_Debit transactions when the payoutMethod = CARD.
Remit cash feeFee for outward fund transferPer transaction fee charged on Remittance_Debit transactions when the payoutMethod = CASH.
Remit wallet feeFee for outward fund transferPer transaction fee charged on Remittance_Debit transactions when the payoutMethod = WALLET.
Transaction markupFee for foreign transactionPer transaction fee charged on cross-currency transactions when the transaction currency is different from the authorized currency
Virtual card feeNew virtual card issuance feeOne-time virtual card issuance fee.
Wallet credit offline feeFee for inward fund transferPer payin transaction fee when the customer is a remitter (self-funding).
Wallet credit third-party feeFee for inward fund transferPer payin transaction fee when the customer isn't the remitter.
Wallet refund feeFee for unload funds to programPer transaction fee charged on wallet refund.