Get Account Transactions

Use the Get Account Transactions API endpoint to retrieve a paginated list of transactions for a customer's line of credit account within a specified date range.

📘
Early Access
Credit API endpoints are currently being finalised as part of ongoing product development. While we do not anticipate significant changes, some interfaces, behaviours, and documentation may be refined before general availability.

The Get Account Transactions endpoint enables you to retrieve a paginated list of transactions for a customer's line of credit account within a specified date range. Results can be filtered by transaction status and support cursor-based pagination.

📘
More Information
For more information about the Explorer endpoints, see: Credit Explorer.

Example Request

Retrieve account transactions by making a GET request to the Get Account Transactions endpoint.

GET {{baseUrl}}/api/v1/credit/explorer/accounts/{account_id}/transactions/list

Path Parameters

Parameter	Description
`account_id`	string. Required. The unique identifier of the account.

Query Parameters

Parameter	Description
`fromDate`	string. Optional. The start date of the date range, in `YYYY-MM-DD` format.
`toDate`	string. Optional. The end date of the date range, in `YYYY-MM-DD` format.
`pageSize`	integer. Optional. The number of results to return per page. Defaults to `50`.
`pageToken`	string. Optional. The cursor token for the next page of results. Pass the `nextPageToken` value returned in the previous response.
`statuses`	string. Optional. A comma-separated list of transaction statuses to filter by. Possible values: `active`, `reversed`, `dispute`, `settled`, `pending`.

Example Response

A successful request returns a 200 HTTP status code with a paginated list of transactions.

{
  "results": [
    {
      "clientAssignedId": "acc_123456",
      "transactionId": "txn_123456",
      "transactionType": "swipe",
      "amount": "49.99",
      "description": "Coffee Shop",
      "valueDate": "/Date(1706745600)/",
      "status": "settled",
      "billingCycle": "2025-01",
      "currency": "USD"
    },
    {
      "clientAssignedId": "acc_123456",
      "transactionId": "txn_789012",
      "transactionType": "payment",
      "amount": "200.00",
      "description": "Monthly payment",
      "valueDate": "/Date(1706659200)/",
      "status": "active",
      "billingCycle": "2025-01",
      "currency": "USD"
    }
  ],
  "nextPageToken": "cursor_abc123"
}

Response Fields

Transaction List Response Object

Attribute	Description
`results`	array. A list of transactions for the account within the specified date range. See Transaction Object.
`nextPageToken`	string or null. The cursor token to retrieve the next page of results. Pass this value as the `pageToken` query parameter in the next request. `null` if there are no further pages.

Transaction Object

Attribute	Description
`clientAssignedId`	string or null. The identifier of the parent line of credit account, as assigned in the loan management system.
`transactionId`	string or null. The unique identifier of the transaction.
`transactionType`	string or null. The type of transaction. Possible values: `charge`, `swipe`, `payment`, `credit`, `finance-charge`, `bucket-transfer`, `balance-rollover`.
`amount`	string or null. The transaction amount.
`description`	string or null. A description of the transaction. For swipes, this is the merchant name. For payments, this is the payment memo. For charges, this is the fee label.
`valueDate`	string or null. The date the transaction was applied to the account.
`status`	string or null. The current status of the transaction. Possible values: `active`, `settled`, `expired`, `reversed`, `pending`, `voided`.
`billingCycle`	string or null. A reference to the billing cycle in which the transaction occurred.
`currency`	string or null. The ISO 4217 alphabetic currency code of the transaction.

Transaction Status

Status	Description
`active`	The transaction is active and applied to the account.
`settled`	The transaction has been fully settled.
`expired`	The transaction has expired.
`reversed`	The transaction has been reversed.
`pending`	The transaction is pending and has not yet been applied to the account.
`voided`	The transaction has been voided.

Updated 4 days ago

Did this page help you?