### Webhook Payload Example

Source: https://docs.blockradar.co/essentials/auto-settlements

Example of a webhook payload for a successful swap event, including details on distinguishing auto-settlements.

```APIDOC
## Webhook Payload Example

This is an example of a webhook payload for a successful swap event.

### Request Body
```json
{
  "event": "swap.success",
  "data": {
    "id": "99a2b490-0798-460b-9265-4d99f182fe52",
    "reference": "ZMxcorDGtf",
    "senderAddress": "0xAA2d5fd5e7bE97E214f8565DCf3a4862719960b5",
    "recipientAddress": "0xb55c054D8eE75224E1033e6eC775B4F62D942b43",
    "amount": "5",
    "status": "SUCCESS",
    "type": "SWAP",
    "network": "mainnet",
    "toAmount": "4.965398",
    "rate": "0.9930796000000001",
    "asset": {
      "name": "USD Coin",
      "symbol": "USDC",
      "network": "mainnet"
    },
    "toAsset": {
      "name": "Tether USD",
      "symbol": "USDT",
      "network": "mainnet"
    },
    "toBlockchain": {
      "name": "optimism",
      "slug": "optimism"
    },
    "toWallet": {
      "name": "Optimism Mainnet Wallet",
      "address": "0xb55c054D8eE75224E1033e6eC775B4F62D942b43"
    },
    "metadata": {
      "swapAutoSettlement": {
        "rule": {
          "id": "rule-id-123",
          "name": "USDT to USDC on Base",
          "order": "RECOMMENDED",
          "slippageTolerance": 5,
          "source": {
            "assets": ["USDC", "USDT"],
            "minAmount": "1",
            "maxAmount": "1000"
          },
          "destination": {
            "blockchain": "optimism",
            "asset": "USDC",
            "address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22"
          }
        },
        "settleAmount": "5"
      },
      "transactionId": "transaction-id"
    }
  }
}
```

### Distinguishing Auto-Settlements from Regular Swaps

The webhook payload includes metadata that helps identify auto-settlement transactions:

| Field                                      | Description                                                    |
| ------------------------------------------ | -------------------------------------------------------------- |
| `metadata.swapAutoSettlement.rule`         | Complete auto-settlement rule payload that triggered this swap |
| `metadata.swapAutoSettlement.settleAmount` | Amount that was settled according to the rule                  |
| `metadata.transactionId`                   | Internal transaction ID for tracking                           |

<Note>
  When `metadata.swapAutoSettlement` is present, the swap was triggered by an auto-settlement rule. The `rule` field contains the complete rule configuration, not just an ID.
</Note>

### Key Webhook Data Fields

| Field          | Description                                                         |
| -------------- | ------------------------------------------------------------------- |
| `toAmount`     | Final amount received after swap (accounting for fees and slippage) |
| `rate`         | Exchange rate used for the swap                                     |
| `toAsset`      | Destination asset details (USDT in this example)                    |
| `toBlockchain` | Destination blockchain network (Optimism in this example)           |
| `toWallet`     | Destination wallet that received the converted assets               |
| `assetSwept`   | Whether the original assets were swept after conversion             |
```

--------------------------------

### Webhook Payload Example in JSON

Source: https://docs.blockradar.co/essentials/auto-settlements

This JSON example shows the structure of a webhook payload for a successful swap event, including metadata for auto-settlement rules. It has no dependencies and serves as input for webhook consumers, containing fields like event type, data details, and rates. Note that this is a static example and does not include dynamic generation logic.

```json
{
  "event": "swap.success",
  "data": {
    "id": "99a2b490-0798-460b-9265-4d99f182fe52",
    "reference": "ZMxcorDGtf",
    "senderAddress": "0xAA2d5fd5e7bE97E214f8565DCf3a4862719960b5",
    "recipientAddress": "0xb55c054D8eE75224E1033e6eC775B4F62D942b43",
    "amount": "5",
    "status": "SUCCESS",
    "type": "SWAP",
    "network": "mainnet",
    "toAmount": "4.965398",
    "rate": "0.9930796000000001",
    "asset": {
      "name": "USD Coin",
      "symbol": "USDC",
      "network": "mainnet"
    },
    "toAsset": {
      "name": "Tether USD",
      "symbol": "USDT",
      "network": "mainnet"
    },
    "toBlockchain": {
      "name": "optimism",
      "slug": "optimism"
    },
    "toWallet": {
      "name": "Optimism Mainnet Wallet",
      "address": "0xb55c054D8eE75224E1033e6eC775B4F62D942b43"
    },
    "metadata": {
      "swapAutoSettlement": {
        "rule": {
          "id": "rule-id-123",
          "name": "USDT to USDC on Base",
          "order": "RECOMMENDED",
          "slippageTolerance": 5,
          "source": {
            "assets": ["USDC", "USDT"],
            "minAmount": "1",
            "maxAmount": "1000"
          },
          "destination": {
            "blockchain": "optimism",
            "asset": "USDC",
            "address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22"
          }
        },
        "settleAmount": "5"
      },
      "transactionId": "transaction-id"
    }
  }
}
```

--------------------------------

### GET /websites/blockradar_co

Source: https://docs.blockradar.co/api-reference/auto-settlements/child-address

Fetches auto settlement configurations including source and destination details. Useful for retrieving active settlement setups.

```APIDOC
## GET /websites/blockradar_co

### Description
Fetches auto settlement configurations including source and destination details. Useful for retrieving active settlement setups.

### Method
GET

### Endpoint
/websites/blockradar_co

### Parameters
#### Query Parameters
- **None** - No query parameters required.

#### Request Body
- **None** - No request body required.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **statusCode** (integer) - HTTP status code
- **message** (string) - Success message
- **content** (array) - List of settlement configurations
  - **id** (string) - Unique identifier
  - **name** (string) - Settlement name
  - **isActive** (boolean) - Indicates if the settlement is active
  - **order** (string) - Settlement priority (e.g., FASTEST)
  - **slippageTolerance** (string) - Slippage tolerance percentage
  - **source** (object) - Source configuration
    - **blockchain** (string) - Source blockchain
    - **assets** (array) - Supported assets
    - **minAmount** (string) - Minimum transfer amount
    - **maxAmount** (string) - Maximum transfer amount
  - **destination** (object) - Destination configuration
    - **blockchain** (string) - Destination blockchain
    - **asset** (string) - Target asset
    - **address** (string) - Destination address
  - **createdAt** (string) - Creation timestamp
  - **updatedAt** (string) - Last updated timestamp

#### Response Example
```json
{
  "statusCode": 200,
  "message": "Auto settlement fetched successfully",
  "content": [
    {
      "id": "48c52f4a-c0bf-45c9-a322-1fef00f00431",
      "name": "Swap from USDT to OP USDC",
      "isActive": true,
      "order": "FASTEST",
      "slippageTolerance": "5",
      "source": {
        "blockchain": "base",
        "assets": ["USDT"],
        "minAmount": "1",
        "maxAmount": "1000"
      },
      "destination": {
        "blockchain": "optimism",
        "asset": "USDC",
        "address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22"
      },
      "createdAt": "2025-08-26T17:28:38.273Z",
      "updatedAt": "2025-08-26T17:32:08.108Z"
    }
  ]
}
```
```

--------------------------------

### GET /api/wallets/{wallet_id}

Source: https://docs.blockradar.co/api-reference/withdraw/child-address

Retrieves details for a specific wallet. Useful for getting wallet information such as address and associated business.

```APIDOC
## GET /api/wallets/{wallet_id}

### Description
Retrieves details for a specific wallet.

### Method
GET

### Endpoint
/api/wallets/{wallet_id}

### Parameters
#### Path Parameters
- **wallet_id** (string) - Required - The unique identifier of the wallet.

#### Query Parameters
None

#### Request Body
None

### Request Example
{
  "wallet_id": "4465468a-3c36-4536-918a-91d689e18a74"
}

### Response
#### Success Response (200)
- **address** (string) - The wallet address.
- **business** (object) - Information about the associated business.
  - id (string) - The business identifier.
  - name (string) - The business name.
- **createdAt** (string) - The creation timestamp.
- **derivationPath** (string) - The derivation path of the wallet.
- **description** (string) - A description of the wallet.
- **id** (string) - The unique identifier of the wallet.
- **isActive** (boolean) - Whether the wallet is active.
- **name** (string) - The name of the wallet.
- **network** (string) - The network the wallet belongs to.
- **status** (string) - The wallet status.
- **updatedAt** (string) - The last updated timestamp.

#### Response Example
{
  "address": "0x947514e4B803e312C312da0F1B41fEDdbe15ae7a",
  "business": {
    "id": "4b96c271-35eb-45e8-b558-6a53f95df601",
    "name": "Test One Inc"
  },
  "createdAt": "2024-08-22T15:29:11.387Z",
  "derivationPath": "m/44'/60'/0'/0/0",
  "description": "This is BNB smart chain testnet master wallet",
  "id": "4465468a-3c36-4536-918a-91d689e18a74",
  "isActive": true,
  "name": "BNB smart chain Master Wallet",
  "network": "testnet",
  "status": "ACTIVE",
  "updatedAt": "2024-10-30T13:11:56.221Z"
}
```

--------------------------------

### Initiate Gateway Deposit

Source: https://docs.blockradar.co/api-reference/gateway/deposit

This endpoint allows you to initiate a gateway deposit.

```APIDOC
## POST /websites/blockradar_co/deposit

### Description
Initiates a gateway deposit with the provided amount, an optional reference, and optional metadata.

### Method
POST

### Endpoint
/websites/blockradar_co/deposit

### Parameters
#### Query Parameters
None

#### Request Body
- **amount** (string) - Required - The amount to be deposited.
- **reference** (string) - Optional - This would be the transaction reference.
- **metadata** (object) - Optional - This would be attached to the transaction payload.

### Request Example
```json
{
  "amount": "100.50",
  "reference": "TXN12345",
  "metadata": {
    "user_id": "user_abc",
    "order_id": "order_xyz"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the deposit initiation (e.g., "pending").
- **deposit_id** (string) - A unique identifier for the initiated deposit.

#### Response Example
```json
{
  "status": "pending",
  "deposit_id": "dep_789abc"
}
```
```

--------------------------------

### OpenAPI Specification for AML Lookup Endpoint

Source: https://docs.blockradar.co/api-reference/anti-money-laundering/lookup

This YAML defines the OpenAPI path for the /v1/aml/lookup GET endpoint, including server URL, API key security in headers, required query parameters for address and blockchain, and a 200 response with JSON schema containing isBlacklisted boolean, message, and statusCode. It has no request body or path parameters, and supports Ethereum as an example blockchain. Limitations include dependency on valid API key and supported blockchains.

```yaml
get /v1/aml/lookup
paths:
  path: /v1/aml/lookup
  method: get
  servers:
    - url: https://api.blockradar.co
  request:
    security:
      - title: apiKey
        parameters:
          query: {}
          header:
            x-api-key:
              type: apiKey
          cookie: {}
    parameters:
      path: {}
      query:
        address:
          schema:
            - type: string
              example: '0x451dEFC27B45808078e875556AF06bCFdC697BA4'
        blockchain:
          schema:
            - type: string
              example: ethereum
      header: {}
      cookie: {}
    body: {}
  response:
    '200':
      application/json:
        schemaArray:
          - type: object
            properties:
              data:
                allOf:
                  - type: object
                    properties:
                      isBlacklisted:
                        type: boolean
                        example: false
              message:
                allOf:
                  - type: string
                    example: Anti Money Laundering lookup
              statusCode:
                allOf:
                  - type: number
                    example: 200
        examples:
          '200':
            value:
              data:
                isBlacklisted: false
              message: Anti Money Laundering lookup
              statusCode: 200
        description: '200'
  deprecated: false
  type: path
components:
  schemas: {}
```

--------------------------------

### User Data API

Source: https://docs.blockradar.co/api-reference/swap/master-wallet-execute

This endpoint provides details about user configurations, including password requirements, email verification status, and personal information.

```APIDOC
## GET /api/users/{userId}

### Description
Retrieves user details and configurations.

### Method
GET

### Endpoint
/api/users/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
{
  "userId": "ad0ad16d-dc56-48e9-85da-a86adabff48e"
}

### Response
#### Success Response (200)
- **configurations** (object) - User configurations.
  - **setNewPasswordRequired** (boolean) - Indicates if a new password is required.
  - **createdAt** (string) - Timestamp of user creation.
  - **email** (string) - User's email address.
  - **emailVerified** (boolean) - Indicates if the email is verified.
  - **firstname** (string) - User's first name.
  - **id** (string) - User's unique ID.
  - **lastname** (string) - User's last name.
  - **twoFactorAuthEnabled** (boolean) - Indicates if two-factor authentication is enabled.
  - **updatedAt** (string) - Timestamp of last update.

#### Response Example
{
  "configurations": {
    "setNewPasswordRequired": false,
    "createdAt": "2024-08-22T15:28:37.522Z",
    "email": "rararo3041@daypey.com",
    "emailVerified": true,
    "firstname": "Test",
    "id": "ad0ad16d-dc56-48e9-85da-a86adabff48e",
    "lastname": "One",
    "twoFactorAuthEnabled": true,
    "updatedAt": "2025-03-27T16:28:26.592Z"
  }
}
```

--------------------------------

### Deposit Initiated Successfully

Source: https://docs.blockradar.co/api-reference/gateway/deposit

This endpoint details a successful deposit initiation. It includes information about the transaction, sender, recipient, token, and associated wallet.

```APIDOC
## GET /websites/blockradar_co/deposit

### Description
This endpoint provides details for a successfully initiated deposit transaction. It outlines the transaction specifics, including amounts, addresses, token information, and the status of the deposit.

### Method
GET

### Endpoint
/websites/blockradar_co/deposit

### Parameters
#### Query Parameters
- **reference** (string) - Optional - A unique reference identifier for the deposit.
- **senderAddress** (string) - Optional - The blockchain address of the sender.
- **recipientAddress** (string) - Optional - The blockchain address of the recipient.

### Request Example
```json
{
  "reference": "IsrFHR26J",
  "senderAddress": "0x947514e4B803e312C312da0F1B41fEDdbe15ae7a",
  "recipientAddress": "0x0077777d7EBA4688BDeF3E311b846F25870A19B9"
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates the success status of the deposit initiation.
- **statusCode** (integer) - The HTTP status code, expected to be 200 for success.
- **description** (string) - A brief description of the response, such as 'Deposit Succesfully / Blockchain not supported'.
- **data** (object) - Contains the detailed information about the deposit transaction:
    - **rate** (any) - The exchange rate, can be null.
    - **rateUSD** (string) - The exchange rate in USD.
    - **reason** (string) - Details about the transaction, including balance before and network fee.
    - **recipientAddress** (string) - The recipient's blockchain address.
    - **reference** (string) - The unique reference identifier for the deposit.
    - **senderAddress** (string) - The sender's blockchain address.
    - **signedTransaction** (any) - The signed transaction details, can be null.
    - **status** (string) - The current status of the deposit (e.g., 'PENDING').
    - **toAmount** (any) - The amount sent to the destination, can be null.
    - **toCurrency** (any) - The currency of the destination amount, can be null.
    - **tokenAddress** (string) - The contract address of the token being deposited.
    - **type** (string) - The type of transaction, e.g., 'GATEWAY_DEPOSIT'.
    - **updatedAt** (string) - The timestamp when the record was last updated.
    - **wallet** (object) - Information about the associated wallet:
        - **address** (string) - The wallet's blockchain address.
        - **configurations** (object) - Wallet configuration details:
            - **autoSweeping** (object) - Auto-sweeping configuration:
                - **isActive** (boolean) - Whether auto-sweeping is active.
                - **threshold** (number) - The threshold for auto-sweeping.
            - **withdrawal** (object) - Withdrawal configuration:
                - **gasless** (object) - Gasless withdrawal configuration:
                    - **isActive** (boolean) - Whether gasless withdrawal is active.
                    - **operator** (string) - The operator used for gasless withdrawal condition.
                    - **threshold** (number) - The threshold for gasless withdrawal.
        - **createdAt** (string) - The timestamp when the wallet was created.
        - **derivationPath** (string) - The derivation path for the wallet.
        - **description** (string) - A description of the wallet.
        - **id** (string) - The unique identifier for the wallet.
        - **isActive** (boolean) - Whether the wallet is active.
        - **name** (string) - The name of the wallet.
        - **network** (string) - The blockchain network the wallet is on.
        - **status** (string) - The status of the wallet (e.g., 'ACTIVE').
        - **updatedAt** (string) - The timestamp when the wallet was last updated.

#### Response Example
```json
{
  "message": "Deposit initiated successfully",
  "statusCode": 200,
  "description": "Deposit Succesfully / Blockchain not supported",
  "data": {
    "rate": null,
    "rateUSD": "1",
    "reason": "Balance Before: 8.2 USDC | Network Fee: 2.99004e-13 USDC | Gasless: false",
    "recipientAddress": "0x0077777d7EBA4688BDeF3E311b846F25870A19B9",
    "reference": "IsrFHR26J",
    "senderAddress": "0x947514e4B803e312C312da0F1B41fEDdbe15ae7a",
    "signedTransaction": null,
    "status": "PENDING",
    "toAmount": null,
    "toCurrency": null,
    "tokenAddress": "0x5425890298aed601595a70AB815c96711a31Bc65",
    "type": "GATEWAY_DEPOSIT",
    "updatedAt": "2025-08-17T02:45:32.188Z",
    "wallet": {
      "address": "0x947514e4B803e312C312da0F1B41fEDdbe15ae7a",
      "configurations": {
        "autoSweeping": {
          "isActive": true,
          "threshold": 0
        },
        "withdrawal": {
          "gasless": {
            "isActive": false,
            "operator": "gt",
            "threshold": 0
          }
        }
      },
      "createdAt": "2025-06-13T22:41:28.977Z",
      "derivationPath": "m/44'/60'/0'/0/0",
      "description": "Avalanche Master wallet",
      "id": "79c7a18a-07be-4c1f-a046-94bf4964f392",
      "isActive": true,
      "name": "Avalanche",
      "network": "testnet",
      "status": "ACTIVE",
      "updatedAt": "2025-06-13T22:41:28.977Z"
    }
  }
}
```
```

--------------------------------

### GET /api/assets

Source: https://docs.blockradar.co/api-reference/asset/get-wallet-assets

Retrieves a list of supported cryptocurrency assets. The response includes asset details such as blockchain, address, symbol, and activation status. This endpoint is useful for getting an overview of available assets on the platform.

```APIDOC
## GET /api/assets

### Description
Fetches a list of active cryptocurrency assets supported by the platform, including their blockchain information, token standards, and current status.

### Method
GET

### Endpoint
/api/assets

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
No request body required for this GET endpoint.

### Response
#### Success Response (200)
- **assets** (array) - List of asset objects
  - **asset** (object) - Asset details
    - **address** (string) - The contract address of the asset
    - **blockchain** (object) - Blockchain information
      - **createdAt** (string) - Creation timestamp
      - **derivationPath** (string) - Derivation path for wallets
      - **id** (string) - Unique blockchain ID
      - **isActive** (boolean) - Active status of blockchain
      - **isEvmCompatible** (boolean) - EVM compatibility
      - **logoUrl** (string) - URL to blockchain logo
      - **name** (string) - Blockchain name
      - **slug** (string) - Slug identifier
      - **symbol** (string) - Blockchain symbol
      - **tokenStandard** (string) - Token standard (e.g., BEP20)
      - **updatedAt** (string) - Last update timestamp
    - **createdAt** (string) - Asset creation timestamp
    - **decimals** (number) - Number of decimals for the asset
    - **id** (string) - Unique asset ID
    - **isActive** (boolean) - Active status of asset
    - **logoUrl** (string) - URL to asset logo
    - **name** (string) - Asset name
    - **network** (string) - Network type (e.g., testnet)
    - **standard** (string|null) - Token standard
    - **symbol** (string) - Asset symbol
    - **updatedAt** (string) - Asset update timestamp
  - **createdAt** (string) - Entry creation timestamp
  - **id** (string) - Entry unique ID
  - **isActive** (boolean) - Entry active status
  - **updatedAt** (string) - Entry update timestamp
- **message** (string) - Success message
- **statusCode** (number) - HTTP status code

#### Response Example
{
  "assets": [
    {
      "asset": {
        "address": "",
        "blockchain": {
          "createdAt": "2024-05-14T11:53:33.106Z",
          "derivationPath": "m/44'/60'/0'/0",
          "id": "b80d3d5e-16f1-4d99-be5e-6dfcd27f89aa",
          "isActive": true,
          "isEvmCompatible": true,
          "logoUrl": "https://res.cloudinary.com/blockradar/image/upload/v1716800080/crypto-assets/bnb-bnb-logo_e4qdyk.png",
          "name": "BNB smart chain",
          "slug": "bnb-smart-chain",
          "symbol": "bnb",
          "tokenStandard": "BEP20",
          "updatedAt": "2024-06-14T22:36:43.716Z"
        },
        "createdAt": "2024-05-14T11:53:33.106Z",
        "decimals": 18,
        "id": "some-id",
        "isActive": true,
        "logoUrl": "https://res.cloudinary.com/blockradar/image/upload/v1716800080/crypto-assets/bnb-bnb-logo_e4qdyk.png",
        "name": "BNB",
        "network": "testnet",
        "standard": null,
        "symbol": "BNB",
        "updatedAt": "2024-10-27T07:52:16.162Z"
      },
      "createdAt": "2024-08-22T09:29:11.387Z",
      "id": "98582300-2f1d-4ef4-99f2-4361319fc776",
      "isActive": true,
      "updatedAt": "2024-08-22T09:29:11.387Z"
    },
    {
      "asset": {
        "address": "0x337610d27c682E347C9cD60BD4b3b107C9d34dDd",
        "blockchain": {
          "createdAt": "2024-05-14T11:53:33.106Z",
          "derivationPath": "m/44'/60'/0'/0",
          "id": "b80d3d5e-16f1-4d99-be5e-6dfcd27f89aa",
          "isActive": true,
          "isEvmCompatible": true,
          "logoUrl": "https://res.cloudinary.com/blockradar/image/upload/v1716800080/crypto-assets/bnb-bnb-logo_e4qdyk.png",
          "name": "BNB smart chain",
          "slug": "bnb-smart-chain",
          "symbol": "bnb",
          "tokenStandard": "BEP20",
          "updatedAt": "2024-06-14T22:36:43.716Z"
        },
        "createdAt": "2024-05-14T11:53:33.680Z",
        "decimals": 18,
        "id": "1890db58-f624-4972-a72b-e25387a81520",
        "isActive": true,
        "logoUrl": "https://res.cloudinary.com/blockradar/image/upload/v1716800082/crypto-assets/tether-usdt-logo_wx7rwh.png",
        "name": "Tether USD",
        "network": "testnet",
        "standard": "BEP20",
        "symbol": "USDT",
        "updatedAt": "2024-06-14T22:36:43.868Z"
      },
      "createdAt": "2024-08-22T10:33:45.481Z",
      "id": "ae455f23-3824-4125-baab-d158315cbcbd",
      "isActive": true,
      "updatedAt": "2024-08-22T10:33:45.481Z"
    }
  ],
  "message": "Assets fetched successfully",
  "statusCode": 200
}
```

--------------------------------

### POST /v1/gateway/deposit/{walletId}

Source: https://docs.blockradar.co/api-reference/gateway/deposit

Initiates a deposit to a specified wallet ID. Requires an API key for authentication and accepts deposit amount in the request body.

```APIDOC
## POST /v1/gateway/deposit/{walletId}

### Description
Initiates a deposit to a specified wallet ID. Requires an API key for authentication and accepts deposit amount in the request body.

### Method
POST

### Endpoint
https://api.blockradar.co/v1/gateway/deposit/{walletId}

### Parameters
#### Path Parameters
- **walletId** (string) - Required - The ID of the wallet to deposit funds into.

#### Query Parameters
None

#### Header Parameters
- **x-api-key** (apiKey) - Required - Your Blockradar API key.

#### Request Body
- **amount** (string) - Required - The amount to deposit.

### Request Example
```json
{
  "amount": "10"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the details of the deposit transaction.
  - **amlScreening** (object) - Information about AML screening.
    - **message** (string) - The AML screening message.
    - **provider** (string) - The provider of the AML screening.
    - **status** (string) - The status of the AML screening.
  - **amount** (string) - The deposited amount.
  - **amountPaid** (string) - The amount that was actually paid.
  - **amountUSD** (string) - The deposited amount in USD.
  - **asset** (object) - Details about the asset being deposited.
    - **address** (string) - The asset's address.
    - **createdAt** (string) - The creation timestamp of the asset.
    - **currency** (string) - The currency of the asset.
    - **decimals** (number) - The number of decimals for the asset.
    - **id** (string) - The unique identifier for the asset.
    - **isActive** (boolean) - Indicates if the asset is active.
    - **isNative** (boolean) - Indicates if the asset is native.
    - **name** (string) - The name of the asset.
    - **network** (string) - The network the asset is on.
    - **standard** (string/null) - The standard of the asset (nullable).
    - **symbol** (string) - The symbol of the asset.
    - **updatedAt** (string) - The last update timestamp of the asset.
  - **assetSwept** (any/null) - Information about swept assets (nullable).
  - **assetSweptAmount** (any/null) - The amount of swept assets (nullable).
  - **assetSweptAt** (any/null) - The timestamp of asset sweep (nullable).
  - **assetSweptGasFee** (any/null) - The gas fee for asset sweep (nullable).
  - **assetSweptHash** (any/null) - The transaction hash for asset sweep (nullable).
  - **assetSweptRecipientAddress** (any/null) - The recipient address for asset sweep (nullable).
  - **assetSweptSenderAddress** (any/null) - The sender address for asset sweep (nullable).
  - **blockHash** (any/null) - The block hash of the transaction (nullable).
  - **blockNumber** (any/null) - The block number of the transaction (nullable).
  - **blockchain** (object) - Information about the blockchain.
    - **createdAt** (string) - The creation timestamp of the blockchain record.
    - **derivationPath** (string) - The derivation path for the blockchain.

#### Response Example
```json
{
  "data": {
    "amlScreening": {
      "message": "Address is not sanctioned",
      "provider": "ofac, fbi, tether, circle",
      "status": "success"
    },
    "amount": "5",
    "amountPaid": "5",
    "amountUSD": "5",
    "asset": {
      "address": "0x5425890298aed601595a70AB815c96711a31Bc65",
      "createdAt": "2025-06-13T22:38:16.058Z",
      "currency": "USD",
      "decimals": 6,
      "id": "e097a26e-0df5-4610-95d3-95f6cd1aa5c6",
      "isActive": true,
      "isNative": false,
      "name": "USD Coin",
      "network": "testnet",
      "standard": null,
      "symbol": "USDC",
      "updatedAt": "2025-06-13T22:38:16.058Z"
    },
    "assetSwept": null,
    "assetSweptAmount": null,
    "assetSweptAt": null,
    "assetSweptGasFee": null,
    "assetSweptHash": null,
    "assetSweptRecipientAddress": null,
    "assetSweptSenderAddress": null,
    "blockHash": null,
    "blockNumber": null,
    "blockchain": {
      "createdAt": "2025-06-13T22:30:37.053Z",
      "derivationPath": "m/44'/60'/0'/0"
    }
  }
}
```
```

--------------------------------

### GET /v1/wallets/{walletId}/auto-settlements/rules/{id}

Source: https://docs.blockradar.co/api-reference/auto-settlements/master-wallet-get-rule

Retrieves details of a specific auto-settlement rule associated with a wallet. Requires wallet ID and rule ID as path parameters.

```APIDOC
## GET /v1/wallets/{walletId}/auto-settlements/rules/{id}

### Description
Retrieves the details of a specific auto-settlement rule associated with a particular wallet.

### Method
GET

### Endpoint
/v1/wallets/{walletId}/auto-settlements/rules/{id}

### Parameters
#### Path Parameters
- **walletId** (string) - Required - The unique identifier of the wallet
- **id** (string) - Required - The unique identifier of the auto-settlement rule

#### Headers
- **x-api-key** (string) - Required - API key for authentication

### Response
#### Success Response (200)
- **data** (object) - Contains rule details
  - **destination** (object) - Settlement destination
    - **address** (string) - Destination wallet address
    - **asset** (string) - Asset to receive
    - **blockchain** (string) - Destination blockchain
  - **id** (string) - Rule identifier
  - **isActive** (boolean) - Rule activation status
  - **name** (string) - Rule name
  - **order** (string) - Execution priority
  - **slippageTolerance** (string) - Allowed slippage percentage
  - **source** (object) - Source parameters
    - **assets** (array) - Array of source assets
    - **blockchain** (string) - Source blockchain
    - **maxAmount** (string) - Maximum transfer amount
    - **minAmount** (string) - Minimum transfer amount
- **message** (string) - Success message
- **statusCode** (number) - HTTP status code

#### Response Example
{
  "data": {
    "destination": {
      "address": "0xD2b6be31932E0294F2ebD14a008C3f1E05B47BC4",
      "asset": "USDC",
      "blockchain": "optimism"
    },
    "id": "312ed6b6-cdde-4761-989d-c8e2b6047e19",
    "isActive": true,
    "name": "Swap from Base USDC to Optimism USDC",
    "order": "RECOMMENDED",
    "slippageTolerance": "5",
    "source": {
      "assets": ["USDC"],
      "blockchain": "base",
      "maxAmount": "1000",
      "minAmount": "1"
    }
  },
  "message": "Auto settlement rule fetched successfully",
  "statusCode": 200
}
```

--------------------------------

### Gateway Wallets API

Source: https://docs.blockradar.co/essentials/gateway

List all Gateway wallets and their unified balances.

```APIDOC
## GET /gateway/wallets

### Description
Retrieve a list of all wallets associated with your Gateway account, including their current unified USDC balances across all supported networks.

### Method
GET

### Endpoint
/gateway/wallets

### Parameters
(No parameters required)

### Request Example
(No request body required)

### Response
#### Success Response (200)
- **wallets** (array) - An array of wallet objects.
  - **address** (string) - The wallet address.
  - **balance** (string) - The unified USDC balance in this wallet.
  - **network** (string) - The blockchain network of the wallet.

#### Response Example
```json
{
  "wallets": [
    {
      "address": "0xWalletAddress1...",
      "balance": "1000.50",
      "network": "ethereum"
    },
    {
      "address": "0xWalletAddress2...",
      "balance": "500.75",
      "network": "polygon"
    }
  ]
}
```
```

--------------------------------

### Define GET endpoint for transaction webhook in OpenAPI (YAML)

Source: https://docs.blockradar.co/api-reference/transactions/webhook-logs

Specifies a GET request to fetch webhook details for a specific wallet transaction. Requires an API key passed in the header, and path parameters walletId and transactionsId. Returns a JSON payload with detailed webhook information, including attempts, timestamps, event type, payload metadata, AML screening, and amount details.

```yaml
get /v1/wallets/{walletId}/transactions/{transactionsId}/webhooks:
  paths:
    path: /v1/wallets/{walletId}/transactions/{transactionsId}/webhooks
    method: get
    servers:
      - url: https://api.blockradar.co
    request:
      security:
        - title: apiKey
          parameters:
            query: {}
            header:
              x-api-key:
                type: apiKey
            cookie: {}
      parameters:
        path:
          walletId:
            schema:
              - type: string
                required: true
 example: YOUR_WALLET_ID
          transactionsId:
            schema:
              - type: string
                required: true
                example: TRANSACTION_ID
        query: {}
        header: {}
        cookie: {}
      body: {}
    response:
      '200':
        application/json:
          schemaArray:
            - type: object
              properties:
                data:
                  allOf:
                    - type: array
                      items:
                        type: object
                        properties:
                          attempts:
                            type: number
                            example: 1
                          createdAt:
                            type: string
                            example: '2024-07-23T10:56:42.073Z'
                          event:
                            type: string
                            example: deposit.success
                          id:
                            type: string                            example: d6b0c629-2887-43f2-b812-f61e215c7ce8
                          payload:
                            type: object
                            properties:
                              address:
                                type: object
                                properties:
                                  address:
                                    type: string
                                    example: '0xd09693EbfDE205cDcDD830160f15BC8FdBf08654'
                                  configurations:
                                    type: object
                                    properties:
                                      aml:
                                        type: object
                                        properties:
                                          message:
                                            type: string
                                            example: Address is not sanctioned
                                          provider:
                                            type: string
                                            example: ofac
                                          status:
                                            type: string
                                            example: success
                                  createdAt:
                                    type: string
                                    example: '2024-07-23T09:10:50.267Z'
                                  derivationPath:
                                    type: string
                                    example: m/44'/60'/0'/0/48
                                  id:
                                    type: string
                                    example: 06823986-5f7d-42c3-9d10-f42cba7d95ea
                                  isActive:
                                    type: boolean
                                    example: true
                                  metadata:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        example: slack3 0x0e01 0x0e01
                                  name:
                                    type: string
                                    example: slack3 0x0e01
                                  network:
                                    type: string
                                    example: testnet
                                  type:
                                    type: string
                                    example: INTERNAL
                                  updatedAt:
                                    type: string
                                    example: '2024-07-23T09:10:50.267Z'
                              amlScreening:
                                type: object
                                properties:
                                  message:
                                    type: string
                                    example: Address is not sanctioned
                                  provider:
                                    type: string
                                    example: ofac
                                  status:
                                    type: string
                                    example: success
                              amount:
                                type: string
                                example: '0.3'
                              amountPaid:
                                type: string
                                example: '0.0'

```

--------------------------------

### POST /api/swap-transaction

Source: https://docs.blockradar.co/api-reference/swap/master-wallet-execute

Initiates a swap transaction on the BNB Smart Chain. This endpoint requires authentication via an API key and processes token swaps within a master wallet.

```APIDOC
## POST /api/swap-transaction

### Description
Initiates a swap transaction on the BNB Smart Chain using a master wallet. The transaction includes details like token address, amount, and wallet information.

### Method
POST

### Endpoint
/api/swap-transaction

### Parameters
#### Request Body
- **tokenAddress** (string) - Optional - Address of the token to be swapped
- **amount** (string) - Required - Amount of tokens to swap
- **walletId** (string) - Required - ID of the master wallet
- **type** (string) - Required - Type of transaction, e.g., SWAP

### Request Example
{
  "tokenAddress": null,
  "amount": "0.5",
  "walletId": "23628012-2b69-4ed7-9627-63fb3f547381",
  "type": "SWAP"
}

### Response
#### Success Response (200)
- **message** (string) - Success message
- **data** (object) - Transaction details including wallet and blockchain info

#### Response Example
{
  "message": "Swap transaction created successfully",
  "data": {
    "amount": "0.5",
    "type": "SWAP",
    "wallet": {
      "id": "23628012-2b69-4ed7-9627-63fb3f547381",
      "name": "BNB Smart Chain Mainnet Wallet",
      "blockchain": {
        "name": "BNB smart chain",
        "symbol": "bnb",
        "tokenStandard": "BEP20"
      }
    }
  }
}
```