---
title: "List Counterparty Transfers"
method: GET
path: "/api/v1/counterparty-transfers/"
tags: ["CounterpartyTransfers"]
---

# List Counterparty Transfers

`GET /api/v1/counterparty-transfers/`

## Request

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

List all counterparty transfers for the authenticated partner.

## 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[fromCounterpartyId]` string, uuid: Filter transfers by source counterparty ID.
- `filter[toCounterpartyId]` string, uuid: Filter transfers by destination counterparty ID.
- `filter[status]` 'Pending' | 'Completed' | 'Failed': Filter transfers by status.
- `filter[createdAfter]` string, date-time: Filter transfers created after this ISO 8601 datetime.
- `filter[createdBefore]` string, date-time: Filter transfers created before this ISO 8601 datetime.

## 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

- ListCounterpartyTransfersResponse
  - `data` CounterpartyTransfer[], required
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'CounterpartyTransfer', required
    - `attributes` object, required
      - `updatedAt` string, date-time, required
      - `createdAt` string, date-time, required
      - `fromCounterpartyId` string, uuid: ID of the source counterparty.
      - `toCounterpartyId` string, uuid: ID of the destination counterparty.
      - `amount` integer: Amount in cents
      - `status` 'Pending' | 'Completed' | 'Failed': Current status of the counterparty transfer.
      - `idempotencyKey` string: Idempotency key to prevent duplicate transfers.
      - `externalLedgerTransactionId` string, nullable: The external ledger transaction ID from the payment provider, if available.
      - `failureReason` string, nullable: Reason for transfer failure, if applicable.
      - `metadata` object, nullable: Optional string-keyed metadata associated with the transfer. Values must be strings; serialize numbers, booleans, or structured data as strings before sending (e.g. JSON.stringify).
  - `meta` object, required
    - `total` number, required
    - `limit` number, required
    - `offset` number, required

## Other responses

- `400`: Bad Request

---

[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)