Get Counterparty Details

GET /api/v1/Counterparties/get/:counterpartyId

Description

This endpoint is used to get details of an existing counterparty.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• counterpartyId: string, required

Query Parameters:

• version: string, required

Request Body:

• None

URL:
{{baseUrl API url}}/api/v1/Counterparties/get/{counterpartyId}

Response:

• A CounterpartyResponseResponse object containing the counterparty's details.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

GET /api/v1/Counterparties/get/1234567890
Content-Type: application/json

Response:

HTTP/1.1 200 OK
{
  "id": "1234567890",
  "name": "Company X",
  "address": "123 Main St, City, State",
  "phoneNumber": "+1234567890",
  "email": "company@example.com"
}

Method: GET

/api/v1/Counterparties/get/:counterpartyId

Headers

Content-Type	Value
Accept	text/plain

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "id": "<uuid>",
    "userId": "<uuid>",
    "name": "<string>",
    "email": "<string>",
    "address": "<string>",
    "lei": "<string>",
    "country": "<string>",
    "phoneCode": "<string>",
    "phoneNumber": "<string>",
    "state": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "merchantId": "<uuid>"
  }
}