Servicio de activcción del horario
Después de programar un horario sin pago y obtener un SID, puede continuar con el siguiente paso en el flujo: la llamada al servicio de activación de programación de horario. Para reservas con pago, se debe llamar al [servicio que efectúa el pago] (payment-rest-dopayment.md).
Detalles de la llamada#
- Recurso:
/ v1 / schedule / {sid} - Método HTTP:
POST - Formato de solicitud:
JSON - Formato de respuesta:
JSON - Parámetros de encabezado:
| Parámetro | Descripción | Formato | Requerido |
|---|---|---|---|
comerciante_id | Código de tienda en Portal Carat. Los códigos de producción y certificación serán diferentes. | < 15 AN | SI |
comerciante_clave | 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 muestra un ejemplo de cómo llamar al servicio de activación de programación mediante la herramienta cURL.
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Códigos de respuesta
Ver referencia en Códigos API - Códigos de respuesta
Parámetros de solicitud#
En la siguiente tabla se muestra la descripción de los parámetros de solicitud del servicio de activación de programación:
| Parámetro | Descripción | Formato | Requerido |
|---|---|---|---|
authorizer_id | Código de autorizador en el Portal Carat. [Más información.] (authorizadoras.md) Si este campo no se envió en el paso de creación de la transacción, se vuelve obligatorio al consumir el servicio de activación de programación de horario. | < 3 N | COND. |
| card | Datos de la tarjeta. | ||
number | Número de tarjeta del comprador (PAN). | < 19 N | SI |
expiry_date | Fecha de vencimiento de la tarjeta en formato "MMAY". Su obligación depende del comprador elegido. En la mayoría de los casos, este campo es obligatorio. | = 4 N | COND. |
holder | Nombre del tarjetahabiente. Solicitado solo para pagos con e-Rede, GetNet WS y VR (SmartNet). | < 30 AN | COND. |
token | HASH de una tarjeta almacenada en Portal Carat. No está permitido enviar un número de tarjeta abierta (campo número) y una tarjeta almacenada (campo token) en la misma solicitud. | = 88 AN | NO |
wallet_transaction_id | ID de una transacción de billetera digital. Por ahora, esta funcionalidad solo está disponible para Visa Checkout Authorizer. No está permitido enviar un número de tarjeta abierta (campo número), una tarjeta almacenada (campo token) y un wallet_transaction_id en lo solicita. | < 25 AN | NO |
Parámetros de respuesta#
Si tiene éxito, el código de respuesta HTTP será "201". 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 activació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 programación de horario en el Portal Carat. [Más información.] (codigos-da-api.md#status-de-agendamiento) | = 3 AN |
sid | Identificador de la transacción de reserva en el Portal Carat. | = 64 AN |
schedule_usn | Número secuencial único del Portal Carat. | = 15 N |
authorizer_id | Código de autorización que se utilizará en los pagos programados. | = 4 N |
amount | Cantidad de pagos programados especificados por la tienda (en centavos) en la creación de la transacción. | < 12 N |
order_id | Código de pedido enviado por la tienda al crear la transacción. | < 40 AN |
comerciante_usn | Número secuencial único enviado por la tienda al momento de la creación de la transacción. | < 12 N |
initial_date | Fecha de ejecución del primer pago programado en formato "DD / MM / AAAA". | = 10 D |
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 |
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 |
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 |