Home

Descripción general

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.

En el caso de transacciones de Visa Checkout, este servicio también devolverá los datos de la tarjeta y del usuario devueltos por Visa.

Flujo#

Consulta Cartão

Descripción del flujo:

  1. El comerciante crea una transacción en Pagao 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.
  2. El comerciante envía el NIT obtenido en el paso anterior y los datos de la tarjeta a consultar. Como resultado, Portal Carat devuelve datos sobre las capacidades de la tarjeta enviada.
  3. 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ámetroDescripciónFormatoObligatorio
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
Content-TypeDebe enviarse con el valor application / json.= 15 ANSI

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:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"card":{
"number":"5555555555555555"
},
"authorizer_id":"1"
}
--verbose

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"payment": {
"status": "NOV"
},
"card": {
"acquirer_name": "Redecard",
"authorizer_id": "1",
"authorizer_response_code": "000",
"is_customer_id_required": "false",
"is_expiry_date_required": "true",
"is_installment_funding_enabled": "true",
"is_security_code_required": "true",
"is_spot_sale_enabled": "true",
"is_with_interest_sale_enabled": "true",
"is_without_interest_sale_enabled": "true",
"max_installments_with_interest": "12",
"min_installments_with_interest": "01",
"prefixes": {
"TRAT": "2",
"PERIFERICO": "1",
"CSEG": "2"
}
}
}

Consulta de tarjeta sin envío de autorización#

Solicitud:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"card":{
"number":"6543210987654321"
}
}
--verbose

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"payment": {
"status": "NOV"
},
"card": {
"acquirer_name": "Redecard",
"authorizer_id": "1",
"authorizer_response_code": "000",
"is_customer_id_required": "false",
"is_expiry_date_required": "true",
"is_installment_funding_enabled": "true",
"is_security_code_required": "true",
"is_spot_sale_enabled": "true",
"is_with_interest_sale_enabled": "true",
"is_without_interest_sale_enabled": "true",
"max_installments_with_interest": "12",
"min_installments_with_interest": "01",
"prefixes": {
"TRAT": "2",
"PERIFERICO": "1",
"CSEG": "2"
}
}
}

Consulta sobre la tarjeta Visa Checkout#

Solicitud:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"card":{
"wallet_transaction_id":"4444444444444444444"
},
"authorizer_id":"406"
}
--verbose

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"payment": {
"status": "NOV"
},
"card": {
"acquirer_name": "Redecard",
"authorizer_id": "406",
"authorizer_response_code": "000",
"is_customer_id_required": "false",
"is_expiry_date_required": "true",
"is_installment_funding_enabled": "true",
"is_security_code_required": "true",
"is_spot_sale_enabled": "true",
"is_with_interest_sale_enabled": "true",
"is_without_interest_sale_enabled": "true",
"max_installments_with_interest": "12",
"min_installments_with_interest": "01",
"prefixes": {
"TRAT": "2",
"PERIFERICO": "1"
},
"visa_checkout_data": {
"payment_request": {
"currency_code": "BRL",
"subtotal": "115.5",
"total": "115.5",
"order_id": "09387",
"source_id": "LOJAVISACHECK"
},
"user_data": {
"user_first_name": "Comprador",
"user_last_name": "Esitef",
"user_full_name": "Comprador Esitef",
"user_name": "esitef2@gmail.com",
"user_email": "esitef2@gmail.com",
"enc_user_id": "c5DmPXTXC3VwZywsFESEGAqiLM5PXSZG7hgyQgRv0j8=",
"user_personal_id": "12345678909"
},
"creation_time_stamp": 1502206049403,
"payment_instrument": {
"id": "AWUU0/rQrmKCMx+C740kBefZP2GNsdAMYUTXAzCPk+M=",
"last_four_digits": "1010",
"bin_six_digits": "406897",
"verification_status": "VERIFIED",
"expired": "false",
"issuer_bid": "10029901",
"nick_name": "Cartão PAN",
"name_on_card": "aaaaaaaaaa vvvvvvvvvv",
"card_first_name": "aaaaaaaaaa",
"card_last_name": "vvvvvvvvvv",
"payment_type": {
"card_brand": "VISA",
"card_type": "CREDIT"
},
"billing_address": {
"person_name": "aaaaaaaaaa vvvvvvvvvv",
"first_name": "aaaaaaaaaa",
"last_name": "vvvvvvvvvv",
"line1": "qqqqqqqqqq",
"line2": "eeeeee",
"line3": "wwwwwwwww",
"city": "cccccccc",
"state_province_code": "SP",
"postal_code": "01238010",
"country_code": "BR",
"phone": "987654321",
"default": "false"
},
"card_arts": {
"card_art": [
{
"base_image_file_name": "https://sandbox.secure.checkout.visa.com/VmeCardArts/lg_visa_card.png",
"height": 105,
"width": 164
}
]
},
"expiration_date": {
"month": "11",
"year": "2022"
}
},
"risk_data": {
"advice": "UNAVAILABLE",
"score": 0,
"avs_response_code": "0",
"cvv_response_code": "0",
"age_of_account": "704"
},
"visa_checkout_guest": "false"
}
}
}

Consulta de tarjetas con planes de financiación#

Solicitud:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"card":{
"number":"6543210987654321"
},
"authorizer_id":"313"
}
--verbose

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"payment": {
"status": "NOV"
},
"card": {
"acquirer_name": "Via Certa Financiadora",
"authorizer_id": "313",
"authorizer_response_code": "000",
"is_customer_id_required": "false",
"is_expiry_date_required": "true",
"is_installment_funding_enabled": "true",
"is_security_code_required": "true",
"is_spot_sale_enabled": "true",
"is_with_interest_sale_enabled": "true",
"is_without_interest_sale_enabled": "true",
"max_installments_with_interest": "99",
"min_installments_with_interest": "00",
"prefixes": {
"CADSENHA": "11",
"NPSAQ": "0199",
"ECHO": "MIG3DH00000"
},
"financing_plan_list": [
{
"cod_plano": "0201",
"tipo_plano": "02",
"desc_plano": "Plano de Teste para CDC 01 ",
"parc_plano": "99"
},
{
"cod_plano": "0301",
"tipo_plano": "03",
"desc_plano": "Plano de Teste para Saque e CDC 01 ",
"parc_plano": "99"
},
{
"cod_plano": "0201",
"tipo_plano": "02",
"desc_plano": "Plano de Teste para CDC 01 ",
"parc_plano": "99"
},
{
"cod_plano": "0202",
"tipo_plano": "02",
"desc_plano": "Plano de Teste para CDC 02 ",
"parc_plano": "99"
},
{
"cod_plano": "0301",
"tipo_plano": "03",
"desc_plano": "Plano de Teste para Saque e CDC 01 ",
"parc_plano": "99"
},
{
"cod_plano": "0302",
"tipo_plano": "03",
"desc_plano": "Plano de Teste para Saque e CDC 02 ",
"parc_plano": "99"
},
{
"cod_plano": "0303",
"tipo_plano": "03",
"desc_plano": "Plano de Teste para Saque e CDC 03 ",
"parc_plano": "99"
}
]
}
}

Búsqueda de tarjetas con datos adicionales para el enrutamiento de iCards a través de SiTef#

Solicitud:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"card":{
"number":"6543210987654321"
},
"authorizer_id":"38"
}
--verbose

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"card": {
"acquirer_name": "iCards",
"authorizer_id": "38",
"authorizer_response_code": "000",
"is_customer_id_required": "true",
"is_expiry_date_required": "true",
"is_installment_funding_enabled": "true",
"is_security_code_required": "true",
"is_spot_sale_enabled": "true",
"is_with_interest_sale_enabled": "true",
"is_without_interest_sale_enabled": "true",
"max_installments_with_interest": "12",
"min_installments_with_interest": "01",
"prefixes": {
"NPSAQ": "0299",
"CAPTPPRE": "1",
"XCAPPREAUT": "11"
},
"is_customer_postal_code_required": "true",
"is_card_holder_required": "true"
},
"payment": {
"status": "NOV"
}
}

Consulta de tarjetas con datos adicionales para el enrutamiento de IPG#

Solicitud:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"card":{
"number":"4036952187654321"
},
"routing_id":"414"
}
--verbose

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"payment": {
"status": "NOV"
},
"details": [
{
"brand": "VISA",
"brand_product_id": "VI",
"card_function": "CREDIT",
"issuer_country": "USA",
"issuer_name": "Simulation"
},
{
"brand": "VISA",
"brand_product_id": "VI",
"card_function": "DEBIT",
"issuer_country": "BRA",
"issuer_name": "Simulation"
}
]
}

Códigos de respuesta

Ver referencia en Códigos API - Códigos de 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ámetroDescripciónFormatoObligatorio
authorizer_idCódigo de autorizador en el Portal Carat. [Más información.] (Authorizadoras.md) Este campo solo es obligatorio si se envía el campo wallet_transaction_id.
Si este campo no se envía, Portal Carat asume que es una tarjeta de crédito		 < 3 NCOND.
routing_idCódigo de ruta en el Portal Carat. Este campo solo es necesario para obtener datos adicionales de IPG. < 3 NCOND.
card
numberNúmero de tarjeta del comprador (PAN). < 19 NSI
tokenHASH de una tarjeta almacenada en Portal Carat. No está permitido enviar un número de tarjeta abierta (campo number) y una tarjeta almacenada (campo token) en la misma solicitud.= 88 ANNO
wallet_transaction_idID 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 ANNO
do_par_inquiryInforma 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 default: false		< 5 ANO

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ámetroDescripciónFormato
codeCódigo de respuesta de Portal Carat. Cualquier código que no sea "0" significa error. [Más información.] (Api-codes.md # response-codes) < 4 N
messageMensaje de respuesta de pago oline. < 500 AN
payment
statusEstado de la transacción de pago en Portal Carat. [Más información.] (codigos-da-api.md#status-de-transacões-do-e-sitef)= 3 AN
card
authorizer_codeCódigo de respuesta del autorizador. < 10 AN
authorizer_messageMensaje de respuesta del autorizador. < 500 AN
acquirer_nameNombre de enrutamiento. Por ejemplo: Cielo < 256 AN
authorizer_idCódigo de autorizador (utilice este ID al realizar el pago). < 3 N
is_customer_id_requiredIndica la recogida obligatoria del documento del cliente. < 5 T / F
is_expiry_date_requiredIndica la obligación de cobrar la fecha de caducidad de la tarjeta del comprador. < 5 T / F
is_installment_funding_enabledIndica si el pago a plazos está habilitado. < 5 T / F
is_security_code_requiredIndica la recopilación de códigos de seguridad obligatorios. < 5 T / F
is_spot_sale_enabledIndica si el pago en efectivo está habilitado. < 5 T / F
is_with_interest_sale_enabledIndica si el pago de intereses está habilitado. < 5 T / F
is_without_interest_sale_enabledIndica se o pagamento sem juros está habilitado.< 5 T/F
max_installments_with_interestCuotas máximas con intereses. < 2 N
min_installments_with_interestCuota mínima con intereses. < 2 N
visa_checkout_dataObjeto con datos devueltos por Visa Checkout.El
financing_plan_listObjeto 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_requiredIndica la recopilación obligatoria del código postal del usuario (código postal en Brasil). < 5 T / F
parValor PAR devuelto por VISA si se envía el campo do_par_inquiry con el valor true en la [solicitud] (# par% c3% a2metros-de-requisi% c3% a7% c3% a3o). < 32 AN
card.prefixes [] Este campo contiene los prefijos (datos adicionales) devueltos por SiTef.
claveNombre de prefijo. < 1024 AN
valorValor de prefijo. < 1024 AN
details[]Este campo contiene detalles devueltos por el enrutamiento IPG
brandLa marca de la tarjeta. La marca de la tarjeta. < 1024 AN
brand_product_idID de producto de de la de la tarjeta. El ID de producto de la marca. < 1024 AN
card_functionFunción de tarjeta. Función de tarjeta.CRÉDITO,
DÉBITO,
PREPAGO,
VALE,
INDEFINIDO
commercialCardIndica si la tarjeta es corporativa o no corporativa. Indica si es una tarjeta corporativa o no corporativa.CORPORATIVO,
NO_CORPORATIVO
issuer_countryEl país del emisor de la tarjeta. El país del emisor. < 1024 AN
issuer_nameEl nombre del emisor de la tarjeta. El nombre del emisor. < 1024 AN

Enrutamientos que permiten la búsqueda de tarjetas.#

CódEnrutamientoTiene consulta de tarjeta
1004VisaNet via SiTef (rede:4)
1005Redecard via SiTef (rede:5)
1018Standby (Excard) via SiTef (rede:18)
1019Edmcard via SiTef (rede:19)
1021Vero via SiTef (rede:21)
1026CCCWeb (Master/Visa/Amex) via SiTef (rede:26)
1029Softway via SiTef (rede:29)
1030Multicheque via SiTef (rede:30)
70Ticket via SiTef (rede:41)
430Senff via SiTef (rede:43)
1045Coopercred via SiTef (rede:45)
1047Sorocred via SiTef (rede:47)
1051Hipercard via SiTef (rede:51)
1052Tricard via SiTef (rede:52)
1054Policard via SiTef (rede:54)
1057CCC (Master/Visa) via SiTef (rede:57)
1059Telenet via SiTef (rede:59)
1061Brasilcard via SiTef (rede:61)
1064CCC (Amex) via SiTef (rede:64)
1068Banese via SiTef (rede:68)
1072Bigcard via SiTef (rede:72)
1077Valecard via SiTef (rede:77)
1081Supercard via SiTef (rede:81)
1182GetNet via SiTef (rede:82)
1086Marisa via SiTef (rede:86)
1087Maxicred via SiTef (rede:87)
1089Expansiva via SiTef (rede:89)
1091Leader II via SiTef (rede:91)
1093Cetelem via SiTef (rede:93)
1094Cabal via SiTef (rede:94)
1095Credsystem via SiTef (rede:95)
1096BBVA via SiTef (rede:96)
1102Check Check (Smart Shop) via SiTef (rede:102)
1103Dacasa via SiTef (rede:103)
1104Bradesco Private Label via SiTef (rede:104)
1105Platinum (Credimais) via SiTef (rede:105)
1111Tredenexx via SiTef (rede:111)
1113Credishop via SiTef (rede:113)
1115IBI via SiTef (rede:115)
1118Oboe via SiTef (rede:118)
1121Hot Card via SiTef (rede:121)
1122PAN via SiTef (rede:122)
1125Cielo via SiTef (rede:125)
1127Marisa Cartao Presente via SiTef (rede:127)
1128Cooplife via SiTef (rede:128)
1129BOD via SiTef (rede:129)
1144Accredito (ACSP) via SiTef (rede:144)
1149Fidelidade Mais via SiTef (rede:149)
160Orbitall via SiTef (rede:160)
1161iCards via SiTef (rede:161)
1165Banco Ge (Tivit) via SiTef (rede:165)
1169Banescard via SiTef (rede:169)
1181GetNet Lac via SiTef (rede:181)
1187Sicredi - nao usar, usar o bin via SiTef (rede:187)
1192AVISTA via SiTef (rede:192)
1193Algorix via SiTef (rede:193)
1194Amex EMV via SiTef (rede:194)
1006Amex EMV via SiTef (rede:194)
1201SmartNet via SiTef (rede:201)
1203Peela via SiTef (rede:203)
1206GlobalPayments via SiTef (rede:206)
1207Elavon via SiTef (rede:207)
218Hug via SiTef (rede:218)
225Fidelity via SiTef (rede:225)
1229Bin via SiTef (rede:229)
1236Conductor via SiTef (rede:236)
1249Riachuelo PL via SiTef (rede:249)
1257Bradescard via SiTef (rede:257)
1265Stone via SiTef (rede:265)
1266DM Card via SiTef (rede:266)
1271CardSE via SiTef (rede:271)
1279Sodexo via SiTef (rede:279)
1280Kredilig via SiTef (rede:280)
1283ConductorDUP via SiTef (rede:283)
1296Safra via SiTef (rede:296)
1297Rede Ticket via SiTef (rede:297)
1303SiPag via SiTef (rede:303)
1309ADIQ via SiTef (rede:309)
1313Via Certa Financiadora via SiTef (rede:313)