BYbyaccrue
Counterparties

Get Counterparty

Get a specific counterparty by ID.

get/api/v1/counterparties/:counterpartyId

Request

Path parameters

counterpartyIdstring uuid required

ID of the counterparty to fetch.

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

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": {
      "accountNumber": "1234567890",
      "routingNumber": "021000021",
      "externalBankAccount": {
        "accountNumber": "1234567890",
        "routingNumber": "021000021",
        "accountType": "Checking"
      },
      "internalBankAccount": {
        "accountNumber": "9876543210",
        "routingNumber": "021000021",
        "accountType": "Checking"
      },
      "balance": {
        "pending": 1000,
        "available": 1000,
        "posted": 1000
      }
    }
  }
}

Changes

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