Servicio de consulta de tarjetas
Esta sección explica bajo el contexto de pago. Consulte el flujo para obtener más detalles.
A partir de un pago NIT con estado NOV (nuevo) , es posible consultar el BIN (primeros seis dígitos) de la tarjeta en SiTef para obtener datos sobre sus capacidades (posibilidad de pago a plazos, cuotas máximas, seguridad requisito de código, etc.), o incluso saber qué autoridad autorizadora de la tienda es la más adecuada para realizar el pago.
Flujo#
Descripción del flujo:
- El comerciante crea una transacción en Pago Online, pasando información como el código de la tienda, el número de cuotas y el código de pedido y obtiene un NIT (Número de identificación de la transacción) en respuesta.
- El comerciante envía el NIT obtenido en el paso anterior y los datos de la tarjeta a consultar. Como resultado, Carat devuelve datos sobre las capacidades de la tarjeta enviada.
- La tienda virtual luego procede a consumir el servicio de procesamiento de pagos, pasando el NIT y los datos de la tarjeta del comprador. Si tiene éxito, la transacción de pago cambiará su estado a "CON" (confirmado).
Detalles de la llamada#
- Recurso:
/v1/payments/{nit}/cards - Método HTTP:
POST - Formato de solicitud:
JSON - Formato de respuesta:
JSON - Parámetros de encabezado:
| Parámetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
merchant_id | Código de tienda en el 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 |
Content-Type | Debe enviarse con el valor application/json. | = 15 AN | SI |
Obs.: a pesar de ser una consulta, se eligió el método POST por razones de seguridad.
Ejemplos#
A continuación, se muestran algunos ejemplos de llamadas al servicio de búsqueda de tarjetas con la herramienta cURL.
Consulta de tarjeta con envío de autorización#
Solicitud:
Respuesta:
Consulta de tarjeta sin envío de autorización#
Solicitud:
Respuesta:
Parámetros de solicitud#
En la siguiente tabla, hay una descripción de los parámetros de solicitud para el servicio de consultade tarjetas:
| Parámetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
authorizer_id | Código de autorizador en el Carat. Más información. Este campo solo es obligatorio si se envía el campo wallet_transaction_id. Si este campo no se envía, Carat asume que es una tarjeta de crédito | < 3 N | COND. |
routing_id | Código de ruta en el Carat. Este campo solo es necesario para obtener datos adicionales de IPG. | < 3 N | COND. |
| card | |||
number | Número de tarjeta del comprador (PAN). | < 19 N | SI |
token | HASH de una tarjeta almacenada en Carat. No está permitido enviar un número de tarjeta abierta (campo number) y una tarjeta almacenada (campo token) en la misma solicitud. | = 88 AN | NO |
wallet_transaction_id | ID de una transacción de billetera digital. Por ahora, esta funcionalidad solo está disponible para el autorizador de Visa Checkout (authorizer_id: 406). No está permitido enviar un número de tarjeta abierta (campo number), una tarjeta almacenada (campotoken) y un wallet_transaction_id en la misma solicitud. | < 25 AN | NO |
do_par_inquiry | Informa si se realizará la llamada a la Consulta de VISA PAR. El valor de respuesta se devolverá en el campo par de callback.Valores permitidos: true - Se realizará la solicitud PAR false - No se realizará la solicitud PAR. Valor estándar: false | < 5 A | NO |
Parámetros de respuesta#
Si tiene éxito, el código de respuesta HTTP será "200". Cualquier otro código debe interpretarse como un error. En la siguiente tabla se muestra la descripción de los parámetros de respuesta del servicio de búsqueda de tarjetas:
| Parámetro | Descripción | Formato |
|---|---|---|
code | Código de respuesta de Carat. Cualquier código que no sea "0" significa error. Más información. | < 4 N |
message | Mensaje de respuesta de pago oline. | < 500 AN |
| payment | ||
status | Estado de la transacción de pago en Carat. Más información. | = 3 AN |
| card | ||
authorizer_code | Código de respuesta del autorizador. | < 10 AN |
authorizer_message | Mensaje de respuesta del autorizador. | < 500 AN |
acquirer_name | Nombre de enrutamiento. Por ejemplo: Cielo | < 256 AN |
authorizer_id | Código de autorizador (utilice este ID al realizar el pago). | < 3 N |
is_customer_id_required | Indica la recogida obligatoria del documento del cliente. | < 5 T / F |
is_expiry_date_required | Indica la obligación de cobrar la fecha de caducidad de la tarjeta del comprador. | < 5 T / F |
is_installment_funding_enabled | Indica si el pago a plazos está habilitado. | < 5 T / F |
is_security_code_required | Indica la recopilación de códigos de seguridad obligatorios. | < 5 T / F |
is_spot_sale_enabled | Indica si el pago en efectivo está habilitado. | < 5 T / F |
is_with_interest_sale_enabled | Indica si el pago de intereses está habilitado. | < 5 T / F |
is_without_interest_sale_enabled | Indica si el pago sin interés está habilitado. | < 5 T/F |
max_installments_with_interest | Cuotas máximas con intereses. | < 2 N |
min_installments_with_interest | Cuota mínima con intereses. | < 2 N |
visa_checkout_data | Objeto con datos devueltos por Visa Checkout. | El |
financing_plan_list | Objeto consistente en una serie de planes de financiamiento presentados en el enrutamiento de Via Certa Financiadora. Un plan de financiación consta de los siguientes campos: plan_cod: código de identificación del plan de financiación, que debe enviarse en el momento del pago; tipo_plano: código de tipo de plan de financiación financiación; desc_plano: descripción del plan, que se puede presentar al comprador; parc_plano: número máximo de cuotas posibles del plan. | El |
is_customer_postal_code_required | Indica la recopilación obligatoria del código postal del usuario. | < 5 T / F |
par | Valor PAR devuelto por VISA si se envía el campo do_par_inquiry con el valor true en la solicitud. | < 32 AN |
| card.prefixes [] | Este campo contiene los prefijos (datos adicionales) devueltos por SiTef. | |
key | Nombre de prefijo. | < 1024 AN |
value | Valor de prefijo. | < 1024 AN |
| details[] | Este campo contiene detalles devueltos por el enrutamiento IPG | |
brand | La marca de la tarjeta. La marca de la tarjeta. | < 1024 AN |
brand_product_id | ID de producto de de la de la tarjeta. El ID de producto de la marca. | < 1024 AN |
card_function | Función de tarjeta. Función de tarjeta. | CRÉDITO, DÉBITO, PREPAGO, VALE, INDEFINIDO |
commercialCard | Indica si la tarjeta es corporativa o no corporativa. Indica si es una tarjeta corporativa o no corporativa. | CORPORATIVO, NO_CORPORATIVO |
issuer_country | El país del emisor de la tarjeta. El país del emisor. | < 1024 AN |
issuer_name | El nombre del emisor de la tarjeta. El nombre del emisor. | < 1024 AN |