Servicio de confirmación de edición de horarios
Después de obtener un SEID en el paso anterior, la tienda podrá editar el horario actual. Todos los parámetros enviados se tendrán en cuenta para su edición, es decir, si no quiere cambiar un atributo del horario, sólo tiene que enviar el parámetro vacío.
Detalles de la llamada#
- Recurso:
/v1/schedules/edits/{seid} - Método HTTP:**
PUT. - Formato de la solicitud:**
JSON. - Formato de respuesta:
JSON - Parámetros del encabezado:**
| Parámetro | Descripción | Formato | Requerido |
|---|---|---|---|
merchant_id | Código de tienda en Portal Carat. Los códigos de producción y certificación serán diferentes. | < 15 AN | SI |
merchant_key | Clave de autenticación para la tienda de pagos online. Las claves de producción y certificación serán diferentes. | < 80 AN | SI |
Content-Type | Debe enviarse con el valor application / json. | = 15 AN | SI |
Ejemplos#
A continuación, se muestran algunos ejemplos de llamadas al servicio de edición de horarios con la herramienta cURL.
Editando múltiples atributos#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Inactivación del horario agendado#
Aplicación:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Parámetros de solicitud#
En la siguiente tabla se muestra la descripción de los parámetros de solicitud del servicio de edición de programación:
| Parámetro | Descripción | Formato | Requerido |
|---|---|---|---|
status | Estado del programa. Puede recibir los siguientes valores: ATV - Activa el horario. Este valor debe usarse en programas con un estado INA (inactivo). Si el cronograma se reactiva después de su fecha de ejecución, se reprogramará para el mismo día del mes siguiente. INA - Inactiva el cronograma, es decir, ya no se ejecutarán los pagos previamente programados. | = 3 AN | NO |
amount | Valor en centavos de los pagos programados. | < 12 N | NO |
next_date | Fecha de la próxima ejecución del programa en formato "DD / MM / AAAA". Solo se permiten fechas futuras con un día entre el 1 y el 28. = 10 D | NO | |
cuotas | Número de cuotas para cada pago programado. | < 2 N | NO |
install_type | Tipo de financiación a plazos para cada pago programado: Valor 3 = cuota con intereses de la compañía de la tarjeta. Valor 4 = cuota realizada por la tienda y sin intereses (adoptar este valor por defecto / predeterminado para transacciones en efectivo). | < 2 N | NO |
soft_descriptor | Texto adicional que aparecerá con el nombre del establecimiento en el extracto de la tarjeta de crédito del comprador. [Más información] (soft-descriptor.md) | < 30 AN | NO |
show_times_invoice | Para cronogramas de tiempo finitos, envíe este campo con un valor "verdadero" si desea agregar el número de ejecuciones / ejecuciones totales al final del campo "soft_descriptor" (ejemplo: Suscripción 3/12). | < 5 T / F | NO |
| card | |||
number | Número de tarjeta del comprador (PAN). | < 19 N | NO |
expiry_date | Fecha de vencimiento de la tarjeta en formato "MMAY". El envío de este parámetro debe, necesariamente, ir acompañado del número de la tarjeta, es decir, no es posible enviar solo la fecha de vencimiento. | = 4 N | NO |
Parámetros de respuesta#
Si tiene éxito, el código de respuesta HTTP será "200". Cualquier otro código debe interpretarse como un error. En la siguiente tabla se muestra la descripción de los parámetros de respuesta del servicio de edición de programación:
| Parámetro | Descripción | Formato |
|---|---|---|
code | Código de respuesta de Portal Carat. Cualquier código que no sea "0" (cero) significa falla. [Más información.] (codigos-da-api.md#codigos-de-respuesta) | < 4 N |
message | Mensaje de respuesta de Portal Carat. | < 500 AN |
| schedule | ||
status | Estado de la agenda del Portal Carat. [Más información.] (codigos-da-api.md#status-de-agenda) | = 3 AN |
amount | Valor de los pagos programados especificados por la tienda (en centavos) en la creación de la transacción. | < 12 N |
next_date | Fecha de ejecución del próximo pago programado en formato "DD / MM / AAAA". | = 10 D |
number_of_times | Número total de pagos programados. | < 3 N |
current_times | Número de pagos programados ya realizados. | < 3 N |
cuotas | Número de cuotas que se utilizarán para los pagos programados. | < 2 N |
install_type | Tipo de financiación que se utilizará para los pagos programados. | < 2 N |
soft_descriptor | Texto adicional que aparecerá con el nombre del establecimiento en el extracto de la tarjeta de crédito del comprador. | < 30 AN |
show_times_invoice | Para programas de tiempo finitos, si este campo tiene un valor "verdadero", agrega al final del campo "soft_descriptor" el número de ejecuciones / ejecuciones totales (ejemplo: Suscripción 3/12). | < 5 T / F |
| schedule_edit | ||
status | Estado de edición del Portal Carat. Puede tomar los siguientes valores: NOV - Nuevo EXP - Caducado CON - Confirmado INV - No válido | = 3 AN |