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.

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

Query parameters

⚠️

CAUTION

The date range cannot be longer than six consecutive months.

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

Response

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.

Naming convention

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

Payin and Payout transactions

Card transactions

Fee transactions