Servicio de captura de autorización previa idempotente
La captación de la Pre-Autorización tiene como objetivo realizar la Pre-Autorización, la cual puede ser en el monto total o menor que el monto total de la Pre-Autorización. Esto dependerá de la regla comercial de la aplicación Tienda virtual.
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.
En la operación de captura, el parámetro amount puede tener un valor igual o menor que el valor del parámetro amount de preautorización.
Para el enrutamiento GetNetLac vía SiTef , el abono también se puede realizar en el paso de preautorización y en este caso, la captura debe recibir un número de cuotas igual o superior al enviado anteriormente. Si la preautorización se realiza en efectivo, la captura no puede ser a plazos.
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ámetro | Descripción | Tamaño | Obligatorio |
|---|---|---|---|
Content-Type | Valor fijo application/json | = 15 AN | SÍ |
merchant_id | Código de la tienda en el Portal Carat. Los códigos de producción y certificación serán diferentes | < 15 AN | SÍ |
merchant_key | Clave de autenticación para la tienda de Portal Carat. Las claves de producción y certificación serán diferentes. | < 80 AN | SÍ |
merchant_key | Clave de autenticación para la tienda de Portal Carat. Las claves de producción y certificación serán diferentes. | < 80 AN | SÍ |
idempotency_key | Es como si fuera un código aleatorio (identificador), de 80 caracteres, creado como un integrador que usaré en la API do Carat. | < 80 N | SIM |
Ejemplo#
Solicitud:
Respuesta:
Ejemplo si la solicitud tiene lo mismo idempotency_key y lo mismo payload.#
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#
| Parámetro | Descripción | Formato | Obligatorio | |||
|---|---|---|---|---|---|---|
amount | Monto total de la compra (en centavos). | < 12 N | SÍ | |||
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 | Número de cuotas. 1 = en efectivo. La cantidad máxima de cuotas configuradas en el portal de Portal Carat del comerciante no se verificará en este campo, sirviendo sólo para pagos HTML. | < 2 N | SÍ | |||
installment_type | Junto con el campo de installments, indica cuotas. Los valores posibles para installment_type son:
| = 1 N | SÍ | |||
promo_code | Có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. | AN | NO | |||
subtotal | Importe subtotal, en centavos. En caso de preautorizaciones con valores promocionales para el uso de Visa Checkout, VISA ssugiere que se envíe este campo adicionalmente.. | < 12 N | NO | |||
card | 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 | Número de tarjeta del comprador (PAN). | < 19 N | COND. | |||
token | Se utiliza para casos recurrentes de preautorización, en los que la tarjeta ya debe estar almacenada en la base de datos de 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 | Le dice si la ID de Wallet (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. | |||
expiry_date | Fecha de vencimiento de la tarjeta en formato MMAA. | = 4 N | COND. | |||
security_code | Código de seguridad. | < 5 N | COND. | |||
acquirer.submerchant_split[] | Consiste en una array para pagos split, exclusiva para enrutamiento BIN y Sipag, ambos a través de SiTef. Permite la división de partes del monto total del pago entre otras empresas. El número máximo de elementos permitidos en esta array es de 5 elementos. Cada elemento está compuesto por los campos | |||||
submerchant_code | Código de establecimiento BIN/Sipag | < 15 AN | NO | |||
submerchant_amount | valor de transacción para el establecimiento | < 12 N | NO | |||
mcc | El MCC (Merchant Category Code) es un código que clasifica una empresa por el tipo de bienes o productos ofrecidos. | < 4 N | NO | |||
subacquirer_merchant_id | Identificación de la tienda en el sub adquirente. | < 22 AN | NO | |||
ecomm_pos_ref | Este campo enviará una identificación que aparecerá en el campo PDV del informe SiTef Web para transacciones de comercio electrónico. | < 8 AF | NO | |||
Parâmetros de resposta#
| Parámetro | Descripción | Formato |
|---|---|---|
code | Código de respuesta de Portal 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 |
message | Mensaje de respuesta de Portal Carat. | < 500 AN |
capture | ||
acquirer_id | Código de la entidad adquirente/enrutamiento utilizado en la transacción. | < 4 N |
acquirer_name | Nombre del adquirente / enrutamiento 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 AN |
authorization_number | Numero de autorización. | < 6 AN |
authorizer_code | Código de respuesta del autorizador. | < 10 AN |
authorizer_date | Fecha 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 |
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 (vía cliente). | < 4000 AN |
eci | Eletronic Commerce Indicador (indicador del nivel de seguridad de la transacción de preautorización a través de Cielo e-Commerce). | < 3 AN |
esitef_usn | Número secuencial único de la transacción de preautorización de Portal Carat. | = 15 N |
host_usn | Autorizador NSU. | < 15 AN |
issuer | Código de marcas de 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 preautorización en Portal Carat. | = 64 AN |
payment_type | Tipo de pago del autorizador elegido: B = comprobante bancario, C = crédito, D = débito, P = tarjeta de crédito de Private Label pura, T = transferencia bancaria, G = tarjeta gift, O = otros métodos de pago, W = comprobante bancario NR vía Web Service | = 1 AN |
sitef_usn | Número secuencial único de la transacción de preautorización en SiTef. | = 6 N |
status | Status de la transacción de preautorización en Portal Carat. | = 3 AN |
tid | ID de transacción en adquirente/enrutamiento. Este campo solo se devuelve en transacciones con adquirentes que no son SiTef. | < 40 AN |
xid | Campo XID devuelto en autenticaciones 3DS o ciertos adquirientes/enrutamientos. | < 40 AN |
| card | ||
suffix | Últimos 4 dígitos de la tarjeta del comprador. | = 4 AN |
bin | 6 primeros dígitos de la tarjeta del comprador. | = 6 AN |