---
title: "GET /api/customers/{id}/balance-transactions"
method: GET
path: "/api/customers/{id}/balance-transactions"
tags: ["api", "customers"]
---

# GET /api/customers/{id}/balance-transactions

`GET /api/customers/{id}/balance-transactions`

Get a paged list of a customer's balance transactions

## Path parameters

- `id` string, required — The ID of the customer

## Query parameters

- `top` integer, required — A limit on the number of objects to be returned. Can range between 1 and 1000.
- `skip` integer, required — The number of objects to skip for the requested result

## Response `200`

OK

- object
  - `docs` object[], required
    - `_id` string, required
    - `amount` number, required — Signed amount; positive credits the balance, negative debits it
    - `currency` string, required
    - `type` 'applied_to_transaction' | 'payment' | 'refund' | 'deposit_block' | 'deposit_unblock' | 'payment_request_block' | 'payment_request_unblock' | 'payment_plan_credit' | 'payment_plan_payment' | 'payment_plan_forfeit', required — The kind of movement that produced this entry
    - `transactionId` string — The transaction this movement is tied to, if any
    - `checkoutId` string — The checkout this movement is tied to, if any
    - `userId` string — The dashboard user who triggered this movement, if any
    - `balanceTotalAfter` number, required — Running total balance immediately after this movement
    - `balanceAvailableAfter` number, required — Running available balance immediately after this movement
    - `createdAt` string, date-time, required
  - `total` number, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)
