Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/1-checkout-process/pay-later-payment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Una vez que el comprador ha completado el proceso de pago satisfatoriamente, Apl

[Ver descripción técnica de cómo confirmar un pedido](../../checkout-confirmation/)

### 4. Resultado de la solicitud"
### 4. Resultado de la solicitud
Una vez completado el proceso de pago Aplazame mostrará el resultado de la solicitud de financiación al comprador.

:::info
Expand Down
2 changes: 1 addition & 1 deletion docs/api/10-widget/10-widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ El widget de Aplazame te permite mostrar una simulación de las cuotas de una fi
## Carga de aplazame.js

:::info
Debes incluir <strong>aplazame.js</strong> en las páginas donde deba aparecer el widget. Consulta todas las <a href="../sdk-javascript/#integracion">opciones de integración</a>.
Debes incluir <strong>aplazame.js</strong> en las páginas donde deba aparecer el widget. Consulta todas las <a href="../sdk-javascript/#integration">opciones de integración</a>.
:::

<Tabs>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/10-widget/widget-v4/widget-v4.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Los valores por defecto en ese caso, son los que se muestran en esta documentaci
|<t id="table.parameter">Parámetro</t> | <t id="table.type">Tipo</t> | <t id="table.required">Requerido</t> | <t id="table.description">Descripción</t>|
|---------|---------|---------|---------|
|data-price | [css selector](https://developer.mozilla.org/en/docs/Web/Guide/CSS/Getting_started/Selectors) | <t id="docs.yes">Sí</t> | Selector CSS que indique el elemento que contiene el precio final. Se actualiza en vivo si hay cambios en el precio. Si se usa conjuntamente con `data-amount`, se mostrará el valor de este último y de data-price si el precio cambia.
|data-amount | decimal | <t id="docs.yes">Sí</t> | Cantidad a financiar **en céntimos**. Este campo se puede omitir si se usa [`data-price`](#precio-variable).
|data-amount | decimal | <t id="docs.yes">Sí</t> | Cantidad a financiar **en céntimos**. Este campo se puede omitir si se usa [`data-price`](../../widget#precio-variable).
|data-type | enum | No | El diseño del widget cambiará en función del valor seleccionado. Los posibles valores son: `product`, `cart`. Por omisión se usará: `product`.
|data-option-legal-advice | boolean | No | Indica si debe mostrarse el texto legal justo después del widget. El valor por omisión es `false`.
|data-option-primary-color | [css color](https://developer.mozilla.org/es/docs/Web/CSS/color_value) | No | Establece el color del fondo del botón y del borde.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/10-widget/widget-v5/widget-v5.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Los valores por defecto en ese caso, son los que se muestran en esta documentaci
|<t id="table.parameter">Parámetro</t> | <t id="table.type">Tipo</t> | <t id="table.required">Requerido</t> | <t id="table.description">Descripción</t>|
|---------|---------|---------|---------|
|data-option-slider | boolean | Sí | Muestra o esconde el slider para deslizar con el ratón la cantidad de cuotas deseadas.
|data-amount | decimal | <t id="docs.yes">Sí</t> | Cantidad a financiar **en céntimos**. Este campo se puede omitir si se usa [`data-price`](#precio-variable).
|data-amount | decimal | <t id="docs.yes">Sí</t> | Cantidad a financiar **en céntimos**. Este campo se puede omitir si se usa [`data-price`](../../widget#precio-variable).
|data-option-legal-advice | boolean | No | Indica si debe mostrarse el texto legal justo después del widget. El valor por omisión es `false`.
|data-option-default-instalments | decimal | No | Permite configurar el número de cuotas seleccionadas que mostrará el widget por defecto.
|data-option-align | enum | No | Indica la alineación del widget. Se puede alinear a la izquierda `left` o a la derecha `right`. El valor por omisión es `center`.
Expand Down
4 changes: 2 additions & 2 deletions docs/api/11-api-orders/edit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ dynamic result = client.Put($"/orders/{orderId}", payload);
|<t id="table.parameter">Parámetro</t> | <t id="table.type">Tipo</t> | <t id="table.required">Requerido</t> | <t id="table.description">Descripción</t>|
|---------|---------|---------|---------|
:orderId | string | <t id="docs.yes">Sí</t> | ID del pedido.
[order](#order) | object | <t id="docs.yes">Sí</t> | Pedido a actualizar.
[order](../../checkout-creation/#order) | object | <t id="docs.yes">Sí</t> | Pedido a actualizar.

### Respuesta

Expand Down Expand Up @@ -419,7 +419,7 @@ dynamic result = client.Patch($"/orders/{orderId}", payload);
|<t id="table.parameter">Parámetro</t> | <t id="table.type">Tipo</t> | <t id="table.required">Requerido</t> | <t id="table.description">Descripción</t>|
|---------|---------|---------|---------|
:orderId | string | <t id="docs.yes">Sí</t> | ID del pedido.
[order](#order) | object | <t id="docs.yes">Sí</t> | Pedido a actualizar.
[order](../../checkout-creation/#order) | object | <t id="docs.yes">Sí</t> | Pedido a actualizar.

### Respuesta

Expand Down
5 changes: 2 additions & 3 deletions docs/api/11-api-orders/refund.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ X-Aplazame-Media-Type: aplazame.v1
amount | [decimal](../../api-reference#decimals) | Importe de la captura.
id | string | `id` de la captura.
created | string | Fecha de la captura.
[refunds](./#pago-en-15-dias) | object | Devoluciones realizadas a la captura.
refunds | object | Devoluciones realizadas a la captura.
refunded_amount | [decimal](../../api-reference#decimals) | Cantidad devuelta de la captura.
remaining_amount | [decimal](../../api-reference#decimals) | Cantidad restante de la captura.

Expand Down Expand Up @@ -398,7 +398,6 @@ X-Aplazame-Media-Type: aplazame.v1
amount | [decimal](../../api-reference#decimals) | Importe de la captura.
id | string | `id` de la captura.
created | string | Fecha de la captura.
[refunds](./#pago-en-15-dias) | object | Devoluciones realizadas a la captura.
refunds | object | Devoluciones realizadas a la captura.
refunded_amount | [decimal](../../api-reference#decimals) | Cantidad devuelta de la captura.
remaining_amount | [decimal](../../api-reference#decimals) | Cantidad restante de la captura.

8 changes: 4 additions & 4 deletions docs/api/8-checkout-confirmation/8-checkout-confirmation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,11 @@ Content-Type: application/json
}
```

|<t id="table.parameter">Parámetro</t> | <t id="table.type">Tipo</t> | <t id="table.required">Requerido</t> | <t id="table.description">Descripción</t>|
|---------|---------|---------|---------|
|<t id="table.parameter">Parámetro</t> | <t id="table.type">Tipo</t> | <t id="table.description">Descripción</t>|
|---------|---------|---------|
id | string | Identificador del pedido de Aplazame (inmutable).
[status](#codigos-de-estado-del-pedido) | string |Estado del pedido (`ok`, `pending` o `ko`).
[status_reason](#codigos-de-estado-del-pedido) | string | Código de estado del pedido.
[status](#códigos-de-estado-del-pedido) | string |Estado del pedido (`ok`, `pending` o `ko`).
[status_reason](#códigos-de-estado-del-pedido) | string | Código de estado del pedido.
sandbox | boolean | El pedido fue realizado en el entorno de pruebas.
mid | string | Identificador del pedido generado por el comercio o autogenerado por Aplazame.
total_amount | [decimal](../api-reference#decimals) | Cantidad a financiar.
Expand Down
6 changes: 3 additions & 3 deletions docs/api/9-checkout-capture/9-checkout-capture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Se ha de realizar una captura cuando se proceda al envío del producto o product
amount | [decimal](../api-reference#decimals) | <t id="table.yes">Sí</t> | Importe de la captura.
id | string | <t id="table.yes">Sí</t> | `id` de la captura.
created | string | <t id="table.yes">Sí</t> | Fecha de la captura.
[refunds](./#pago-en-15-dias) | object | No | Devoluciones realizadas a la captura.
refunds | object | No | Devoluciones realizadas a la captura.
refunded_amount | [decimal](../api-reference#decimals) | <t id="table.yes">Sí</t> | Cantidad devuelta de la captura.
remaining_amount | [decimal](../api-reference#decimals) | <t id="table.yes">Sí</t> | Cantidad restante de la captura (Siempre será 0).

Expand Down Expand Up @@ -121,7 +121,7 @@ X-Aplazame-Media-Type: aplazame.v1
|<t id="table.parameter">Parámetro</t> | <t id="table.type">Tipo</t> | <t id="table.required">Requerido</t> | <t id="table.description">Descripción</t>|
|---------|---------|---------|---------|
remaining_capture_amount | [decimal](../api-reference#decimals) | Cantidad restante del pedido sin capturar (Siempre será 0).
[results](./#captura) | object | Capturas del pedido.
results | object | Capturas del pedido.

## 02 - Solicitar captura

Expand Down Expand Up @@ -217,6 +217,6 @@ remaining_capture_amount | [decimal](../api-reference#decimals) | Cantidad resta
amount | [decimal](../api-reference#decimals) | Importe de la captura.
id | string | `id` de la captura.
created | string | Fecha de la captura.
[refunds](./#pago-en-15-dias) | object | Devoluciones realizadas a la captura.
refunds | object | Devoluciones realizadas a la captura.
refunded_amount | [decimal](../api-reference#decimals) | Cantidad devuelta de la captura.
remaining_amount | [decimal](../api-reference#decimals) | Cantidad restante de la captura (Siempre será 0).
2 changes: 1 addition & 1 deletion docs/plugins/6-vtex/6-vtex.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Application Token: <aquí debes copiar tu clave API pública>
Disponemos de una [app para integrar nuestro widget en VTEX](https://github.com/aplazame/vtex-widget-app).

### Instalación
- [Instala](https://vtex.io/docs/recipes/development/installing-an-app/) la app `aplazame.aplazame-widget` en la cuenta VTEX con la que tengas tu tienda.
- [Instala](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) la app `aplazame.aplazame-widget` en la cuenta VTEX con la que tengas tu tienda.
- Añádela como dependencia en el `manifest.json` del tema de tu tienda.
```diff
"peerDependencies": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Widget integration
The Aplazame widget allows you to show a simulation of the financing instalments next to the price of your products. You can choose between [basic integration](installment-payment#integración-básica) that you control from your Aplazame control panel and [advanced integration](installment-payment#integración-avanzada) if you want maximum flexibility.
The Aplazame widget allows you to show a simulation of the financing instalments next to the price of your products. You can choose between [basic integration](installment-payment#basic-integration) that you control from your Aplazame control panel and [advanced integration](installment-payment#advanced-integration) if you want maximum flexibility.

## Loading aplazame.js

:::info
You must include **aplazame.js** on the pages where the widget should appear. Check all the [integration options](../sdk-javascript/#integracion).
You must include **aplazame.js** on the pages where the widget should appear. Check all the [integration options](../sdk-javascript/#integration).
:::

<Tabs>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ keywords: [installments widget]

| Parameter | Type | Required | Description |
|---------|---------|---------|---------|
|data-amount | decimal | Yes | Quantity to be financed **in cents**. This field can be omitted if the data-price is used.[`data-price`](../../widget#precio-variable).
|data-amount | decimal | Yes | Quantity to be financed **in cents**. This field can be omitted if the data-price is used.[`data-price`](../../widget#variable-price).
|data-currency | [ISO 4217](https://es.wikipedia.org/wiki/ISO_4217) | Yes | Currency in which the item will be sold.
|data-country | [ISO 3166-1](https://es.wikipedia.org/wiki/ISO_3166-1) | Yes | Country where the sale will apply.
|data-view | enum | No | The view where the widget is included corresponds to the customisation tab of the [control panel](https://vendors.aplazame.com/). The possible values are: `product` (by default) and `cart`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In case the merchant supports the product 'Pay in 4', you can add the parameter

|<t id="table.parameter">Parámetro</t> | <t id="table.type">Tipo</t> | <t id="table.required">Requerido</t> | <t id="table.description">Descripción</t>|
|---------|---------|---------|---------|
|data-pay-in-4 | boolean | Yes | The attribute should be **true** or empty to work properly. This field causes a complete change in the rendering of the wdiget in case the merchant supports the product 'Pay in 4'. In case it does not support it or the total of the checkout does not meet the requirements for the product, it will behave exactly the same as the ['Payment in installments' widget](../installment-payment).
|data-pay-in-4 | boolean | Yes | The attribute should be **true** or empty to work properly. This field causes a complete change in the rendering of the widget in case the merchant supports the product 'Pay in 4'. In case it does not support it or the total of the checkout does not meet the requirements for the product, it will behave exactly the same as the ['Payment in installments' widget](../installment-payment).


:::caution
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ This version aims to simplify the integration for the installment payment widget
|<t id="table.parameter">Parámetro</t> | <t id="table.type">Tipo</t> | <t id="table.required">Requerido</t> | <t id="table.description">Descripción</t>|
|---------|---------|---------|---------|
|data-price | [css selector](https://developer.mozilla.org/en/docs/Web/Guide/CSS/Getting_started/Selectors) | Yes | CSS selector that indicates the element that contains the final price. It is updated live if there are changes in the price. If used in conjunction with `data-amount`, the value of the latter and `data-price` will be shown if the price changes.
|data-amount | decimal | Yes| Quantity to be financed in cents. This field can be omitted if the [`data-price`](./#variable-price) is used.
|data-amount | decimal | Yes| Quantity to be financed in cents. This field can be omitted if the [`data-price`](../../widget#variable-price) is used.
|data-type | enum | No | The widget layout will change based on the selected value. The possible values are: `product` (by default) and `cart`.
|data-option-legal-advice | boolean | No | Indicates whether you should displaying the legal text after the widget. The default value is `false`.
|data-option-primary-color | [css color](https://developer.mozilla.org/es/docs/Web/CSS/color_value) | No | Set the background colour of the button and the border.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ sidebar_position: 5
keywords: [widget V5]
---

# New widget v4
# New widget v5
## Integration
There is the possibility of integrating a new version of the widget, for this, you must assign the value "v5" to the HTML attribute: `data-aplazame-widget-instalments="v5"`

```html
<div
data-aplazame-widget-instalments="v4"
data-aplazame-widget-instalments="v5"
data-amount="3900">
</div>
```
Expand Down Expand Up @@ -50,7 +50,7 @@ This version aims to simplify the integration for the installment payment widget
|---------|---------|---------|---------|
|data-option-slider | boolean | Yes | Shows of hides the slider that lets the customer select the amount of instalments.
|data-price | [css selector](https://developer.mozilla.org/en/docs/Web/Guide/CSS/Getting_started/Selectors) | Yes | CSS selector that indicates the element that contains the final price. It is updated live if there are changes in the price. If used in conjunction with `data-amount`, the value of the latter and `data-price` will be shown if the price changes.
|data-amount | decimal | Yes| Quantity to be financed in cents. This field can be omitted if the [`data-price`](./#variable-price) is used.
|data-amount | decimal | Yes| Quantity to be financed in cents. This field can be omitted if the [`data-price`](../../widget#variable-price) is used.
|data-option-legal-advice | boolean | No | Indicates whether you should displaying the legal text after the widget. The default value is `false`.
|data-option-default-instalments | decimal | No | Allows you to configure the number of instalments that the widget will display by default.
|data-option-border-product |boolean | Yes | Indicates whether you should displaying the color border if the type is `product`. The default value is `true`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ dynamic result = client.Post($"/orders/{orderId}/cancel", new {});

|<t id="table.parameter">Parámetro</t> | <t id="table.type">Tipo</t> | <t id="table.description">Descripción</t>|
|---------|---------|---------|
:orderId | string | <t id="docs.yes"></t> | Order `ID`
:orderId | string | <t id="docs.yes">Yes</t> | Order `ID`

#### Response

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -249,8 +249,8 @@ dynamic result = client.Put($"/orders/{orderId}", payload);

|<t id="table.parameter">Parámetro</t> | <t id="table.type">Tipo</t> | <t id="table.required">Requerido</t> | <t id="table.description">Descripción</t>|
|---------|---------|---------|---------|
:orderId | string | <t id="docs.yes"></t> | Order ID.
[order](#order) | object | <t id="docs.yes"></t> | Order to update.
:orderId | string | <t id="docs.yes">Yes</t> | Order ID.
[order](../../checkout-creation/#order) | object | <t id="docs.yes">Yes</t> | Order to update.

### Response

Expand Down Expand Up @@ -415,8 +415,8 @@ dynamic result = client.Patch($"/orders/{orderId}", payload);

|<t id="table.parameter">Parámetro</t> | <t id="table.type">Tipo</t> | <t id="table.required">Requerido</t> | <t id="table.description">Descripción</t>|
|---------|---------|---------|---------|
:orderId | string | <t id="docs.yes"></t> | Order ID.
[order](#order) | object | <t id="docs.yes"></t> | Order to update.
:orderId | string | <t id="docs.yes">Yes</t> | Order ID.
[order](../../checkout-creation/#order) | object | <t id="docs.yes">Yes</t> | Order to update.

### Response

Expand Down
Loading
Loading