BYbyaccrue
Counterparties

List Counterparty Transactions

List every money movement on a counterparty's account, newest effective date first: funds arriving over bank rails, payouts to its own bank account, transfers from your other counterparties, and corrections. Together they account for the counterparty's balance exactly, which makes this the endpoint to reconcile a balance against. meta.total counts the transactions matching the filters, so page through the list with page[offset] until you have read meta.total records. A single query returns at most the newest 5,000 matching transactions, so read a longer history in filter[effectiveAtFrom] / filter[effectiveAtTo] windows of fewer than 5,000 transactions each. Both bounds of every filter range are inclusive.

get/api/v1/counterparties/:counterpartyId/transactions

Request

Path parameters

counterpartyIdstring uuid required

ID of the counterparty to fetch transactions for.

Example:123e4567-e89b-12d3-a456-426614174000

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[type]'Deposit' | 'Payout' | 'Transfer' | 'Adjustment' | 'Other'

Filter transactions by what moved the money.

Example:Payout
filter[status]'Pending' | 'Posted' | 'Archived'

Filter transactions by status.

Example:Posted
filter[direction]'Credit' | 'Debit'

Credit for money into the counterparty, Debit for money out of it.

Example:Credit
filter[effectiveAtFrom]string date-time

Only transactions effective at or after this ISO 8601 datetime.

Example:2024-01-01T00:00:00.000Z
filter[effectiveAtTo]string date-time

Only transactions effective at or before this ISO 8601 datetime.

Example:2024-12-31T23:59:59.999Z
filter[minAmount]integer

Only transactions of at least this amount, in cents.

Example:1000
filter[maxAmount]integer

Only transactions of at most this amount, in cents.

Example:500000

Headers

Client-IDstring 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.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "counterpartyId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 5000,
        "currency": "USD",
        "direction": "Credit",
        "type": "Deposit",
        "status": "Posted",
        "description": "Payout to vendor",
        "originatorName": "Checkout LLC",
        "metadata": {
          "bookType": "external-transfer"
        },
        "effectiveAt": "2024-01-15T00:00:00.000Z",
        "postedAt": "2024-01-15T00:00:00.000Z"
      }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.