latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Counterparties

List counterparty accounts

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

get/v1/counterparties/{counterpartyId}/accounts

Path parameters

counterpartyIdstring required

Counterparty identifier.

Example:cp_example

Counterparty identifier.

Query parameters

pageinteger

Page number (1-based).

Example:1

Page number (1-based).

pageSizeinteger

Items per page (max 100).

Example:20

Items per page (max 100).

includeArchivedboolean

Include archived counterparty accounts in results.

accountKind'bank_account' | 'crypto_wallet'

Filter accounts by account kind.

Example:crypto_wallet

Filter accounts by account kind.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Response

Counterparty account list

Example response

{
  "data": {
    "accounts": [
      {
        "id": "cpa_example",
        "organizationId": "org_example",
        "projectId": "prj_example",
        "counterpartyId": "cp_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"
  }
}