---
title: "List Counterparty Payouts"
method: GET
path: "/api/v1/counterparties/:counterpartyId/payouts"
tags: ["Counterparties"]
---

# List Counterparty Payouts

`GET /api/v1/counterparties/:counterpartyId/payouts`

## Request

- Base URL: `https://merchant-api.accruesavings.com`
- URL: `https://merchant-api.accruesavings.com/api/v1/counterparties/:counterpartyId/payouts`
- Auth: none declared. Required headers: `Client-ID`, `Authorization`
- TypeScript: <https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/counterparties/:counterpartyId/payouts/get.ts> (a function with typed inputs; its response is checked against the schema)

List the payouts of a specific counterparty, newest first. `meta.total` counts the payouts matching the filters, so page through the list with `page[offset]` until you have read `meta.total` records. Both bounds of every filter range are inclusive.

## Path parameters

- `counterpartyId` string, uuid, required: ID of the counterparty to fetch payouts for.

## Query parameters

- `page[limit]` number: Maximum number of objects that will be returned. Can not be greater than 50.
- `page[offset]` number: Offset from the beginning of the list of objects. Can not be negative.
- `filter[status]` 'Approved' | 'Cancelled' | 'Completed' | 'Denied' | 'Failed' | 'NeedsApproval' | 'Pending' | 'Processing' | 'Returned' | 'Reversed' | 'Sent': Filter payouts by status.
- `filter[minAmount]` integer: Only payouts of at least this amount, in cents.
- `filter[maxAmount]` integer: Only payouts of at most this amount, in cents.
- `filter[createdAfter]` string, date-time: Only payouts created at or after this ISO 8601 datetime.
- `filter[createdBefore]` string, date-time: Only payouts created at or before this ISO 8601 datetime.
- `filter[effectiveDateFrom]` string, date: Only payouts with an effective date on or after this date (YYYY-MM-DD).
- `filter[effectiveDateTo]` string, date: Only payouts with an effective date on or before this date (YYYY-MM-DD).

## Headers

- `Client-ID` string, uuid, required: The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.
- `Authorization` string, uuid, required: Secure secret to access privileged endpoints.

## Response `200`

OK

- ListCounterpartyPayoutsResponse
  - `data` CounterpartyPayout[], required
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'CounterpartyPayout', required
    - `attributes` object, required
      - `amount` integer, required: Amount in cents
      - `status` 'Approved' | 'Cancelled' | 'Completed' | 'Denied' | 'Failed' | 'NeedsApproval' | 'Pending' | 'Processing' | 'Returned' | 'Reversed' | 'Sent', required: Current status of the payout
      - `description` string, nullable, required: Description of the payout
      - `effectiveDate` string, required: Effective date of the payout (ISO 8601 date string)
      - `counterpartyId` string, uuid, required: Counterparty ID (from our system)
      - `updatedAt` string, date-time, required
      - `createdAt` string, date-time, required
  - `meta` object, required
    - `total` number, required
    - `limit` number, required
    - `offset` number, required

## Other responses

- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/byaccrue/apis/accrue-merchant-api.md) - [All operations](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/revisions/3e2d97ef2e6e?raw)