latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Counterparties

Update counterparty account

Updates a counterparty payment account. At least one field must be provided.

patch/v1/counterparties/{counterpartyId}/accounts/{counterpartyAccountId}

Path parameters

counterpartyIdstring required

Counterparty identifier.

Example:cp_example

Counterparty identifier.

counterpartyAccountIdstring required

Counterparty account identifier.

Example:cpa_example

Counterparty account identifier.

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.

Request body

labelstring nullable

Updated account label. Use null to clear.

detailsobject

Updated account details. Crypto-wallet accounts must retain network: "solana" and a valid Solana wallet address.

providerAccountDataobject

Updated provider-specific metadata.

Example request

{
  "label": "Primary USDC wallet",
  "details": {
    "network": "solana",
    "address": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU"
  },
  "providerAccountData": {}
}

Response

Counterparty account updated

Example response

{
  "data": {
    "account": {
      "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"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}