BYbyaccrue
Counterparties

List Counterparties

Returns every counterparty unless page[offset] or page[limit] is sent. When either is sent, the response is one page ordered by creation time and meta.total counts all your counterparties; page with page[offset] until you have read meta.total records.

get/api/v1/counterparties/

Request

Query parameters

page[limit]integer

Maximum counterparties per page, at most 50 (larger values are clamped). Defaults to 10 once either page parameter is sent.

page[offset]integer

Number of counterparties to skip, in creation order. Defaults to 0 once either page parameter is sent.

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
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 10
  }
}

Changes

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