> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orafi.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Crypto Settlements

> Add, list, and remove saved crypto wallet addresses for payouts.

## The crypto account object

A crypto settlement account is a saved on-chain wallet address linked to your business profile. Once added, it can be used as a trusted payout destination without re-signing each time.

<ResponseField name="id" type="string">
  Unique identifier for the settlement account.
</ResponseField>

<ResponseField name="walletAddress" type="string">
  On-chain wallet address saved for payouts.
</ResponseField>

<ResponseField name="network" type="string">
  Saved network for wallet address.
</ResponseField>

<ResponseField name="profileId" type="string">
  Business profile that owns this settlement account.
</ResponseField>

<ResponseExample>
  ```json The crypto account object theme={null}
  {
    "id": "854da716-03bf-4bcf-9eba-3302208f8f36",
    "walletAddress": "0x711e00869390d0b5...52de4",
    "profileId": "84a9f045-8a21-4ce4-a7a0-828265c0021b"
  }
  ```
</ResponseExample>

***

## Add a crypto account

<div className="api-method-box">
  <span className="api-method post">POST</span> `/settlement/crypto`
</div>

Links a new wallet address to your profile. Requires a signed message to prove wallet ownership.

### Request body

<ParamField body="walletAddress" type="string" required>
  Destination wallet address to save.
</ParamField>

<ParamField body="network" type="string" required>
  Blockchain network the wallet belongs to.
</ParamField>

<ParamField body="alias" type="string" required>
  Placeholder for wallet.
</ParamField>

<ResponseExample>
  ```bash cURL theme={null}
  curl -X POST https://api.orafi.app/settlement/crypto \
    -H "Content-Type: application/json" \
    -H "x-api-key: ora_test_your_api_key" \
    -d '{
      "walletAddress": "0x871cf48ff1847e7a796ed69a04250323df16a66d43b25fee5e1619d82f55c2d3",
      "network": "SUI",
      "alias": "my_wallet"
    }'
  ```

  ```javascript Node.js theme={null}
  const response = await fetch("https://api.orafi.app/settlement/crypto", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-api-key": "ora_test_your_api_key"
    },
    body: JSON.stringify({
      walletAddress: "0x871cf48ff1847e7a796ed69a04250323df16a66d43b25fee5e1619d82f55c2d3",
      bytes: "QWRkIGNyeXB0byBhY2NvdW50IGFzIGEgc2V0dGxlbWVudCBhY2NvdW50",
      signature: "AEQCjzWKVlM5Ht4Qbwk/ZpPeWbL4YRFFY..."
    })
  });
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      "https://api.orafi.app/settlement/crypto",
      headers={
          "Content-Type": "application/json",
          "x-api-key": "ora_test_your_api_key"
      },
      json={
          "walletAddress": "0x871cf48ff1847e7a796ed69a04250323df16a66d43b25fee5e1619d82f55c2d3",
          "bytes": "QWRkIGNyeXB0byBhY2NvdW50IGFzIGEgc2V0dGxlbWVudCBhY2NvdW50",
          "signature": "AEQCjzWKVlM5Ht4Qbwk/ZpPeWbL4YRFFY..."
      }
  )
  ```

  ```json 200 theme={null}
  {
    "success": true,
    "message": "Settlement account added successfully",
    "data": null
  }
  ```
</ResponseExample>

***

## List crypto accounts

<div className="api-method-box">
  <span className="api-method get">GET</span> `/settlement/crypto`
</div>

Returns all saved crypto settlement accounts for the authenticated profile.

<ResponseExample>
  ```bash cURL theme={null}
  curl -X GET https://api.orafi.app/settlement/crypto \
    -H "x-api-key: ora_test_your_api_key"
  ```

  ```javascript Node.js theme={null}
  const response = await fetch("https://api.orafi.app/settlement/crypto", {
    headers: { "x-api-key": "ora_test_your_api_key" }
  });
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://api.orafi.app/settlement/crypto",
      headers={"x-api-key": "ora_test_your_api_key"}
  )
  ```

  ```json 200 theme={null}
  {
    "success": true,
    "message": "Settlement accounts retrieved successfully",
    "data": [
      {
        "id": "854da716-03bf-4bcf-9eba-3302208f8f36",
        "walletAddress": "0x711e00869390d0b59c59c68a42a2a95bfbaeb8e60423a0aa3c76492701352de4",
        "profileId": "84a9f045-8a21-4ce4-a7a0-828265c0021b"
      },
      {
        "id": "4fcf81a9-3243-4634-8b91-b9ecc6b4afe9",
        "walletAddress": "0x871cf48ff1847e7a796ed69a04250323df16a66d43b25fee5e1619d82f55c2d3",
        "profileId": "84a9f045-8a21-4ce4-a7a0-828265c0021b"
      }
    ]
  }
  ```
</ResponseExample>

***

## Delete a crypto account

<div className="api-method-box">
  <span className="api-method delete">DELETE</span> `/settlement/crypto/{accountId}`
</div>

Permanently removes a saved wallet address from your settlement accounts.

### Path parameters

<ParamField path="accountId" type="string" required>
  ID of the settlement account to delete.
</ParamField>

<ResponseExample>
  ```bash cURL theme={null}
  curl -X DELETE https://api.orafi.app/settlement/crypto/854da716-03bf-4bcf-9eba-3302208f8f36 \
    -H "x-api-key: ora_test_your_api_key"
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api.orafi.app/settlement/crypto/854da716-03bf-4bcf-9eba-3302208f8f36",
    {
      method: "DELETE",
      headers: { "x-api-key": "ora_test_your_api_key" }
    }
  );
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      "https://api.orafi.app/settlement/crypto/854da716-03bf-4bcf-9eba-3302208f8f36",
      headers={"x-api-key": "ora_test_your_api_key"}
  )
  ```

  ```json 200 theme={null}
  {
    "success": true,
    "message": "Account deleted successfully",
    "data": null
  }
  ```
</ResponseExample>
