Preautorización
ADVERTENCIA: Esta página es un documento en construcción, sujeto a cambios sin previo aviso, y aún desvinculado de nuestra documentación completa. Si desea acceder a toda nuestra documentación, haga clic aquí.
Interfaz de preautorización que permite a la tienda realizar solicitudes de preautorización en una sola llamada. Haga clic aquí para obtener más información sobre la captura de autorización previa.
Detalles de la llamada#
- Recurso:
/v2/preauthorizations/ - Método HTTP:
POST - Formato de solicitud :
JSON - Formato de respuesta :
JSON - Parámetros de encabezado :
| Parámetro | Descripción | Formato | Obrigatorio |
|---|---|---|---|
Content-Type | Valor fijo application / json | = 15 AN | SI |
merchant_id | Código de tienda en el 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 |
Ejemplos:#
Solicitud:
Respuesta:
Autorización Previa Token CARD PAR#
Se creó un objeto {{card}} que recibe el campo {{par}}: La Referencia de Cuenta de Pago, es un valor vinculado al PAN: Número de Cuenta Primaria de una tarjeta Mastercard.
Solicitud:
Vale la pena enfatizar que solo funcionará si la variable {{criptograma}} está definida en la solicitud.
Respuesta:
Autorización Previa - Token de bandera de tarjeta#
Algunas banderas de tarjetas poseen una solución de tokenización que ofrece el almacenamiento de tarjetas en cajas fuertes en la propia bandera, de forma encriptada. Esta tokenización de bandera tiene como objetivo mejorar la seguridad y la calidad de la información de la tarjeta transmitida, lo que conduce a posibles aumentos en la conversión de la aprobación por parte de los bancos emisores.
Solicitud:
Respuesta:
Parámetros de solicitud#
| Parámetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
amount | Monto total de la compra (en centavos). Ejemplo: 1,00 = 100 o 1,100,00 = 110000 - envíe el valor sin la coma y el punto | <12N | SI |
encrypted_card | Este campo debe enviarse con un valor "true" si el número de tarjeta que se enviará en el siguiente paso del flujo utiliza cifrado SiTef. La opción de enviar la tarjeta encriptada solo será posible con enrutamiento vía SiTef y es necesaria la configuración previa del SiTef en cuestión. Opciones: 1. "true" 2. "false" (valor defaut) | <5 AN | NO |
merchant_usn | Número secuencial único para cada pedido, creado por la tienda. La NSU se utilizará en todas las comunicaciones con la tienda, con el fin de identificar el pedido. Como es una posible clave para el acceso desde el lado de la tienda, aunque es opcional para el Portal Carat, se recomienda encarecidamente que el campo sea formateado y enviado por la aplicación de la tienda. | <12 N | NO |
order_id | Código de pedido que se mostrará al comprador, definido por el comerciante. Se recomienda que sea diferente para cada pedido para facilitar la trazabilidad. Para las transacciones enrutadas a través del adquiriente Bin, hay un límite de 20 caracteres. | < 40 AN | SÍ |
authorizer_id | Código de autorizador en el Portal Carat. Ver documento [Autorizadores.] (Authorizadoras.md) | < 3 N | SI |
customer_id | Documento de identidad del comprador. Utilice solo caracteres alfanuméricos (sin puntos, guiones u otros caracteres especiales). | < 20 AN | NO |
discount | Importe del descuento, en centavos. En caso de preautorizaciones con valores promocionales para el uso de Visa Checkout, VISA sugiere que este campo se envíe adicionalmente. | < 12 N | NO |
installments | Junto con el campo installment_type, indica cuotas*, utilizado ÚNICAMENTE con autorizadores enrutados por e-Rede, GetNetLac vía SiTef, Rede vía SiTef, Cetelem vía SiTef e iCards vía SiTef. Envie 1 para transacciones en efectivo. | < 2 N | COND. |
installment_type | Junto con el campo installments, indica cuotas*, utilizados ÚNICAMENTE con autorizadores enrutados por e-Rede, GetNetLac vía SiTef, Rede vía SiTef, Cetelem vía SiTef e iCards vía SiTef. Para las otras rutas, las cuotas solo son posibles durante la captura. Los valores posibles para tipo_cuota son:3.: Cuota con interés de la compañía de tarjeta4.: Cuota realizada por la tienda y sin interés (adoptar este valor como estándar/por defecto para transacciones en effectivo) | = 1 N | COND. |
mcc | Merchant Category Code - Indica el código de categoría de la tienda. Requerido cuando se usasubadquirência Stone WS y es posible enviarlo en subadquirência via SiTef. | < 4 N | Obligatorio solo para sub adquisición Stone WS |
merchant_email | E-mail de la tienda. Este parámetro, cuando se envía, sobrescribe el e-mail de registro de la tienda. | < 40 AN | 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 | < 22 AN | NO |
subtotal | Importe subtotal, en centavos. En caso de preautorizaciones con valores promocionales para el uso de Visa Checkout, VISA sugiere que este campo se envíe adicionalmente. | < 12 N | NO |
subacquirer_merchant_id | Identificación de la tienda en el sub adquirente. | < 22 N | NO |
card | Debe se utilizar apenas una entre los campos: number, token o wallet_transaction_id | ||
number | Número de tarjeta del comprador (PAN). Token generado por la tarjeta (DPAN) para pago con token de bandera de tarjeta. | < 19 N | SÍ |
cryptogram | Criptograma generado por la tarjeta. | = 28 A | Sí para pagos con token de marca de tarjeta |
token | Se utiliza para casos recurrentes de preautorización, en los que la tarjeta ya debe estar almacenada en la base de datos del Portal Carat. | = 88 AN | COND. |
wallet_transaction_id | Código de identificación de transacción con wallet VisaCheckout. Requerido solo para Visa Checkout | < 25 AN | COND. |
initial_wallet_transaction_id | Informa si el Wallet ID(wallet_transaction_id) se está utilizando por primera vez. Si es la primera vez, envíe true; de lo contrario, envíe false. Requerido solo para Visa Checkout. Valor predeterminado: true | < 5 AN | COND. |
holder | Nombre del portador de la tarjeta. Requerido solo para enrutamientos e-Rede, GetNet WS y VR (SmartNet). | < 30 AN | COND. |
expiry_date | Fecha de vencimiento de la tarjeta en formato "MMAY". | = 4 N | COND. |
security_code | Código de seguridad. | < 5 N | COND. |
wallet_type | Campo que especifica si la transacción se procesa con PAN o DPAN. Si "tipo" está vacío, el valor predeterminado es PAN (número de tarjeta no tokenizado). Si hay una transacción tokenizada, debes enviar el valor “network_token”. | AN | NO |
external_authentication | Este elemento recibe campos de autenticación MPI. | ||
version | Versión de 3DS utilizada en el proceso de autenticación (actualmente solo se acepta la versión 2) | < 1 AN | NO |
eci | Indicador de comercio electrónico_: indica el nivel de seguridad de la transacción con autenticación del titular de la tarjeta | < 3 N | NO |
reference_id | Identificador de la operación de autenticación del titular de la tarjeta, realizada en un servicio ajeno al Portal Carat | < 40 N | NO |
cavv | Valor de verificación de autenticación del titular de la tarjeta: código que indica el resultado de la autenticación del titular de la tarjeta. | < 40 N | NO |
acquirer | Dados específicos necessários dependendo da adquirente/roteamento. | ||
terminal | Terminal SiTef que desea utilizar. Si no se envía, el Portal Carat generará una terminal aleatoria. = 14 N | NO | |
company_code | Código de la empresa SiTef que desea utilizar. Si no se envía, el Portal Carat enviará el código de empresa registrado en la tienda. = 8 N | NO | |
mid | Código de comerciante adquirente: para las rutas BIN, el MID que utilizará el comerciante es único. Este campo debe usarse si es necesario seleccionar un MID diferente al predeterminado. | < 15 AN | COND |
additional_data | Elemento para el envío de datos adicionales. | ||
ecomm_pos_ref | Este campo enviará una identificación que aparecerá en el campo POS del reporte SiTef Web para transacciones de comercio electrónico. | < 8 AF | NO |
| iata | Este elemento contiene campos específicos de transacciones IATA. | ||
departure_tax | Impuesto de salida en centavos. | < 12 N | SÍ solo para installment_type = 6 o 7 |
first_installment | Entrada en transacciones IATA en centavos. Esta funcionalidad sólo está disponible para el adquirente de Getnet. | < 12 N | No |
* Pago en cuotas enrutada por GetNetLac a través de SiTef: En este caso, la tienda será responsable de controlar la cuota, por lo que las reglas de pago configuradas para la interfaz de pago HTML de Portal Carat no entrarán en vigencia, solo las reglas Se verificará y aplicará el pago a plazos por parte de la empresa autorizante. Para estas redes mencionadas, si la autorización previa se realiza en efectivo, la captura no se puede fraccionar. Además, las preautorizaciones enrutadas por GetNetLac a través de SiTef, cuando se dividen, solo se aceptan sin interés, es decir, con el parámetro installment_type = 4. NO se aceptan pagos a plazos que devengan intereses para esta ruta.
ATENCIÓN:
Además de los parámetros de devolución de los servicios descritos en esta especificación, Carat puede devolver otros parámetros sin previo aviso.
Es importante que la aplicación esté preparada para recibir parámetros desconocidos además de los ya especificados y simplemente ignorarlos.
Los parámetros
terminalycompany_codedeben usarse solo para enrutamiento a través de SiTef y deben enviarse simultáneamente.
También es necesario solicitar permiso al equipo de servicio Portal Carat Permitir enviando la empresa y el terminal de Sitef a través de REST.
Parámetros de respuesta#
La siguiente tabla contiene los parámetros de respuesta del servicio de promulgación de autorización previa. La aplicación debe almacenar los parámetros que considere necesarios. Sugerimos almacenar los parámetros: order_id, autorización_number, merchant_usn, esitef_usn, sitef_usn, host_usn, status, code, amount, message (el parámetromessage se puede mostrar al cliente).authorization_number
| Parámetro | Descripción | Formato |
|---|---|---|
code | Código de respuesta de Portal Carat. Cualquier código que no sea "0" significa error. [Más información.] (Api-codes.md # response-codes) | < 4 N |
message | Mensaje de respuesta de Portal Carat. | < 500 AN |
pre_authorization | ||
acquirer_id | Código del adquirente utilizado en la transacción. | < 4 N |
acquirer_name | NOmbre del adquirente utilizado en la transacción. | < 100 AN |
amount | Importe de la compra especificado por la tienda (en centavos) al momento de la creación de la transacción. | < 12 N |
authorization_number | Numero de autorización. | < 6 AN |
authorizer_code | Código de resposta do autorizador. | < 10 AN |
authorizer_date | Fecha de ejecución de la autorización previa devuelta por el autorizador en formato DD / MM / AAAA'T'HH: mm. Ejemplo: 13/07 / 2017T16: 03 | = 16 D |
authorizer_id | Código de autorización utilizado en la transacción. | < 4 N |
authorizer_merchant_id | Código de afiliación del comerciante con la agencia autorizadora. | < 100 AN |
authorizer_message | Mensaje de respuesta del autorizador. | < 500 AN |
customer_receipt | Cupón (a través del cliente). | < 4000 AN |
eci | Indicador de comercio electrónico (indicador del nivel de seguridad de la transacción de autorización previa a través de Cielo e-Commerce). | < 3 AN |
sitef_usn | Número secuencial único de la transacción de autorización previa en Portal Carat. | = 6 N |
host_usn | NSU del autorizador. | < 15 AN |
emisor | Código de la bandera de la tarjeta devuelto por el autorizador. | < 5 AN |
merchant_receipt | Cupón (vía establecimiento). | < 4000 AN |
merchant_usn | Número secuencial único enviado por la tienda al crear la transacción. | < 12 AN |
nit | Identificador de la transacción de autorización previa en Portal Carat. | = 64 AN |
order_id | Código de pedido enviado por la tienda al crear la transacción. | < 40 AN |
payment_type | Tipo de pago del autorizador elegido: B = boleto, C = crédito, D = débito, P = tarjeta de crédito Private Label puro,T = transferencia bancaria, G = tarjeta gift, O = otros métodos de pago | = 1 AN |
esitef_usn | Número secuencial único de la transacción de autorización previa en SiTef. | = 15 N |
status | Status de la transacción de autorización previa en Portal Carat. | = 3 AN |
tid | ID de transacción en adquirente / enrutamiento. Este campo solo se devuelve en transacciones con adquirentes externos SiTef. | < 40 AN |
xid | Campo XID devuelto en autenticaciones 3DS o ciertos adquirientes / enrutamintos. | < 40 AN |
retryable_code | Indicador de reversibilidad de una transacción cuya autorización fue denegada por el autorizador. Este campo será devuelto en la respuesta a la solicitud de pago con tarjeta y deberá ser tomado en cuenta en el mecanismo de reintento de transacciones de la tienda en línea. Códigos válidos:01 – Transacción denegada reversible, retener más tarde. 02 – Transacción denegada irreversible, no retentiva. | = 2 N |