> ## Documentation Index
> Fetch the complete documentation index at: https://growi.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Transactions

> Retrieves transaction history including payments, payouts, deposits, withdrawals, and disputes with detailed financial information

Retrieves transaction history including payments, payouts, deposits, withdrawals, and disputes with detailed financial information.

## Request Parameters

| Parameter               | Type    | Description                                                                | Required |
| ----------------------- | ------- | -------------------------------------------------------------------------- | -------- |
| `page`                  | Integer | Page number for pagination. Default is 1.                                  | No       |
| `per_page`              | Integer | Number of results per page. Default is 10. Maximum is 100.                 | No       |
| `child_organization_id` | Integer | Filter transactions by specific child organization ID                      | No       |
| `start_date`            | String  | Filter transactions from this date (MM/DD/YYYY format)                     | No       |
| `end_date`              | String  | Filter transactions until this date (MM/DD/YYYY format)                    | No       |
| `transaction_type`      | String  | Filter by transaction type (payment, payout, deposit, withdrawal, dispute) | No       |
| `search`                | String  | Search transactions by creator name                                        | No       |

## Request Example

```bash theme={null}
curl -X GET "https://api.growi.io/api/public/v1/stats/transactions?page=1&per_page=20&transaction_type=payout&start_date=10/01/25&end_date=10/31/25" \
     -H "Authorization: Bearer YOUR_PUBLIC_API_KEY" \
     -H "Content-Type: application/json"
```

## Response Example

```json theme={null}
{
  "data": [
    {
      "id": 5525,
      "formatted_amount": "-$1,250.00",
      "transaction_type": "Payout",
      "currency": "usd",
      "formatted_fee_amount": "$0.00",
      "formatted_total": "-$1,250.00",
      "status": "Paid",
      "balance": 0,
      "pending_balance": 0,
      "description": "",
      "organization_id": 12077,
      "creator_payout_id": null,
      "invoice_id": 14438,
      "payment_method_id": null,
      "external_id": "8cbb9e8b-0a5b-4a39-92c6-c166fd067136",
      "source": "Balance",
      "destination": "Multiple Creators",
      "created": 1759952556,
      "organization_name": "Growi",
      "organization_logo_url": "https://imagedelivery.net/BFyhPbEwK3CmNvljb-vAxA/3cd500ed-879f-4eb4-ae82-8dbd539d6b00/public",
      "invoice": {
        "id": 14438,
        "currency": "usd",
        "hosted_invoice_url": null,
        "status": "paid",
        "total_formatted": 1250,
        "created_at_formatted": "10/08/25",
        "description": "brand manager - mo #2 - 50% upfront - retainer bump",
        "pretty_status": "Paid",
        "line_items": [
          {
            "id": 40958,
            "amount": 1250,
            "user_name": "Sophia",
            "campaign_name": "Growi campaign",
            "user_id": 162177,
            "order_id": null,
            "status": "sent_from_account",
            "creator_payout_id": 164340,
            "description": "",
            "refunded": false
          }
        ],
        "organization_slug": "growi",
        "organization_name": "Growi",
        "invoice_contract_document_status": null,
        "download_invoice_contract_document": null,
        "summary": null,
        "processing_fee": null,
        "paid_at": "2025-10-08T19:42:36.661Z",
        "payment_method": "Balance",
        "organization_location": null,
        "organization_vat_number": null,
        "organization_company_registration": null
      },
      "organization_slug": "growi",
      "invoice_description": ""
    }
  ],
  "meta": {
    "row_count": 42,
    "page_count": 3,
    "current_page": 1
  },
  "additional_data": {
    "amount_sum": 7283.73,
    "fee_sum": -557.4,
    "payout_sum": -11916.27,
    "payment_sum": 19200,
    "deposit_sum": 0,
    "withdrawal_sum": 0,
    "dispute_sum": 0,
    "payout_other_sum": 0,
    "payout_balance_sum": -11916.27
  }
}
```

## Response Fields

### Transaction Object

| Field                   | Type    | Description                                                               |
| ----------------------- | ------- | ------------------------------------------------------------------------- |
| `id`                    | Integer | Unique identifier for the transaction                                     |
| `formatted_amount`      | String  | Transaction amount in formatted currency with sign (amounts are in cents) |
| `transaction_type`      | String  | Type of transaction (Payment, Payout, Deposit, etc.)                      |
| `currency`              | String  | Currency code (e.g., "usd")                                               |
| `formatted_fee_amount`  | String  | Processing fee amount in formatted currency (amounts are in cents)        |
| `formatted_total`       | String  | Total amount including fees in formatted currency (amounts are in cents)  |
| `status`                | String  | Transaction status (Paid, Available, Failed, etc.)                        |
| `balance`               | Number  | Account balance after transaction (in cents)                              |
| `pending_balance`       | Number  | Pending balance amount (in cents)                                         |
| `description`           | String  | Transaction description                                                   |
| `organization_id`       | Integer | ID of the organization                                                    |
| `creator_payout_id`     | Integer | Associated creator payout ID (null if not applicable)                     |
| `invoice_id`            | Integer | Associated invoice ID (null if not applicable)                            |
| `payment_method_id`     | Integer | Payment method ID (null if not applicable)                                |
| `external_id`           | String  | External system identifier                                                |
| `source`                | String  | Transaction source (Balance, External, etc.)                              |
| `destination`           | String  | Transaction destination                                                   |
| `created`               | Integer | Unix timestamp of transaction creation                                    |
| `organization_name`     | String  | Name of the organization                                                  |
| `organization_logo_url` | String  | URL to organization logo                                                  |
| `organization_slug`     | String  | Organization slug identifier                                              |
| `invoice_description`   | String  | Description from associated invoice                                       |

### Invoice Object (when applicable)

| Field                          | Type    | Description                                   |
| ------------------------------ | ------- | --------------------------------------------- |
| `invoice.id`                   | Integer | Invoice unique identifier                     |
| `invoice.currency`             | String  | Invoice currency                              |
| `invoice.hosted_invoice_url`   | String  | URL to hosted invoice (null if not available) |
| `invoice.status`               | String  | Invoice status                                |
| `invoice.total_formatted`      | Number  | Invoice total amount (in cents)               |
| `invoice.created_at_formatted` | String  | Invoice creation date (MM/DD/YY format)       |
| `invoice.description`          | String  | Invoice description                           |
| `invoice.pretty_status`        | String  | Human-readable status                         |
| `invoice.paid_at`              | String  | ISO timestamp when invoice was paid           |
| `invoice.payment_method`       | String  | Payment method used                           |
| `invoice.line_items`           | Array   | Array of line item objects                    |

### Line Item Object

| Field                            | Type    | Description                   |
| -------------------------------- | ------- | ----------------------------- |
| `line_items[].id`                | Integer | Line item unique identifier   |
| `line_items[].amount`            | Number  | Line item amount (in cents)   |
| `line_items[].user_name`         | String  | Creator/user name             |
| `line_items[].campaign_name`     | String  | Associated campaign name      |
| `line_items[].user_id`           | Integer | Creator/user ID               |
| `line_items[].status`            | String  | Line item status              |
| `line_items[].creator_payout_id` | Integer | Associated creator payout ID  |
| `line_items[].description`       | String  | Line item description         |
| `line_items[].refunded`          | Boolean | Whether the item was refunded |

### Metadata

| Field               | Type    | Description                  |
| ------------------- | ------- | ---------------------------- |
| `meta.row_count`    | Integer | Total number of transactions |
| `meta.page_count`   | Integer | Total number of pages        |
| `meta.current_page` | Integer | Current page number          |

### Additional Data (Financial Summary)

| Field                                | Type   | Description                                    |
| ------------------------------------ | ------ | ---------------------------------------------- |
| `additional_data.amount_sum`         | Number | Total available balance amount (in cents)      |
| `additional_data.fee_sum`            | Number | Total fees collected (in cents)                |
| `additional_data.payout_sum`         | Number | Total payout amount (negative value, in cents) |
| `additional_data.payment_sum`        | Number | Total payment amount received (in cents)       |
| `additional_data.deposit_sum`        | Number | Total deposit amount (in cents)                |
| `additional_data.withdrawal_sum`     | Number | Total withdrawal amount (in cents)             |
| `additional_data.dispute_sum`        | Number | Total dispute amount (in cents)                |
| `additional_data.payout_other_sum`   | Number | Total payouts from payment methods (in cents)  |
| `additional_data.payout_balance_sum` | Number | Total payouts from balance (in cents)          |

## Transaction Types

* **Payment**: Incoming payments from customers
* **Payout**: Outgoing payments to creators or external accounts
* **Deposit**: Manual deposits to account balance
* **Withdrawal**: Manual withdrawals from account balance
* **Dispute**: Chargebacks or disputed transactions

## Authorization

This endpoint requires viewer role or higher. Users with 'viewer' role will receive a 401 Unauthorized error.

## Error Responses

| Status Code | Description                                   |
| ----------- | --------------------------------------------- |
| 401         | Unauthorized - Invalid API key or viewer role |
| 400         | Bad Request - Invalid parameters              |
| 500         | Internal Server Error                         |


## OpenAPI

````yaml GET /stats/transactions
openapi: 3.0.1
info:
  title: Growi API
  description: >-
    API documentation for Growi platform, showcasing the public tracking event
    endpoint
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.growi.io/api/public/v1
security:
  - bearerAuth: []
paths:
  /stats/transactions:
    get:
      description: >-
        Retrieves transaction history including payments, payouts, deposits,
        withdrawals, and disputes with detailed financial information
      parameters:
        - name: page
          in: query
          required: false
          example: 1
          schema:
            type: integer
            default: 1
          description: Page number for pagination. Default is 1.
        - name: per_page
          in: query
          required: false
          example: 10
          schema:
            type: integer
            default: 10
            maximum: 100
          description: Number of results per page. Default is 10. Maximum is 100.
        - name: child_organization_id
          in: query
          required: false
          example: 123
          schema:
            type: integer
          description: Filter transactions by specific child organization ID
        - name: start_date
          in: query
          required: false
          example: 10/01/25
          schema:
            type: string
            format: date
          description: Filter transactions from this date (MM/DD/YYYY format)
        - name: end_date
          in: query
          required: false
          example: 10/31/25
          schema:
            type: string
            format: date
          description: Filter transactions until this date (MM/DD/YYYY format)
        - name: transaction_type
          in: query
          required: false
          example: payout
          schema:
            type: string
            enum:
              - payment
              - payout
              - deposit
              - withdrawal
              - dispute
          description: Filter by transaction type
        - name: search
          in: query
          required: false
          example: Sophia
          schema:
            type: string
          description: Search transactions by creator name
      responses:
        '200':
          description: Transactions retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 5525
                          description: Unique identifier for the transaction
                        formatted_amount:
                          type: string
                          example: '-$1,250.00'
                          description: Transaction amount in formatted currency with sign
                        transaction_type:
                          type: string
                          example: Payout
                          description: Type of transaction
                        currency:
                          type: string
                          example: usd
                          description: Currency code
                        status:
                          type: string
                          example: Paid
                          description: Transaction status
                        source:
                          type: string
                          example: Balance
                          description: Transaction source
                        destination:
                          type: string
                          example: Multiple Creators
                          description: Transaction destination
                        created:
                          type: integer
                          example: 1759952556
                          description: Unix timestamp of transaction creation
                        organization_name:
                          type: string
                          example: Growi
                          description: Name of the organization
                  meta:
                    type: object
                    properties:
                      row_count:
                        type: integer
                        example: 42
                        description: Total number of transactions
                      page_count:
                        type: integer
                        example: 3
                        description: Total number of pages
                      current_page:
                        type: integer
                        example: 1
                        description: Current page number
                  additional_data:
                    type: object
                    properties:
                      amount_sum:
                        type: number
                        example: 7283.73
                        description: Total available balance amount
                      fee_sum:
                        type: number
                        example: -557.4
                        description: Total fees collected
                      payout_sum:
                        type: number
                        example: -11916.27
                        description: Total payout amount (negative value)
                      payment_sum:
                        type: number
                        example: 19200
                        description: Total payment amount received
        '400':
          description: Bad Request - Invalid parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized - Invalid API key or viewer role
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````