Servicio de Ejecución de la autorización previa

Detalles de la llamada#

El nit obtenido en la devolución del servicio de creación de autorización previa debe enviarse en la operación de ejecución de autorización previa junto con los parámetros descritos en la tabla siguiente (según la necesidad de cada aplicación):

  • Recurso: /v1/preauthorizations/{nit}
  • Método HTTP: POST
  • Formato de solicitud : JSON
  • Formato de respuesta : JSON
  • Parámetros de encabezado :
ParámetroDescripciónFormatoObrigatorio
Content-TypeValor fijo application / json= 15 ANSI
merchant_idCódigo de tienda en el Portal Carat. Los códigos de producción y certificación serán diferentes < 15 ANSI
merchant_keyClave de autenticación para la tienda de pagos online. Las claves de producción y certificación serán diferentes. < 80 ANSI

Ejemplos:#

Autorización Previa#

Solicitud:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/preauthorizations/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"authorizer_id":"2",
"installments":"2",
"installment_type":"4",
"card":{
"number":"xxxxxxxxxxxxxxxx",
"expiry_date":"1222",
"security_code":"123"
}
}
--verbose

Respuesta:

{
"code":"0",
"message":"OK. Transaction successful.",
"pre_authorization":{
"authorizer_code":"000",
"authorizer_message":"Transacao OK.",
"status":"CON",
"nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
"customer_receipt":"=== CUSTOMER RECEIPT ===",
"merchant_receipt":"=== MERCHANT RECEIPT ===",
"authorizer_id":"2",
"authorizer_date":"09/11/2018T19:40",
"acquirer_id":"1005",
"acquirer_name":"Redecard",
"authorization_number":"013245",
"merchant_usn":"20190101",
"esitef_usn":"181109017689784",
"order_id":"orderID",
"sitef_usn":"212194",
"host_usn":"999212194",
"amount":"100",
"issuer":"2",
"payment_type":"C",
"authorizer_merchant_id":"000000000000000"
}
}

Autorización Previa - Token de marca de tarjeta#

Algunas marcas de tarjetas poseen una solución de tokenización que ofrece el almacenamiento de tarjetas en cajas fuertes en la propia marca, de forma encriptada. Esta tokenización de marca 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:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/preauthorizations/8621c93b58e507d3fe0bda407f5cb0b1fe3971df591fd2652cc9f737134502d3"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"card": {
"expiry_date": "1023",
"number": "xxxxxxxxxxxxxxxx",
"security_code": "123",
"cryptogram":"cryptogram_teste_bin_pre4444444"
}
}'

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"pre_authorization": {
"authorizer_code": "000",
"authorizer_message": "Transacao Aprov.",
"status": "CON",
"nit": "8621c93b58e507d3fe0bda407f5cb0b1fe3971df591fd2652cc9f737134502d3",
"order_id": "1670945065929",
"customer_receipt":"=== CUSTOMER RECEIPT ===",
"merchant_receipt":"=== MERCHANT RECEIPT ===",
"authorizer_id": "2",
"acquirer_id": "1005",
"acquirer_name": "Redecard",
"authorizer_date": "13/12/2022T12:24",
"authorization_number": "136231",
"merchant_usn": "16114726760",
"esitef_usn": "221213115168264",
"sitef_usn": "136231",
"host_usn": "999136231 ",
"amount": "25255",
"payment_type": "C",
"issuer": "1",
"authorizer_merchant_id": "000000000000005",
"terminal_id": "ES000038"
}
}

Parámetros de solicitud#

ParámetroDescripciónFormatoObligatorio
authorizer_idCódigo de autorizador en el Portal Carat. Ver documento [Autorizadores.] (Authorizadoras.md) < 3 NSI
customer_idDocumento de identidad del comprador. Utilice solo caracteres alfanuméricos (sin puntos, guiones u otros caracteres especiales). < 20 ANNO
discountImporte 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 NNO
installmentsJunto con el campo installment_type, indica cuotas (\ *), utilizado APENAS com autorizadoras roteadas por e-Rede, GetNetLac via SiTef, Rede via SiTef, Cetelem via SiTef e iCards via SiTef. Envie 1 para transacciones en efectivo. < 2 NCOND.
installment_typeJuntamente com o campo installments, indica parcelamento (*), utilizados APENAS com autorizadoras roteadas por e-Rede, GetNetLac via SiTef, Rede via SiTef, Cetelem via SiTef e iCards via SiTef. Para as demais roteamentos, o parcelamento é possível somente na captura. Os valores possíveis para installment_type são:
3.: Parcelamento com juros da administradora do cartão
4.: Parcelamento realizado pela loja e sem juros (adotar este valor como padrão/default para transações à vista)
= 1 NCOND.
mccMerchant 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 NObligatorio solo para sub adquisición Stone WS
merchant_emaile-mail de la tienda. Este parámetro, cuando se envía, sobrescribe el e-mail de registro de la tienda. < 40 ANNO
nitIdentificador de transacción en el Portal Carat (encriptado). Recibí la devolución de llamada para comenzar la transacción.= 64 ANSI
promo_codeCódigo de promoción de Visa Checkout utilizado en la preautorización. En caso de preautorizaciones con valores promocionales para el uso de Visa Checkout, VISA sugiere que este campo se envíe adicionalmente.ANNO
soft_descriptorTexto 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) < 22 ANNO
subtotalImporte 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 NNO
subacquirer_merchant_idIdentificación de la tienda en el sub adquirente. < 22 NNO
cardDebe se utilizar apenas una entre los campos: number, token o wallet_transaction_id
numberNúmero de tarjeta del comprador (PAN).

Token generado por la tarjeta (DPAN) para pago con token de marca de tarjeta. Más información
< 19 N
cryptogramCriptograma generado por la tarjeta.= 28 ASí para pagos con token de marca de tarjeta
tokenSe 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 ANCOND.
wallet_transaction_idCódigo de identificación de transacción con wallet VisaCheckout. Requerido solo para Visa Checkout < 25 ANCOND.
initial_wallet_transaction_idInforma 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 ANCOND.
holderNombre del portador de la tarjeta. Requerido solo para enrutamientos e-Rede, GetNet WS y VR (SmartNet). < 30 ANCOND.
expiry_dateFecha de vencimiento de la tarjeta en formato "MMAY".= 4 NCOND.
security_codeCódigo de seguridad. < 5 NCOND.
wallet_typeCampo 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”.ANNO
external_authentication Este elemento recibe campos de autenticación MPI.
versionVersión de 3DS utilizada en el proceso de autenticación (actualmente solo se acepta la versión 2)< 1 ANNO
eciIndicador de comercio electrónico: indica el nivel de seguridad de la transacción con autenticación del titular de la tarjeta < 3 NNO
reference_idIdentificador de la operación de autenticación del titular de la tarjeta, realizada en un servicio ajeno al Portal Carat < 40 NNO
cavvValor 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 NNO
acquirerDados específicos necessários dependendo da adquirente/roteamento.
terminalTerminal SiTef que desea utilizar. Si no se envía, el Portal Carat generará una terminal aleatoria. = 14 NNO
company_codeCó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 NNO

(\ *) 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: Los parámetros terminal y company_code deben 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âmetroDescriçãoFormato
authorizer_dateFecha 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_idCódigo de autorización utilizado en la transacción. < 4 N
authorizer_merchant_idCódigo de afiliación del comerciante con la agencia autorizadora. < 100 AN
authorizer_messageMensaje de respuesta del autorizador. < 500 AN
customer_receiptCupón (a través del cliente). < 4000 AN
eciIndicador 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_usnNúmero secuencial único de la transacción de autorización previa en Portal Carat.= 6 N
host_usnNSU del autorizador. < 15 AN
emisorCódigo de la marca de la tarjeta devuelto por el autorizador. < 5 AN
merchant_receiptCupón (vía establecimiento).< 4000 AN
merchant_usnNúmero secuencial único enviado por la tienda al crear la transacción. < 12 AN
nitIdentificador de la transacción de autorización previa en Portal Carat.= 64 AN
order_idCódigo de pedido enviado por la tienda al crear la transacción. < 40 AN
payment_typeTipo 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_usnNúmero secuencial único de la transacción de autorización previa en SiTef.= 15 N
statusStatus de la transacción de autorización previa en Portal Carat.= 3 AN
tidID de transacción en adquirente / enrutamiento. Este campo solo se devuelve en transacciones con adquirentes externos SiTef. < 40 AN
xidCampo XID devuelto en autenticaciones 3DS o ciertos adquirientes / enrutamintos. < 40 AN
retryable_codeIndicador 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