# Get Funds Transaction Report

This Operation returns the report of funds transactions within the specified date range.

Endpoint: GET /api/v1/funds
Version: 1.0.0
Security: bearerAuth

## Query parameters:

  - `startDate` (string)
    Start date for the transaction report, in UTC format (e.g., `2025-08-01T00:00:00Z`).

  - `endDate` (string)
    End date for the transaction report, in UTC format (e.g., `2025-08-15T23:59:59Z`).

  - `size` (number)
    Maximum number of records to return per page.

  - `page` (number)
    Page number to fetch in paginated results.

## Response 200 fields (application/json):

  - `data` (array)
    List of funds transaction records.

  - `data.transactionCreatedDate` (string)
    Timestamp when the transaction was created (UTC).
    Example: 2025-07-01T10:21:59.281Z

  - `data.transactionId` (string)
    Unique identifier of the transaction.
    Example: T6TjUuWc7SKtluqMDCEPw

  - `data.amount` (number)
    Monetary value of the transaction.
    Example: 10

  - `data.currency` (string)
    Currency code (ISO 4217).
    Example: USD

  - `data.status` (string)
    Status of the transaction.
    Example: SUCCESS

  - `data.previousBalance` (object)
    Balance before this transaction.

  - `data.previousBalance.amount` (number)
    Previous balance amount.
    Example: 876.45

  - `data.previousBalance.currency` (string)
    Currency of the previous balance.
    Example: USD

  - `data.fundingType` (string)
    Mode of funding (e.g., MANUAL, AUTO).
    Example: MANUAL

  - `data.subCarrierId` (string)
    Identifier of the sub-carrier associated with the transaction.
    Example: EQ7Ar2dmDoM

  - `data.userDetails` (object)
    Details of the user who initiated the transaction.

  - `data.userDetails.userId` (string)
    Unique identifier of the user.
    Example: 00u1wtu8b0dvXQKv70h8

  - `data.userDetails.email` (string)
    Email address of the user.
    Example: apitest_jpmc@yopmail.com

  - `data.userDetails.subscriptionId` (string)
    Subscription ID linked to the user.
    Example: sac4c3a

  - `data.userDetails.locationId` (string)
    Location identifier of the user.
    Example: 63gE8OBe3RA

  - `data.userDetails.locationBpn` (string)
    BPN of the location.
    Example: 0018210657

  - `data.userDetails.locationName` (string)
    Name of the location.
    Example: L1

  - `data.dispenseClient` (string)
    Client through which the funds were dispensed. (e.g., API, PB, PITNEYSHIP-PRO)
    Example: PB

  - `pageInfo` (object)
    Pagination details for the transaction report.

  - `pageInfo.total` (integer)
    Total number of records available.
    Example: 2

  - `pageInfo.pages` (integer)
    Total number of pages.
    Example: 1

  - `pageInfo.page` (integer)
    Current page number.
    Example: 1

  - `pageInfo.pageSize` (integer)
    Number of records per page.
    Example: 10

## Response 400 fields (application/json):

  - `errorCode` (string)
    Error code(s) that appear due to HTTP  400- Invalid or Bad Request, e.g. validation-error.
    Example: validation_error

  - `errorDescription` (string)
    The HTTP 400 Bad Request response status code indicates that the server cannot process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
    Example: Rategrop cannot created.

  - `additionalCode` (string)
    A unique identifier for the error, for example 01000806.

  - `additionalInfo` (string)
    This is an additional information about the error. This error 'Invalid Request' might appear due to invalid dimension, weight, or serviceid, or if the information is missing.

  - `additionalParameters` (array)

## Response 401 fields (application/json):

  - `message` (string, required)
    This is HTTP 401 Unauthorized response status code, that indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.