Search and Filter Counterparties

GET /v1/counter-parties — Search and filter counterparties by end user, name, or type with pagination. Requires com.diameterpay.api/counter-parties.read scope.

This endpoint returns a paginated list of counterparties matching your filter criteria. You can narrow results by end user, search by full or partial name, or filter by counterparty type. It is useful for building recipient selection interfaces, auditing counterparty records, or verifying all recipients associated with a given end user.

​

Endpoint

GET /v1/counter-parties

Required scope: com.diameterpay.api/counter-parties.read

​

Request Headers

Authorization · string · required

Bearer token obtained from your OAuth2 token endpoint. Format: Bearer {access_token}

​

Query Parameters

page · integer

Page number to retrieve, starting from 1. Defaults to 1 if not provided.

limit · integer

Number of results to return per page. Defaults to 20 if not specified.

endUserId · string

Filter results to counterparties belonging to a specific end user. Must be a valid UUID.

name · string

Partial name match filter. Matches against fullName for organizations and firstName/lastName for individuals. Case-insensitive.

type · string

Filter by counterparty type. Must be one of:

• ORGANIZATION
• INDIVIDUAL

​

Response

Returns HTTP 200 OK with a paginated wrapper containing an array of CounterPartyOutput objects.

data · array

Array of counterparty records matching the query. Each item is a CounterPartyOutput object.

Show CounterPartyOutput fields

id · string

UUID uniquely identifying the counterparty.

type · string

Counterparty classification: ORGANIZATION or INDIVIDUAL.

endUserId · string

UUID of the end user this counterparty belongs to.

fullName · string

Full legal name. Present when type is ORGANIZATION.

firstName · string

First name. Present when type is INDIVIDUAL.

lastName · string

Last name. Present when type is INDIVIDUAL.

wireInformation · object

Bank account and routing details for this counterparty.

bankPartners · array

List of bank partner onboarding statuses (bankPartner, status).

createdAt · string

ISO 8601 timestamp of creation.

updatedAt · string

ISO 8601 timestamp of last update.

meta · object

Pagination metadata.

Show meta fields

page · integer

Current page number.

limit · integer

Number of items per page.

total · integer

Total number of counterparties matching the query.

​

Example

cURL

curl --request GET \
  --url "https://api.diameterpay.com/v1/counter-parties?endUserId=3fa85f64-5717-4562-b3fc-2c963f66afa6&type=INDIVIDUAL&name=jane&page=1&limit=20" \
  --header "Authorization: Bearer {access_token}"

​

Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "INDIVIDUAL",
      "endUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "firstName": "Jane",
      "middleName": "Marie",
      "lastName": "Doe",
      "wireInformation": {
        "bankName": "City Bank International",
        "accountNumber": "987654321",
        "routingNumberType": "BIC",
        "routingNumber": "CITIUS33XXX",
        "address": {
          "addressType": "HOME",
          "country": "US",
          "postalCode": "94105",
          "townName": "San Francisco",
          "streetName": "Market Street",
          "buildingNumber": "101",
          "countrySubdivision": "CA"
        }
      },
      "bankPartners": [
        {
          "bankPartner": "SLOVAK_SAVINGS_BANK",
          "status": "ACTIVE"
        }
      ],
      "createdAt": "2024-06-01T12:00:00.000Z",
      "updatedAt": "2024-06-01T12:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 1
  }
}