Ventipay

https://docs.ventipay.com/
Admin
Ventipay is a payment API platform that enables developers to manage payments, subscriptions,...
Tokens:73,816
Snippets:294
Trust Score:8.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /setup_intents/{id}

Source: https://docs.ventipay.com/reference/setup_intents-get

Retrieves the details of a SetupIntent object.

```APIDOC
## GET /setup_intents/{id}

### Description
Recupera los detalles de un objeto `SetupIntent`.

### Method
GET

### Endpoint
https://api.ventipay.com/v1/setup_intents/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the SetupIntent.
- **object** (string) - The type of object, "setup_intent".
- **amount** (integer) - The amount to be collected for the payment method. (Optional)
- **client_secret** (string) - A secret used to complete the setup process on the client side.
- **created** (integer) - Time at which the SetupIntent was created, represented as a Unix timestamp.
- **currency** (string) - Three-letter ISO currency code, in lowercase.
- **description** (string) - An arbitrary string attached to the SetupIntent, used to display to the client. (Optional)
- **livemode** (boolean) - Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- **payment_method_types** (array) - An array of strings representing the payment method types that can be used for this SetupIntent.
- **status** (string) - One of `succeeded`, `processing`, `requires_payment_method`, `canceled`.
- **usage** (string) - Indicates the intended use of the SetupIntent, e.g., `one_time` or `recurring`.

#### Response Example
```json
{
  "id": "seti_1Kz7jX2eZvKYlo2C0s8n4g6t",
  "object": "setup_intent",
  "amount": 1099,
  "client_secret": "seti_1Kz7jX2eZvKYlo2C0s8n4g6t_secret_Jz7jX2eZvKYlo2C0s8n4g6t",
  "created": 1630000000,
  "currency": "usd",
  "description": "Setup for future payments",
  "livemode": false,
  "payment_method_types": ["card"],
  "status": "requires_payment_method",
  "usage": "off_session"
}
```
```

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

### Obtener detalles de una cuota mediante OpenAPI

Source: https://docs.ventipay.com/reference/installments-get

Definición de la ruta GET /installments/{id} para recuperar un objeto Installment. Incluye parámetros de ruta para el ID y parámetros de consulta para expansión de datos.

```json
{
  "/installments/{id}": {
    "get": {
      "summary": "Obtener",
      "description": "Recupera los detalles de un objeto `Installment`.",
      "operationId": "installments-get",
      "parameters": [
        {
          "name": "id",
          "in": "path",
          "description": "ID del objeto",
          "schema": { "type": "string" },
          "required": true
        },
        {
          "name": "expand",
          "in": "query",
          "description": "Objetos a expandir en la respuesta",
          "schema": { "type": "array", "items": { "type": "string" } }
        }
      ]
    }
  }
}
```

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

### GET /products/{id}

Source: https://docs.ventipay.com/reference/products-get

Retrieves the details of a specific Product object by its unique identifier.

```APIDOC
## GET /products/{id}

### Description
Recupera los detalles de un objeto `Product`.

### Method
GET

### Endpoint
https://api.ventipay.com/v1/products/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

### Request Example
GET /v1/products/prod_12345

### Response
#### Success Response (200)
- **product** (object) - The product details object.

#### Response Example
{
  "id": "prod_12345",
  "name": "Plan Premium",
  "price": 99.00,
  "currency": "USD"
}
```

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

### Basic Auth Authentication

Source: https://docs.ventipay.com/reference/auth

Example of how to authenticate requests using the Basic Auth schema.

```APIDOC
## POST /v1/checkouts (Basic Auth)

### Description
This endpoint is used to create a new checkout. Authentication is performed using Basic Auth.

### Method
POST

### Endpoint
https://api.ventipay.com/v1/checkouts

### Parameters
#### Request Headers
- **Authorization** (string) - Required - `Basic <API Key>` (Base64 encoded username with empty password)

### Request Example
```curl Basic Auth
curl https://api.ventipay.com/v1/checkouts \
-u <API Key>:
```

**Note:** Replace `<API Key>` with a valid API Key. The colon `:` after the key is important for curl to not prompt for a password.
```

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

### GET /products

Source: https://docs.ventipay.com/reference/products-list

Retrieves a list of product objects, ordered by creation date with the most recent first.

```APIDOC
## GET /products

### Description
Returns a list of `Product` objects. Records are returned in order, with the most recent appearing first. By default, the last 10 created records are returned.

### Method
GET

### Endpoint
https://api.ventipay.com/v1/products

### Parameters
#### Query Parameters
- **active** (boolean) - Optional - Filters products by their active status.
- **metadata** (string) - Optional - Filters products based on JSON metadata.

### Request Example
GET /products?active=true

### Response
#### Success Response (200)
- **products** (array) - A list of product objects.

#### Response Example
{
  "products": [
    {
      "id": "prod_123",
      "name": "Standard Plan",
      "active": true
    }
  ]
}
```

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

### POST /subscriptions/{id}/start

Source: https://docs.ventipay.com/reference/subscriptions-start

Initiates a subscription, starting the recurring billing process for a specified subscription ID.

```APIDOC
## POST /subscriptions/{id}/start

### Description
Initiates a subscription. This action starts the recurring billing process for a given subscription.

### Method
POST

### Endpoint
/subscriptions/{id}/start

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the subscription to start.

### Request Example
(No request body is specified in the OpenAPI definition for this endpoint)

### Response
#### Success Response (200)
(Success response details are not explicitly defined in the provided OpenAPI snippet, but typically would confirm the subscription has been started.)

#### Response Example
(No response example is provided in the OpenAPI definition for this endpoint)
```

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

### POST /subscriptions

Source: https://docs.ventipay.com/reference/subscriptions-create

Creates a new subscription object. The client must authorize the subscription start after creation.

```APIDOC
## POST /subscriptions

### Description
Crea un nuevo objeto `Subscription`. Una vez creada la suscripción, el cliente debe autorizar su inicio.

### Method
POST

### Endpoint
https://api.ventipay.com/v1/subscriptions

### Parameters
#### Request Body
- **billing_cycle_anchor** (string) - Optional - Defines the day of the month for billing.
- **cancel_url** (string) - Optional - URL to redirect upon cancellation.
- **currency** (string) - Optional - Currency code (clp, clf).
- **default_products** (array) - Optional - List of product IDs and quantities.
- **interval** (string) - Optional - Billing frequency (e.g., 1month, 1year).
- **name** (string) - Optional - Name of the subscription.

### Request Example
{
  "name": "Premium Plan",
  "currency": "clp",
  "interval": "1month"
}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created subscription.

#### Response Example
{
  "id": "sub_123456789",
  "status": "pending"
}
```

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

### Bearer Token Authentication

Source: https://docs.ventipay.com/reference/auth

Example of how to authenticate requests using the Bearer Token schema.

```APIDOC
## POST /v1/checkouts (Bearer Token)

### Description
This endpoint is used to create a new checkout. Authentication is performed using a Bearer Token.

### Method
POST

### Endpoint
https://api.ventipay.com/v1/checkouts

### Parameters
#### Request Headers
- **Authorization** (string) - Required - `Bearer <API Key>`

### Request Example
```curl Bearer Token
curl https://api.ventipay.com/v1/checkouts \
-H 'Authorization: Bearer <API Key>'
```

**Note:** Replace `<API Key>` with a valid API Key.
```

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

### GET /installments/{id}

Source: https://docs.ventipay.com/reference/installments-get

Retrieves the details of a specific Installment object.

```APIDOC
## GET /installments/{id}

### Description
Recupera los detalles de un objeto `Installment`.

### Method
GET

### Endpoint
/installments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

#### Query Parameters
- **expand** (array[string]) - Optional - Objetos a expandir en la respuesta

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Actualizar SetupIntent vía OpenAPI

Source: https://docs.ventipay.com/reference/setup_intents-update

Definición de la especificación OpenAPI para el endpoint de actualización de SetupIntent. Define los esquemas de seguridad, los parámetros de ruta y el cuerpo de la solicitud requerido.

```json
{
  "openapi": "3.1.0",
  "paths": {
    "/setup_intents/{id}": {
      "put": {
        "summary": "Actualizar",
        "description": "Actualiza un objeto SetupIntent especifico.",
        "operationId": "setup_intents-update",
        "parameters": [
          { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": { "type": "object", "properties": { "metadata": { "type": "string", "format": "json" } } }
            }
          }
        }
      }
    }
  }
}
```

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

### POST /setup_intents

Source: https://docs.ventipay.com/reference/setup_intents-create

Creates a new SetupIntent object to initiate the payment method registration process.

```APIDOC
## POST /setup_intents

### Description
Creates a new SetupIntent object. Once the intent is created, the client can register a payment method using the URL provided in the response object.

### Method
POST

### Endpoint
https://api.ventipay.com/v1/setup_intents

### Parameters
#### Request Body
- **customer_id** (string) - Optional - ID of the Customer. Either customer_id or customer_email must be provided.
- **customer_email** (string) - Optional - Email of the Customer. If it does not exist, it will be created. Either customer_id or customer_email must be provided.
- **metadata** (string) - Optional - A set of key-value pairs associated with the object.
- **notification_events** (array) - Optional - Events to notify: setup_intent.created, setup_intent.succeeded, setup_intent.expired, setup_intent.canceled.
- **notification_url** (string) - Optional - The URL to receive notifications.

### Request Example
{
  "customer_email": "user@example.com",
  "metadata": "{\"order_id\": \"123\"}"
}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the SetupIntent.
- **status** (string) - The current status of the intent.
- **client_secret** (string) - The secret used to complete the setup on the client side.

#### Response Example
{
  "id": "si_12345",
  "status": "requires_payment_method",
  "client_secret": "seti_123_secret_456"
}
```

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

### POST /installments/{id}/authorize

Source: https://docs.ventipay.com/reference/installments-authorize

Authorizes a pending loan installment using the provided payment method and number of installments.

```APIDOC
## POST /installments/{id}/authorize

### Description
Authorizes a pending loan installment. This endpoint allows you to process the payment for a specific installment.

### Method
POST

### Endpoint
/installments/{id}/authorize

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the installment object to authorize.

#### Request Body
- **payment_method_id** (string) - Required - The ID of the customer's payment method.
- **installments** (integer) - Required - The number of installments to be processed.

### Request Example
```json
{
  "payment_method_id": "pm_123456789",
  "installments": 3
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the authorization.
- **message** (string) - A confirmation message.

#### Response Example
```json
{
  "status": "authorized",
  "message": "Installment authorized successfully."
}
```
```

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

### List Setup Intents

Source: https://docs.ventipay.com/reference/setup_intents-list

Retrieves a list of SetupIntent objects. Results are ordered with the most recent first. Defaults to the last 10 created records.

```APIDOC
## GET /setup_intents

### Description
Returns a list of `SetupIntent` objects. Records are returned in order with the most recent appearing first. By default, the last 10 created records are returned.

### Method
GET

### Endpoint
https://api.ventipay.com/v1/setup_intents

### Parameters
#### Query Parameters
- **customer_id** (string) - Optional - Filters by `Customer` ID
- **status** (array of strings) - Optional - Filters by status

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the SetupIntent.
- **object** (string) - Type of object, 'setup_intent'.
- **client_secret** (string) - A secret used for client-side retrieval of the SetupIntent.
- **created** (integer) - Time at which the SetupIntent was created, represented as a Unix timestamp.
- **customer** (string) - The ID of the Customer this SetupIntent belongs to, if any.
- **description** (string) - An arbitrary string attached to the SetupIntent, used for displaying to the client.
- **last_setup_error** (object) - If present, the last error encountered.
- **livemode** (boolean) - Has the value `true` if the object exists on live mode or the value `false` if the object exists on test mode.
- **payment_method_types** (array of strings) - Supported payment method types.
- **status** (string) - The status of the SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, `succeeded`.
- **usage** (string) - Indicates the intended use of the SetupIntent, one of `off_session` or `on_session`.

#### Response Example
```json
{
  "data": [
    {
      "id": "seti_1Kz4yX2eZvKYlo2C0qf4z1t1",
      "object": "setup_intent",
      "client_secret": "seti_1Kz4yX2eZvKYlo2C0qf4z1t1_secret_1Kz4yX2eZvKYlo2C0qf4z1t1",
      "created": 1630000000,
      "customer": "cus_1Kz4yX2eZvKYlo2C0qf4z1t1",
      "description": "Payment for order 123",
      "last_setup_error": null,
      "livemode": false,
      "payment_method_types": ["card"],
      "status": "requires_payment_method",
      "usage": "on_session"
    }
  ],
  "has_more": true,
  "url": "/v1/setup_intents"
}
```
```

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

### GET /payment_methods/{id}

Source: https://docs.ventipay.com/reference/payment_methods-get

Retrieves the details of a specific PaymentMethod object.

```APIDOC
## GET /payment_methods/{id}

### Description
Recupera los detalles de un objeto `PaymentMethod`.

### Method
GET

### Endpoint
/payment_methods/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

### Response
#### Success Response (200)
- **id** (string) - Description of the payment method ID
- **type** (string) - Type of the payment method (e.g., 'card')
- **details** (object) - Specific details about the payment method (e.g., last 4 digits of card)

#### Response Example
```json
{
  "id": "pm_12345abcde",
  "type": "card",
  "details": {
    "last4": "4242",
    "brand": "visa"
  }
}
```
```

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

### Define OpenAPI Specification for SetupIntents

Source: https://docs.ventipay.com/reference/setup_intents-list

This JSON snippet defines the OpenAPI 3.1.0 specification for the Ventipay API. It includes security schemes using Bearer authentication and defines the path for listing SetupIntents with optional query parameters for filtering by customer ID and status.

```json
{
  "openapi": "3.1.0",
  "servers": [
    {
      "url": "https://api.ventipay.com/v1"
    }
  ],
  "paths": {
    "/setup_intents": {
      "get": {
        "summary": "Listar",
        "description": "Devuelve una lista de objetos `SetupIntent`.",
        "operationId": "setup_intents-list",
        "parameters": [
          { "name": "customer_id", "in": "query", "schema": { "type": "string" } },
          { "name": "status", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }
        ]
      }
    }
  }
}
```

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

### GET /tax_rates/{id}

Source: https://docs.ventipay.com/reference/tax_rates-get

Retrieves the details of a specific TaxRate object by its ID.

```APIDOC
## GET /tax_rates/{id}

### Description
Recupera los detalles de un objeto `TaxRate`.

### Method
GET

### Endpoint
https://api.ventipay.com/v1/tax_rates/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

### Request Example
GET /tax_rates/tax_12345

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the tax rate.
- **percentage** (number) - The tax rate percentage.
- **display_name** (string) - The name of the tax rate.

#### Response Example
{
  "id": "tax_12345",
  "percentage": 16.0,
  "display_name": "IVA"
}
```

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

### Fetch First Page of Customers (Bash)

Source: https://docs.ventipay.com/reference/pagination

Demonstrates how to retrieve the first page of customer records using a GET request with a specified limit. This is the initial step in paginated data retrieval.

```bash
curl https://api.ventipay.com/v1/customers?limit=3
```

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

### GET /subscriptions

Source: https://docs.ventipay.com/reference/subscriptions-list

Retrieve a list of subscription objects, ordered by most recent first.

```APIDOC
## GET /subscriptions

### Description
Devuelve una lista de objetos `Subscription`. Los registros se devuelven en orden y los más recientes aparecen primero. Por defecto se devuelven los últimos 10 registros creados.

### Method
GET

### Endpoint
https://api.ventipay.com/v1/subscriptions

### Parameters
#### Query Parameters
- **customer_id** (string) - Optional - Filtra por ID de `Customer`
- **metadata** (string) - Optional - Filtra por metadatos en formato JSON
- **plan_id** (string) - Optional - Filtra por ID de plan
- **status** (array) - Optional - Filtra por estados

### Request Example
GET /subscriptions?status=active

### Response
#### Success Response (200)
- **data** (array) - Lista de objetos `Subscription`

#### Response Example
{
  "data": [
    {
      "id": "sub_123",
      "status": "active",
      "plan_id": "plan_abc"
    }
  ]
}
```

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

### OpenAPI Definition for SetupIntent Retrieval

Source: https://docs.ventipay.com/reference/setup_intents-get

This OpenAPI 3.1.0 definition outlines the structure and endpoints for the Ventipay API, specifically focusing on the retrieval of SetupIntent objects. It includes server URLs, security schemes, and path definitions for the GET /setup_intents/{id} endpoint.

```json
{
  "openapi": "3.1.0",
  "servers": [
    {
      "url": "https://api.ventipay.com/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      },
      "BasicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "info": {
    "title": "Métodos de Pago",
    "description": "Endpoints para gestionar métodos de pago e intenciones de inscripción.",
    "version": "1"
  },
  "tags": [
    {
      "name": "Intenciones de Inscripción",
      "description": "Un `SetupIntent` permite inscribir un método de pago de un cliente para cobros futuros."
    }
  ],
  "paths": {
    "/setup_intents/{id}": {
      "get": {
        "summary": "Obtener",
        "description": "Recupera los detalles de un objeto `SetupIntent`.",
        "operationId": "setup_intents-get",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID del objeto",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "deprecated": false,
        "security": [
          {
            "BasicAuth": []
          },
          {
            "BearerAuth": []
          }
        ],
        "tags": [
          "Intenciones de Inscripción"
        ]
      }
    }
  }
}
```

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

### GET /payments/{id}

Source: https://docs.ventipay.com/reference/payments-get

Retrieves the details of a specific payment using its ID.

```APIDOC
## GET /payments/{id}

### Description
Recupera los detalles de un pago.

### Method
GET

### Endpoint
/payments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

#### Query Parameters
- **expand** (array) - Optional - 

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **id** (string) - Description
- **amount** (integer) - Description
- **currency** (string) - Description
- **status** (string) - Description

#### Response Example
```json
{
  "id": "pay_12345",
  "amount": 1000,
  "currency": "USD",
  "status": "succeeded"
}
```
```

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

### Fetch Next Page of Customers (Bash)

Source: https://docs.ventipay.com/reference/pagination

Shows how to fetch the subsequent page of customer records by utilizing the `next_cursor` value from a previous response as the `starting_after` parameter. This allows for sequential traversal of data.

```bash
curl https://api.ventipay.com/v1/customers?limit=3&starting_after=eyJpIjoiY3VzXzMiLCJjIjoiMjAyNS0wMS0wMyJ9_a1b2c3d4
```

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

### GET /mandates/{id}

Source: https://docs.ventipay.com/reference/mandates-get

Retrieves the details of a Mandate object using its ID.

```APIDOC
## GET /mandates/{id}

### Description
Recupera los detalles de un objeto `Mandate`.

### Method
GET

### Endpoint
/mandates/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the mandate.
- **customer_id** (string) - The ID of the customer associated with the mandate.
- **payment_method_id** (string) - The ID of the payment method used for the mandate.
- **status** (string) - The current status of the mandate (e.g., 'active', 'revoked').
- **created_at** (string) - The timestamp when the mandate was created.
- **updated_at** (string) - The timestamp when the mandate was last updated.

#### Response Example
```json
{
  "id": "mandate_abc123",
  "customer_id": "cust_xyz789",
  "payment_method_id": "pm_def456",
  "status": "active",
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T10:00:00Z"
}
```
```

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

### POST /plans

Source: https://docs.ventipay.com/reference/plans-create

Crea un nuevo objeto Plan. Una vez creado el plan, el cliente debe autorizar su inicio generando una Subscription.

```APIDOC
## POST /plans

### Description
Crea un nuevo objeto `Plan`. Una vez creado el plan, el cliente debe autorizar su inicio generando una `Subscription`.

### Method
POST

### Endpoint
https://api.ventipay.com/v1/plans

### Parameters
#### Request Body
- **active** (boolean) - Optional - Estado del plan.
- **billing_cycle_anchor** (string) - Optional - Día del mes o 'now' para el ciclo de facturación.
- **currency** (string) - Optional - Moneda: clp o clf.
- **name** (string) - Required - Nombre del plan.
- **interval** (string) - Optional - Frecuencia de cobro (1day, 1week, 1month, etc).
- **default_products** (array) - Optional - Lista de IDs de productos asociados.

### Request Example
{
  "name": "Plan Premium",
  "currency": "clp",
  "interval": "1month",
  "active": true
}

### Response
#### Success Response (200)
- **id** (string) - ID del plan creado.
- **name** (string) - Nombre del plan.

#### Response Example
{
  "id": "plan_12345",
  "name": "Plan Premium",
  "status": "created"
}
```

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

### GET /currencies

Source: https://docs.ventipay.com/reference/currencies-list

Retrieves a comprehensive list of all currencies supported by the VentiPay platform.

```APIDOC
## GET /currencies

### Description
Returns a list of all currencies supported by the platform.

### Method
GET

### Endpoint
https://api.ventipay.com/v1/currencies

### Parameters
None

### Request Example
GET /currencies

### Response
#### Success Response (200)
- **currencies** (array) - List of supported currency objects.

#### Response Example
{
  "currencies": [
    {
      "code": "USD",
      "name": "United States Dollar"
    },
    {
      "code": "MXN",
      "name": "Mexican Peso"
    }
  ]
}
```

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

### POST /setup_intents/{id}/cancel

Source: https://docs.ventipay.com/reference/setup_intents-cancel

Cancels a pending SetupIntent, preventing the client from completing the payment method registration.

```APIDOC
## POST /setup_intents/{id}/cancel

### Description
Cancels a new SetupIntent object. Once cancelled, the client will not be able to register a payment method. This action is only possible if the status of the setup_intent is 'pending'.

### Method
POST

### Endpoint
https://api.ventipay.com/v1/setup_intents/{id}/cancel

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the SetupIntent object to cancel.

### Request Example
POST /v1/setup_intents/si_12345/cancel

### Response
#### Success Response (200)
- **status** (string) - The updated status of the object, confirming cancellation.

#### Response Example
{
  "id": "si_12345",
  "status": "canceled"
}
```

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

### GET /bank_accounts/{id}

Source: https://docs.ventipay.com/reference/bank_accounts-get

Retrieves the details of a BankAccount object using its ID.

```APIDOC
## GET /bank_accounts/{id}

### Description
Recupera los detalles de un objeto `BankAccount`.

### Method
GET

### Endpoint
/bank_accounts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the bank account.
- **account_number** (string) - The bank account number.
- **routing_number** (string) - The routing number for the bank.
- **account_holder_name** (string) - The name of the account holder.
- **bank_name** (string) - The name of the bank.

#### Response Example
```json
{
  "id": "ba_123abc",
  "account_number": "1234567890",
  "routing_number": "012345678",
  "account_holder_name": "John Doe",
  "bank_name": "Example Bank"
}
```
```

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

### GET /balance_transactions

Source: https://docs.ventipay.com/reference/balance_transactions-list

Retrieves a list of BalanceTransaction objects, sorted by most recent first.

```APIDOC
## GET /balance_transactions

### Description
Returns a list of BalanceTransaction objects. Records are returned in chronological order with the most recent appearing first. By default, the last 10 created records are returned.

### Method
GET

### Endpoint
/balance_transactions

### Parameters
#### Query Parameters
- **period** (string) - Required - Filter by date range. Options: mtd (current month), qtd (current quarter), ytd (current year). Default: mtd.
- **expand** (array) - Optional - Expandable fields: billing_invoice, discount, dispute, loan, payout, payment, refund.
- **payout_id** (string) - Optional - Filter by payout ID.
- **type** (array) - Optional - Filter by transaction type.

### Request Example
GET /balance_transactions?period=mtd

### Response
#### Success Response (200)
- **data** (array) - List of BalanceTransaction objects.

#### Response Example
{
  "data": [
    {
      "id": "bt_123",
      "amount": 1000,
      "currency": "usd",
      "type": "payment"
    }
  ]
}
```

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

### PUT /setup_intents/{id}

Source: https://docs.ventipay.com/reference/setup_intents-update

Updates the details of a specific SetupIntent object. Only provided fields are modified.

```APIDOC
## PUT /setup_intents/{id}

### Description
Actualiza un objeto `SetupIntent` especifico. Cualquier parámetro que no se proporcione no se modificará.

### Method
PUT

### Endpoint
/setup_intents/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

#### Request Body
- **metadata** (string) - Optional - Conjuto de pares llave-valor asociado al objeto.

### Request Example
{
  "metadata": "{\"key\": \"value\"}"
}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the updated SetupIntent.

#### Response Example
{
  "id": "si_12345",
  "metadata": "{\"key\": \"value\"}"
}
```

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

### Actualizar objeto Plan mediante OpenAPI

Source: https://docs.ventipay.com/reference/plans-update

Definición de la especificación OpenAPI para el método PUT en el endpoint /plans/{id}. Permite actualizar atributos como nombre, descripción, ciclo de facturación y URLs de redirección.

```json
{
  "openapi": "3.1.0",
  "paths": {
    "/plans/{id}": {
      "put": {
        "summary": "Actualizar",
        "description": "Actualiza un objeto Plan. Cualquier parámetro que no se proporcione no se modificará.",
        "operationId": "plans-update",
        "parameters": [
          { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": { "type": "string" },
                  "description": { "type": "string" },
                  "active": { "type": "boolean" },
                  "trial_days": { "type": "integer" }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

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

### GET /webhooks/{id}

Source: https://docs.ventipay.com/reference/webhooks-get

Retrieves the details of a specific webhook object by its unique identifier.

```APIDOC
## GET /webhooks/{id}

### Description
Recupera los detalles de un objeto `Webhook`.

### Method
GET

### Endpoint
https://api.ventipay.com/v1/webhooks/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

### Request Example
N/A

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the webhook

#### Response Example
{
  "id": "wh_123456789",
  "url": "https://example.com/webhook",
  "enabled": true
}
```

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

### POST /websites/ventipay/plans

Source: https://docs.ventipay.com/reference/plans-create

Creates a new subscription plan for a website.

```APIDOC
## POST /websites/ventipay/plans

### Description
Creates a new subscription plan with specified details, including pricing, trial periods, and success URLs.

### Method
POST

### Endpoint
/websites/ventipay/plans

### Parameters
#### Request Body
- **name** (string) - Required - The name of the plan.
- **amount** (integer) - Required - The price of the plan in cents.
- **currency** (string) - Required - The currency of the plan (e.g., 'usd').
- **interval** (string) - Required - The billing interval (e.g., 'month', 'year').
- **interval_count** (integer) - Optional - The number of intervals between billing cycles.
- **trial_days** (integer) - Optional - The number of days for a free trial.
- **success_url** (string) - Optional - The URL to redirect to after a successful subscription.
- **success_url_method** (string) - Optional - The HTTP method for the success URL ('get' or 'post'). Defaults to 'post'.
- **proration_behavior** (string) - Optional - Defines how prorations are handled ('create_prorations', 'full', 'none').

### Request Example
```json
{
  "name": "Basic Plan",
  "amount": 1000,
  "currency": "usd",
  "interval": "month",
  "interval_count": 1,
  "trial_days": 7,
  "success_url": "https://example.com/success",
  "success_url_method": "post",
  "proration_behavior": "create_prorations"
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier for the created plan.
- **name** (string) - The name of the plan.
- **amount** (integer) - The price of the plan in cents.
- **currency** (string) - The currency of the plan.
- **interval** (string) - The billing interval.
- **interval_count** (integer) - The number of intervals between billing cycles.
- **trial_days** (integer) - The number of days for a free trial.
- **success_url** (string) - The URL to redirect to after a successful subscription.
- **success_url_method** (string) - The HTTP method for the success URL.
- **proration_behavior** (string) - How prorations are handled.

#### Response Example
```json
{
  "id": "plan_abc123",
  "name": "Basic Plan",
  "amount": 1000,
  "currency": "usd",
  "interval": "month",
  "interval_count": 1,
  "trial_days": 7,
  "success_url": "https://example.com/success",
  "success_url_method": "post",
  "proration_behavior": "create_prorations"
}
```
```

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

### GET /subscriptions/{id}

Source: https://docs.ventipay.com/reference/subscriptions-get

Retrieves the details of a specific subscription object by its unique ID.

```APIDOC
## GET /subscriptions/{id}

### Description
Recupera los detalles de un objeto `Subscription`.

### Method
GET

### Endpoint
https://api.ventipay.com/v1/subscriptions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

### Request Example
N/A (No request body required)

### Response
#### Success Response (200)
- **subscription** (object) - The subscription object details.

#### Response Example
{
  "id": "sub_12345",
  "status": "active",
  "plan_id": "plan_abc"
}
```

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

### GET /refunds/{id}

Source: https://docs.ventipay.com/reference/refunds-get

Retrieves the details of a specific refund object by its unique identifier.

```APIDOC
## GET /refunds/{id}

### Description
Recupera los detalles de un objeto `Refund`.

### Method
GET

### Endpoint
https://api.ventipay.com/v1/refunds/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

### Request Example
N/A (No request body required)

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the refund.
- **status** (string) - The current status of the refund.
- **amount** (number) - The amount refunded.

#### Response Example
{
  "id": "ref_12345",
  "status": "completed",
  "amount": 50.00
}
```

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

### GET /plans/{id}

Source: https://docs.ventipay.com/reference/plans-get

Retrieves the details of a specific Plan object using its ID.

```APIDOC
## GET /plans/{id}

### Description
Recupera los detalles de un objeto `Plan`.

### Method
GET

### Endpoint
/plans/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the plan.
- **name** (string) - The name of the plan.
- **description** (string) - A description of the plan.
- **price** (number) - The price of the plan.
- **currency** (string) - The currency of the plan price (e.g., "USD").
- **interval** (string) - The billing interval for the plan (e.g., "month", "year").
- **is_active** (boolean) - Indicates if the plan is currently active.

#### Response Example
```json
{
  "id": "plan_abc123",
  "name": "Basic Plan",
  "description": "A basic plan for new users.",
  "price": 10.00,
  "currency": "USD",
  "interval": "month",
  "is_active": true
}
```
```

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

### Initiate Subscription via OpenAPI

Source: https://docs.ventipay.com/reference/subscriptions-start

This snippet defines the POST endpoint for starting a subscription in the Ventipay API. It requires a valid subscription ID as a path parameter and utilizes Bearer token authentication.

```json
{
  "openapi": "3.1.0",
  "paths": {
    "/subscriptions/{id}/start": {
      "post": {
        "summary": "Iniciar",
        "description": "Inicia una suscripción.",
        "operationId": "subscriptions-start",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": { "type": "string" }
          }
        ]
      }
    }
  }
}
```

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

### GET /loans/{id}

Source: https://docs.ventipay.com/reference/loans-get

Retrieves the details of a specific Loan object using its ID.

```APIDOC
## GET /loans/{id}

### Description
Recupera los detalles de un objeto `Loan`.

### Method
GET

### Endpoint
/loans/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID del objeto

#### Query Parameters
- **expand** (array[string]) - Optional - Objetos a expandir en la respuesta

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### POST /products

Source: https://docs.ventipay.com/reference/products-create

Creates a new Product object. A Product represents a good or service that can be associated with subscriptions or sales notes.

```APIDOC
## POST /products

### Description
Creates a new `Product` object. A `Product` represents a good or service that can be associated with subscriptions or sales notes.

### Method
POST

### Endpoint
/products

### Parameters
#### Request Body
- **active** (boolean) - Required - Indicates if the product is active.
- **currency** (string) - Required - The currency of the product. Enum: `clp`, `clf`.
- **name** (string) - Required - The name of the product.
- **price** (integer) - Required - The price of the product in the specified currency.
- **pricing_type** (string) - Required - The pricing model for the product. Enum: `recurrent`, `one_time`.
- **description** (string) - Optional - A detailed description of the product.
- **metadata** (string) - Optional - Additional metadata for the product, in JSON format.

### Request Example
```json
{
  "active": true,
  "currency": "clp",
  "name": "Example Product",
  "price": 10000,
  "pricing_type": "one_time",
  "description": "This is an example product.",
  "metadata": "{\"key\": \"value\"}"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created product.
- **active** (boolean) - Indicates if the product is active.
- **currency** (string) - The currency of the product.
- **name** (string) - The name of the product.
- **price** (integer) - The price of the product.
- **pricing_type** (string) - The pricing model for the product.
- **description** (string) - A detailed description of the product.
- **metadata** (string) - Additional metadata for the product.
- **created_at** (string) - The timestamp when the product was created.
- **updated_at** (string) - The timestamp when the product was last updated.

#### Response Example
```json
{
  "id": "prod_12345abcde",
  "active": true,
  "currency": "clp",
  "name": "Example Product",
  "price": 10000,
  "pricing_type": "one_time",
  "description": "This is an example product.",
  "metadata": "{\"key\": \"value\"}",
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T10:00:00Z"
}
```
```

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

### GET /invoices

Source: https://docs.ventipay.com/reference/invoices-intro

Retrieve information about sales notes or invoices generated within the system.

```APIDOC
## GET /invoices

### Description
Retrieves a list of sales notes (invoices). These represent charges for products or services, often linked to subscription billing cycles.

### Method
GET

### Endpoint
/invoices

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination.
- **limit** (integer) - Optional - Number of records per page.

### Request Example
GET /invoices?page=1

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the invoice.
- **amount** (decimal) - The total amount of the invoice.
- **status** (string) - Current status of the invoice (e.g., pending, paid).

#### Response Example
{
  "id": "inv_12345",
  "amount": 50.00,
  "status": "pending"
}
```
Tokens:
Raw