Servicio de captura de autorización previa

El flujo sería: realizar la operación de ejecución de preautorización y si se aprueba el resultado, se debe consumir el servicio de captura para completar el flujo. La captura se realizará en el momento definido por las reglas de negocio de la aplicación.

Detalles de la llamada#

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

Ejemplo#

Solicitud:

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

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"capture": {
"authorizer_code": "000",
"authorizer_message": "Transacao Aprov.",
"status": "CON",
"nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
"order_id": "orderID",
"customer_receipt": "=== CUSTOMER RECEIPT ===",
"merchant_receipt": "=== MERCHANT RECEIPT ===",
"authorizer_id": "2",
"acquirer_id": "1005",
"acquirer_name": "Redecard",
"authorizer_date": "03/05/2022T11:16",
"authorization_number": "035374",
"merchant_usn": "20190406",
"esitef_usn": "220503097392624",
"sitef_usn": "035374",
"host_usn": "999035374 ",
"amount": "900",
"payment_type": "C",
"issuer": "2",
"authorizer_merchant_id": "000000000000005"
}
}

Códigos de respuesta

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

Parámetros de solicitud#

El envío de datos de la tarjeta es obligatorio para las transacciones de enrutamiento de SiTef excepto para el adquirente Cetelem . Solo se debe usar uno entre los campos: number, token o wallet_transaction_id
ParámetroDescripciónFormatoObligatorio
amountMonto total de la compra (en centavos).< 12 NSI
card
numberNúmero de tarjeta del comprador (PAN).< 19 NCOND.
expiry_dateFecha de vencimiento de la tarjeta en formato MMAA.= 4 NCOND.
security_codeCódigo de seguridad.< 5 NCOND.

Parámetros de respuesta#

ParámetroDescripciónFormato
codeCódigo de respuesta de Carat. Cualquier código que no sea "0" significa error. Para obtener más información, consulte el documento adjunto A-2 - Códigos de respuesta.< 4 N
messageMensaje de respuesta de Carat.< 500 AN
capture
authorizer_codeCódigo de respuesta del autorizador.< 10 AN
authorizer_messageMensaje de respuesta del autorizador.< 500 AN
statusStatus de la transacción de preautorización en Carat.= 3 AN
nitIdentificador de la transacción de preautorización en Carat.= 64 AN
order_id
customer_receiptRecibo (vía cliente).< 4000 AN
merchant_receiptRecibo (vía establecimiento).< 4000 AN
authorizer_idCódigo de autorización utilizado en la transacción.< 4 N
acquirer_idCódigo de la entidad adquirente/enrutamiento utilizado en la transacción.< 4 N
acquirer_nameNombre del adquirente / enrutamiento utilizado en la transacción.< 100 AN
authorizer_dateFecha de vigencia de la preautorización devuelta por el autorizador en el 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 preautorización de Carat.= 15 N
sitef_usnNúmero secuencial único de la transacción de preautorización en SiTef.= 6 N
host_usnAutorizador NSU.< 15 AN
amountImporte de la compra especificado por la tienda (en centavos) al momento de la creación de la transacción.< 12 AN
issuerCódigo de marcas de tarjeta devuelto por la autorizadora.< 5 AN
authorizer_merchant_idCódigo de afiliación del comerciante con la agencia autorizadora.< 100 AN