latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Counterparties

Create counterparty account

Creates a payment account for a counterparty. For accountKind "crypto_wallet", details.network must be "solana" and details.address must be a Solana wallet address.

post/v1/counterparties/{counterpartyId}/accounts

Path parameters

counterpartyIdstring required

Counterparty identifier.

Example:cp_example

Counterparty 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

accountKind'bank_account' | 'crypto_wallet' required

Counterparty account kind.

labelstring

Optional account label.

detailsobject

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

providerAccountDataobject

Provider-specific metadata to preserve with the account.

Example request

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

Response

Counterparty account created

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"
  }
}