Servicio de Ejecución de preautorización

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ónFormatoObligatorio
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:#

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",
"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"
}
}

Códigos de respuesta

Ver referencia en Códigos API - Códigos de respuesta

Parámetros de solicitud#

ParámetroDescripciónFormatoObligatorio
authorizer_idCódigo de autorizador en el Carat. Ver documento Autorizadoras. < 3 NSI
numberNúmero de tarjeta del comprador (PAN). Mayor 14 y menor o igual que 19. < 19 NCOND.
expiry_dateFecha de caducidad "MMAA".= 4 NCOND.
security_codeCódigo de seguridad. De 3 a 5. < 5 NCOND.
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

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ámetroDescripciónFormato
codeCódigo de respuesta en Carat. Cualquier código que no sea 0 significa falla. Para obtener más información, consulte el documento Códigos de respuesta.< 4 N
messageMensaje de respuesta de Carat.< 500 AN
pre_authorization
authorizer_messageMensaje de respuesta del autorizador.< 500 AN
statusStatus de la transacción de autorización previa en Carat.= 3 AN
nitIdentificador de la transacción de autorización previa en Carat.= 64 AN
order_idCódigo de pedido enviado por la tienda al crear la transacción.< 40 AN
customer_receiptRecibo (a través del cliente).< 4000 AN
merchant_receiptRecibo (vía establecimiento).< 4000 AN
authorizer_idCódigo de autorizadora en el Carat. Ver documento Autorizadoras.< 4 N
acquirer_idAdquirente/código de enrutamiento utilizado en la transacción.< 4 N
acquirer_nameNombre del adquirente/enrutamiento utilizado en la transacción.< 100 AN
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
authorization_numberNumero de autorización.< 6 AN
merchant_usnNúmero secuencial único enviado por la tienda al crear la transacción.< 12 AN
esitef_usnNúmero secuencial único de la transacción de autorización previa en Carat.= 15 N
sitef_usnNúmero secuencial único de la transacción de autorización previa en SiTef.< = 6 N
host_usnNSU del autorizador.< 15 AN
amountImporte de compra especificado por la tienda (en céntimos) al crear la transacción< 12 AN
payment_typeTipo de pago del autorizador elegido: C = crédito, D = débito, O = otros métodos de pago= 1 AN
issuerCódigo de bandera devuelto por el autorizador. Banderas.< 5 AN
authorizer_merchant_idCódigo de afiliación del comerciante con la agencia autorizadora.< 100 AN