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

# Webhook Configuration

> Retrieves the current webhook configuration for your business account, including:

- The webhook URL where notifications are sent.

- The categories you're currently subscribed to.

- The complete list of categories available in Vita.

Use this endpoint to inspect your current setup, audit your active subscriptions, or display configuration details in an admin interface.

#### Response Structure

| Field | Type | Description |
| --- | --- | --- |
| `webhook_url` | string | null / URL |
| `configured_categories` | string[\] | Transaction categories currently subscribed for notifications. |
| `available_categories` | string[\] | All transaction categories supported by Vita (19 total). Use this list to discover new categories you can subscribe to. |

#### Request Example

```bash
curl --location 'https://api.vitawallet.io/api/businesses/webhooks' \
  --header 'X-Login: {your_x_login}' \
  --header 'X-Trans-Key: {your_x_trans_key}' \
  --header 'X-Date: {current_iso8601_timestamp_with_timezone}' \
  --header 'Authorization: {signature_calculated_per_the_Business_API_authentication_doc}'
```

See "Authenticating Requests to These Endpoints" above — the signature here is **not** calculated with the webhook-verification formula.

#### Response Example

```json
{
  "webhook_url": "https://myserver.com/webhook",
  "configured_categories": [
    "microdeposit"
  ],
  "available_categories": [
    "sent",
    "received",
    "deposit",
    "withdrawal",
    "exchange",
    "fee",
    "payment",
    "transfer",
    "vita_card",
    "tax",
    "cash_back_coupon",
    "service_payment",
    "adjustment",
    "card_credit_adjustment",
    "card_debit_adjustment",
    "card_transaction",
    "request_charge",
    "card_maintenance",
    "microdeposit"
  ]
}
```



## OpenAPI

````yaml /openapi.yaml get /api/businesses/webhooks
openapi: 3.0.0
info:
  title: Vita Business API
  description: >-
    Vita Wallet Business API — integra payins, payouts, exchange, transactions,
    users y webhooks para operar pagos en LatAm y el mundo.
  version: 1.0.0
  contact:
    name: Vita Wallet Support
    url: https://vitawallet.io
    email: empresas@vitawallet.io
servers:
  - url: https://api.vitawallet.io
    description: Production
  - url: https://api.stage.vitawallet.io
    description: Sandbox
security:
  - xLogin: []
    xTransKey: []
    xDate: []
    hmacSignature: []
tags:
  - name: Create Payin
  - name: Direct Payment
  - name: Exchange
  - name: Vita Sent
  - name: Bank Payouts
  - name: External Crypto Payouts
  - name: Transactions
  - name: Users Creation
  - name: User Information
  - name: Webhooks
externalDocs:
  url: https://vitawallet.io
  description: Vita Wallet
paths:
  /api/businesses/webhooks:
    get:
      tags:
        - Webhooks
      summary: Webhook Configuration
      description: >-
        Retrieves the current webhook configuration for your business account,
        including:


        - The webhook URL where notifications are sent.


        - The categories you're currently subscribed to.


        - The complete list of categories available in Vita.


        Use this endpoint to inspect your current setup, audit your active
        subscriptions, or display configuration details in an admin interface.


        #### Response Structure


        | Field | Type | Description |

        | --- | --- | --- |

        | `webhook_url` | string | null / URL |

        | `configured_categories` | string[\] | Transaction categories currently
        subscribed for notifications. |

        | `available_categories` | string[\] | All transaction categories
        supported by Vita (19 total). Use this list to discover new categories
        you can subscribe to. |


        #### Request Example


        ```bash

        curl --location 'https://api.vitawallet.io/api/businesses/webhooks' \
          --header 'X-Login: {your_x_login}' \
          --header 'X-Trans-Key: {your_x_trans_key}' \
          --header 'X-Date: {current_iso8601_timestamp_with_timezone}' \
          --header 'Authorization: {signature_calculated_per_the_Business_API_authentication_doc}'
        ```


        See "Authenticating Requests to These Endpoints" above — the signature
        here is **not** calculated with the webhook-verification formula.


        #### Response Example


        ```json

        {
          "webhook_url": "https://myserver.com/webhook",
          "configured_categories": [
            "microdeposit"
          ],
          "available_categories": [
            "sent",
            "received",
            "deposit",
            "withdrawal",
            "exchange",
            "fee",
            "payment",
            "transfer",
            "vita_card",
            "tax",
            "cash_back_coupon",
            "service_payment",
            "adjustment",
            "card_credit_adjustment",
            "card_debit_adjustment",
            "card_transaction",
            "request_charge",
            "card_maintenance",
            "microdeposit"
          ]
        }

        ```
      operationId: webhook-configuration
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              examples:
                SuccessGetWebhookConfiguration:
                  summary: Success - Get Webhook configuration
                  value:
                    webhook_url: https://myserver.com/webhook
                    configured_categories:
                      - microdeposit
                    available_categories:
                      - sent
                      - received
                      - deposit
                      - withdrawal
                      - exchange
                      - fee
                      - payment
                      - transfer
                      - vita_card
                      - tax
                      - cash_back_coupon
                      - service_payment
                      - adjustment
                      - card_credit_adjustment
                      - card_debit_adjustment
                      - card_transaction
                      - request_charge
                      - card_maintenance
                      - microdeposit
                GetEmptyWebhookConfiguration:
                  summary: Get Empty Webhook configuration
                  value:
                    webhook_url: null
                    configured_categories: []
                    available_categories:
                      - sent
                      - received
                      - deposit
                      - withdrawal
                      - exchange
                      - fee
                      - payment
                      - transfer
                      - vita_card
                      - tax
                      - cash_back_coupon
                      - service_payment
                      - adjustment
                      - card_credit_adjustment
                      - card_debit_adjustment
                      - card_transaction
                      - request_charge
                      - card_maintenance
                      - microdeposit
components:
  securitySchemes:
    xLogin:
      type: apiKey
      in: header
      name: x-login
      description: Business xLogin
    xTransKey:
      type: apiKey
      in: header
      name: x-trans-key
      description: Business xTransKey
    xDate:
      type: apiKey
      in: header
      name: x-date
      description: ISO8601 datetime
    hmacSignature:
      type: apiKey
      in: header
      name: Authorization
      description: 'V2-HMAC-SHA256 signature. Example: `V2-HMAC-SHA256, Signature: <hash>`'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.