List counterparty accounts

Lists payment accounts for a counterparty.

GET/v1/counterparties/{counterpartyId}/accountsRun in dashboard

Crypto-wallet accounts can be used by payment flows that send funds to a counterparty wallet.

Requires an API key with the counterparties.read action.

Path parameters

  • counterpartyId · string · required · min length 1 · example cpty_example

    Counterparty identifier.

Query parameters

  • page · integer · greater than 0 · default 1 · example 1

    Page number (1-based).

  • pageSize · integer · min 1 · max 100 · default 20 · example 20

    Items per page (max 100).

  • includeArchived · boolean · example false

    Include archived counterparty accounts in results.

  • accountKind · string · always crypto_wallet · example crypto_wallet

    Filter accounts by account kind.

Headers

  • x-project-id · string · min length 1 · example prj_example

    Required for dashboard sessions. API keys use their assigned project.

Responses

  • 200 Counterparty account list

    • data · object · required

      Paginated list of counterparty accounts.

      • accounts · object[] · required

        Counterparty accounts.

        • id · string · required · example cpacct_example

          Counterparty account identifier.

        • organizationId · string · required · min length 1 · example org_example

          Organization identifier.

        • projectId · string · required · min length 1 · example prj_example

          Project identifier.

        • counterpartyId · string · required · min length 1 · example cpty_example

          Counterparty identifier.

        • accountKind · string · required · always crypto_wallet · example crypto_wallet

          Counterparty account kind.

        • label · string | null · required · example USDC wallet

          Optional human-readable account label.

        • details · object · required

          Account details. For crypto_wallet accounts, include network: "solana" and address as a Solana wallet address.

          • * · any

        • providerAccountData · object · required

          Provider-specific account metadata preserved by SDP.

          • * · any

        • status · string · required · one of active, archived · example active

          Counterparty account status.

        • createdAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

          Creation timestamp.

        • updatedAt · string · required · format date-time · example 2025-01-02T00:00:00.000Z

          Last update timestamp.

      • total · integer · required · min 0 · example 2

        Total counterparty accounts matching the query.

      • page · integer · required · greater than 0 · example 1

        Current page number.

      • pageSize · integer · required · greater than 0 · example 20

        Items per page.

    • meta · object · required

      Response metadata.

      • requestId · string · required · min length 1 · example req_example

        Request identifier for tracing.

      • timestamp · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

  • 400 Bad Request

    • error · object · required

      Standard error payload.

      • code · string · required

        Machine-readable error code.

      • message · string · required

        Human-readable error message.

      • details · object

        Optional error details for debugging.

        • * · any

    • meta · object

      • requestId · string · min length 1 · example req_example

        Request identifier for tracing.

  • 401 Unauthorized

    Same fields as 400.

  • 403 Forbidden. Requires the counterparties.read action: an API key must hold it (a module's manage or execute also covers its read), and a signed-in member's organization role must include it. Without it the error is INSUFFICIENT_PERMISSIONS and error.details.action names the action. Any other 403 names its own reason.

    Same fields as 400.

  • 404 Not Found

    Same fields as 400.

  • 500 Internal Server Error

    Same fields as 400.

Example request

curl 'https://api-beta.solana.com/v1/counterparties/cpty_example/accounts' \
  -H "Authorization: Bearer $SDP_API_KEY"
const res = await fetch("https://api-beta.solana.com/v1/counterparties/cpty_example/accounts", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.SDP_API_KEY}`
  }
});
import os, requests

r = requests.get("https://api-beta.solana.com/v1/counterparties/cpty_example/accounts",
  headers={"Authorization": f"Bearer {os.environ['SDP_API_KEY']}"})

Example responses

JSON
{
  "data": {
    "accounts": [
      {
        "id": "cpacct_example",
        "organizationId": "org_example",
        "projectId": "prj_example",
        "counterpartyId": "cpty_example",
        "accountKind": "crypto_wallet",
        "label": "USDC wallet",
        "details": {
          "network": "solana",
          "address": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU"
        },
        "providerAccountData": {},
        "status": "active",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-02T00:00:00.000Z"
      }
    ],
    "total": 2,
    "page": 1,
    "pageSize": 20
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}
JSON
{
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Missing action: counterparties.read",
    "details": {
      "action": "counterparties.read"
    }
  },
  "meta": {
    "requestId": "req_example"
  }
}

Error responses use the standard error shape.