Counterparties

List counterparties

Changed on

Lists counterparties owned by the merchant with cursor-based pagination. Optionally filter by status.

get/v1/counterparties

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/counterparties
  • Auth
    HTTP bearer

Query parameters

limitinteger

Number of results per page (1-100). Defaults to 10.

cursorstring

Opaque cursor from a previous next_cursor.

status'pending' | 'active' | 'rejected'

Filter by counterparty status. All statuses are included when omitted.

Response

Paginated list of counterparties

has_moreboolean required
next_cursorstring nullable required
has_previousboolean required
previous_cursorstring nullable required

Example response

{
  "data": [
    {
      "status": "active",
      "name": "Acme Sandbox Ltd.",
      "entity_type": "business",
      "physical_address": {
        "line_1": "548 Market St",
        "line_2": "Apartment 4B",
        "city": "San Francisco",
        "postal_code": "94103",
        "state": "CA",
        "country_code": "DE"
      },
      "financial_address": {
        "type": "aba",
        "routing_number": "110000000",
        "account_number": "000123456789",
        "account_holder_name": "Acme Sandbox Ltd.",
        "account_type": "checking"
      },
      "date_of_birth": "1990-01-15",
      "phone": "+55 11 91234 5678",
      "email": "finance@example.com",
      "legal_id": "12.345.678/0001-95",
      "metadata": {
        "invoice_id": "INV-2026-0042"
      }
    }
  ],
  "next_cursor": "eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0",
  "previous_cursor": "eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0"
}

Changes