Retrieve Counterparty Groups

GET /api/v1/Counterparties/groups

Description

This endpoint is used to retrieve a paged list of all counterparty groups.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

Query Parameters:

• PageNumber: integer, optional

• PageSize: integer, optional

Request Body:

• None

URL:

• GET: {{baseUrl API url}}/api/v1/Counterparties/groups

Response:

• A CounterpartyGroupListPagedResponse object containing a list of counterparty groups with pagination details.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

GET /api/v1/Counterparties/groups?PageNumber=1&PageSize=10

Response:

HTTP/1.1 200 OK
{
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 20,
  "totalPages": 2,
  "data": [
    {
      "id": "1234567890",
      "name": "Group A",
      "description": "This is a group for Counterparties"
    },
    {
      "id": "0987654321",
      "name": "Group B",
      "description": "This is another group for Counterparties"
    },
    ...
  ]
}

Method: GET

/api/v1/Counterparties/groups?PageNumber=<integer>&PageSize=<integer>

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
PageNumber	<integer>
PageSize	<integer>

Response: 200

{
  "pageNumber": "<integer>",
  "pageSize": "<integer>",
  "total": "<integer>",
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "name": "<string>",
      "merchantId": "<uuid>",
      "id": "<uuid>"
    },
    {
      "name": "<string>",
      "merchantId": "<uuid>",
      "id": "<uuid>"
    }
  ]
}