Get Counterparty Details and Status by ID

GET /v1/counter-parties/ — Retrieve a counterparty’s details and bank onboarding status by UUID. Requires com.diameterpay.api/counter-parties.read scope.

This endpoint retrieves the full details of a single counterparty by its UUID, including wire information, name details, and the current onboarding status across all associated bank partners. Use this endpoint to verify counterparty data or check whether a recipient is ACTIVE and ready to receive payments before initiating a wire transfer.

​

Endpoint

GET /v1/counter-parties/{id}

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}

​

Path Parameters

id · string · required

The UUID of the counterparty to retrieve.

​

Response

Returns HTTP 200 OK with a CounterPartyOutput object on success.

id · string

UUID uniquely identifying this counterparty record.

type · string

The counterparty type: 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.

middleName · string

Middle name. Optionally present when type is INDIVIDUAL.

lastName · string

Last name. Present when type is INDIVIDUAL.

wireInformation · object

The wire transfer details for this counterparty, including bankName, accountNumber, routingNumberType, routingNumber, and address.

bankPartners · array

List of bank partner onboarding records for this counterparty.

Show bankPartners item fields

bankPartner · string

The bank partner identifier: PORTAGE or SLOVAK_SAVINGS_BANK.

status · string

Current onboarding status with this bank partner:

• ACTIVE — onboarded and ready to receive payments
• BLOCKED — onboarding blocked; contact support

createdAt · string

ISO 8601 timestamp of when the counterparty was created.

updatedAt · string

ISO 8601 timestamp of the most recent update to the counterparty record.

​

Example

cURL

curl --request GET \
  --url https://api.diameterpay.com/v1/counter-parties/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  --header "Authorization: Bearer {access_token}"

​

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "type": "ORGANIZATION",
  "endUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fullName": "Acme Corp LLC",
  "wireInformation": {
    "bankName": "First National Bank",
    "accountNumber": "123456789",
    "routingNumberType": "ABA",
    "routingNumber": "021000021",
    "address": {
      "addressType": "BIZZ",
      "country": "US",
      "postalCode": "10001",
      "townName": "New York",
      "streetName": "5th Avenue",
      "buildingNumber": "350",
      "countrySubdivision": "NY"
    }
  },
  "bankPartners": [
    {
      "bankPartner": "PORTAGE",
      "status": "ACTIVE"
    }
  ],
  "createdAt": "2024-06-01T12:00:00.000Z",
  "updatedAt": "2024-06-01T12:00:00.000Z"
}