# Join

**PUT /stake-pools/{stakePoolId}/wallets/{walletId}**

<p align="right">status: <strong>stable</strong></p>

Delegate all (current and future) addresses from the given wallet to the given stake pool.

<strong>Note:</strong> Bech32-encoded stake pool identifiers can vary in length.



## Servers
- https://localhost:8090/v2: https://localhost:8090/v2 ()



## Parameters

#### Path parameters
- **stakePoolId** (string(hex|bech32))
  
- **walletId** (string(hex))
  


## Body parameters
Content-type: application/json

- **passphrase** (string)
  The source wallet's master passphrase.

## Responses
### 415: Unsupported Media Type

#### Body Parameters: application/json (object)
- **message** (string)
  May occur when providing an invalid 'Content-Type' header.
- **code** (string)
  

### 406: Not Acceptable

#### Body Parameters: application/json (object)
- **message** (string)
  May occur when providing an invalid 'Accept' header.
- **code** (string)
  

### 400: Bad Request

#### Body Parameters: application/json (object)
- **message** (string)
  May occur when a request is not well-formed; that is, it fails to parse
successfully. This could be the case when some required parameters
are missing or, when malformed values are provided.

- **code** (string)
  

### 403: Forbidden

#### Body Parameters: application/json (object)
- **message** (string)
  May occur when a transaction can't be balanced for fees.
- **code** (string)
  

### 404: Not Found

#### Body Parameters: application/json (object)
- **message** (string)
  May occur when a given walletId does not match with any known
wallets (because it has been deleted, or has never existed).

- **code** (string)
  
- **info** (object)
  

### 202: Accepted

#### Body Parameters: application/json (object)
- **id** (string(hex))
  A unique identifier for this transaction
- **amount** (object)
  An amount of Ada spent or received, from the perspective of the wallet.

That is, for outgoing transaction, it represents the amount of Ada consumed
as inputs including the amount of Ada spent as fees or deposits.

For incoming transaction, it represents the total amount of Ada received to
addresses that belong to the wallet.

- **fee** (object)
  Coins, in Lovelace. Only relates to 'Ada'. Refer to `assets` for multi-assets wallets instead.
- **deposit_taken** (object)
  Coins, in Lovelace. Only relates to 'Ada'. Refer to `assets` for multi-assets wallets instead.
- **deposit_returned** (object)
  Coins, in Lovelace. Only relates to 'Ada'. Refer to `assets` for multi-assets wallets instead.
- **inserted_at** (object)
  A reference to a particular time slot, and the block height at that point.
- **expires_at** (object)
  A reference to a particular time slot.
- **pending_since** (object)
  A reference to a particular time slot, and the block height at that point.
- **depth** (object)
  <span style="position: relative; left: 35px; top: -21px; vertical-align: middle; background-color: rgba(142, 142, 220, 0.05); color: rgba(50, 50, 159, 0.9); margin: 0 5px; padding: 0 5px; border: 1px solid rgba(50, 50, 159, 0.1); line-height: 20px; font-size: 13px; border-radius: 2px;">
<strong>if:</strong> status == in_ledger
</span><br/>
Current depth of the transaction in the local chain

- **direction** (string)
  
- **inputs** (array[object])
  A list of transaction inputs.

`assets` and `address` are always present for `outgoing`
transactions but generally absent for `incoming`
transactions. This information is present on the Cardano explorer,
but is not tracked by the wallet.

- **outputs** (array[object])
  A list of target outputs with amounts specified.

When creating a new transaction, the wallet software ensures that all
user-specified transaction outputs have ada amounts that satisfy the ledger
minimum UTxO rule:

- If a user-specified transaction output has an ada `amount` that is
  **zero**, the wallet software will automatically assign a minimal amount
  of ada to the output so that it satisfies the ledger minimum UTxO rule.

- If a user-specified transaction output has an ada `amount` that is
  **non-zero**, the wallet software will verify that the specified amount
  is large enough to satisfy the ledger minimum UTxO rule. If the amount is
  not large enough, the wallet software will return a `utxo_too_small`
  error, together with a revised ada amount that does satisfy the minimum
  UTxO rule.

- **collateral** (array[object])
  A list of transaction inputs used for collateral.

- **collateral_outputs** (array[object])
  A list of collateral return outputs with amounts specified.
- **withdrawals** (array[object])
  A list of withdrawals from stake addresses.
- **status** (string)
  Current transaction status.

  ```
       *-----------*
  ---> |  PENDING  |----------------*
       *-----------*                |
             |                      |
             V                      V
       *-----------*          *-----------*
       |           |---------->  EXPIRED  |
       |           |  (ttl)   *-----------*
       | SUBMITTED |
       |           <----------------*
       |           |                |
       *-----------*           (rollback)
              |                     |
         (in ledger)          *-----------*
              |               |           |
              *---------------> IN_LEDGER |
                              |           |
                              *-----------*
  ```

- **metadata** (object | null)
  **⚠️ WARNING ⚠️**

_Please note that metadata provided in a transaction will be
stored on the blockchain forever. Make sure not to include any sensitive data,
in particular personally identifiable information (PII)._

Extra application data attached to the transaction.

Cardano allows users and developers to embed their own
authenticated metadata when submitting transactions. Metadata can
be expressed as a JSON object with some restrictions:

1. All top-level keys must be integers between `0` and `2^64 - 1`.

2. Each metadata value is tagged with its type.

3. Strings must be at most 64 bytes when UTF-8 encoded.

4. Bytestrings are hex-encoded, with a maximum length of 64 bytes.

Metadata aren't stored as JSON on the Cardano blockchain but are
instead stored using a compact binary encoding (CBOR).

The binary encoding of metadata values supports three simple types:

* Integers in the range `-(2^64 - 1)` to `2^64 - 1`
* Strings (UTF-8 encoded)
* Bytestrings

And two compound types:

* Lists of metadata values
* Mappings from metadata values to metadata values

It is possible to transform any JSON object into this schema.

However, if your application uses floating point values, they will
need to be converted somehow, according to your
requirements. Likewise for `null` or `bool` values. When reading
metadata from chain, be aware that integers may exceed the
javascript numeric range, and may need special "bigint" parsing.

- **script_validity** (string | null)
  Indicates whether the phase-2 monetary policy script (e.g. Plutus script)
used in the transaction validated or not. Validity may be null if this
transaction was from an era that doesn't support phase-2 monetary policy
scripts, or is a pending transaction (we don't know if validation passed or
failed until the transaction hits the ledger).

- **certificates** (array[object])
  
- **mint** (object)
  
- **burn** (object)
  
- **validity_interval** (object)
  
- **script_integrity** (string(bech32))
  A script data integrity hash - 32 bytes
- **extra_signatures** (array[string(bech32)])
  An extra signature hash - 28 bytes


[Powered by Bump.sh](https://bump.sh)