Serviço de consulta de cartão
Esta seção explica sob o contexto de pagamento. Veja mais detalhes no fluxo.
A partir de um NIT de pagamento com status NOV (novo), é possível realizar uma consulta do BIN do cartão (seis primeiros dígitos) no SiTef para obter dados sobre suas capacidades (possibilidade de pagamento parcelado, máximo de parcelas, exigência de código de segurança, etc.), ou ainda, saber qual autorizadora da loja é a mais adequada para a realização do pagamento.
No caso de transações com Visa Checkout, este serviço também retornará dados do cartão e do usuário retornados pelo Visa.
#
FluxoDescrição do fluxo:
- O lojista cria uma transação no Carat passando informações como código da loja, número de parcelas e código de pedido e obtém como resposta um NIT (Número Identificador de Transação).
- O lojista envia o NIT obtido na etapa anterior e os dados do cartão a ser consultado. Com isso, o Carat retorna dados sobre as capacidades do cartão enviado.
- A loja virtual prossegue então consumindo o serviço de efetivação do pagamento, passando o NIT e os dados do cartão do comprador. Em caso de sucesso, a transação de pagamento mudará seu status para
CON
(confirmada).
#
Detalhes da chamada- Recurso:
/v1/payments/{nit}/cards
- Método HTTP:
POST
- Formato da requisição:
JSON
- Formato da resposta:
JSON
- Parâmetros de cabeçalho:
Parâmetro | Descrição | Formato | Obrigatório |
---|---|---|---|
merchant_id | Código da loja no Carat. Os códigos de produção e certificação serão diferentes. | < 15 AN | SIM |
merchant_key | Chave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes. | < 80 AN | SIM |
Content-Type | Deve ser enviado com o valor application/json . | = 15 AN | SIM |
Obs.: apesar de se tratar de uma consulta, o método POST foi escolhido por questões de segurança.
#
ExemplosAbaixo estão alguns exemplos de chamada do serviço de consulta de cartão utilizando a ferramenta cURL.
#
Consulta de cartão com envio de autorizadoraRequisição:
Para usar este exemplo, não esquecer de definir a variável {{url}}
com o valor
esitef-homologacao.softwareexpress.com.br
Resposta:
#
Consulta de cartão sem envio de autorizadoraRequisição:
Para usar este exemplo, não esquecer de definir a variável {{url}}
com o valor
esitef-homologacao.softwareexpress.com.br
Resposta:
#
Consulta de cartão Visa CheckoutRequisição:
Para usar este exemplo, não esquecer de definir a variável {{url}}
com o valor
esitef-homologacao.softwareexpress.com.br
Resposta:
#
Consulta de cartão com planos de financiamentoRequisição:
Para usar este exemplo, não esquecer de definir a variável {{url}}
com o valor
esitef-homologacao.softwareexpress.com.br
Resposta:
#
Consulta de cartão com dados adicionais para roteamento iCards via SiTefRequisição:
Para usar este exemplo, não esquecer de definir a variável {{url}}
com o valor
esitef-homologacao.softwareexpress.com.br
Resposta:
#
Consulta de cartão com dados adicionais para roteamento IPGRequisição:
Para usar este exemplo, não esquecer de definir a variável {{url}}
com o valor
esitef-homologacao.softwareexpress.com.br
Resposta:
#
Consulta de cartão com envio do tipo de autorizadoraRequisição:
Para usar este exemplo, não esquecer de definir a variável {{url}}
com o valor
esitef-homologacao.softwareexpress.com.br
Resposta:
Códigos de resposta
Veja a referencia no Códigos da API - códigos de resposta
#
Parâmetros de requisiçãoNa tabela abaixo está a descrição dos parâmetros de requisição do serviço de consulta de cartão:
Parâmetro | Descrição | Formato | Obrigatório |
---|---|---|---|
authorizer_id | Código da autorizadora no Carat. Saiba mais. Este campo só é obrigatório caso o campo wallet_transaction_id seja enviado. Se esse campo não é enviado, o Carat assume que se trata de um cartão de crédito | < 3 N | COND. |
authorizer_type | Tipo da autorizadora no Carat.
C . | = 1 A | NÃO |
routing_id | Código do roteamento no Carat. Este campo só é obrigatório para obter dados adicionais pela IPG. | < 3 N | COND. |
card | |||
number | Número do cartão do comprador (PAN). | < 19 N | SIM |
token | HASH de um cartão armazenado no Carat. Não é permitido enviar um número de cartão aberto (campo number ) e um cartão armazenado (campo token ) na mesma requisição. | = 88 AN | NÃO |
wallet_transaction_id | ID de uma transação de carteiras digitais. Por enquanto, essa funcionalidade está disponível apenas para a autorizadora Visa Checkout (authorizer_id :406 ).Não é permitido enviar um número de cartão aberto (campo number ), um cartão armazenado (campo token ) e um wallet_transaction_id na mesma requisição. | < 25 AN | NÃO |
do_par_inquiry | Informa se a chamada para o VISA PAR Inquiry será realizada. O Valor resposta será retornado no campo par do do retorno da chamada. Valores permitidos: true - Requisição de PAR será realizada false - Requisição de PAR não será realizada.Valor default: false | < 5 A | NÃO |
#
Parâmetros de respostaEm caso de sucesso, o código de resposta HTTP será 200
. Qualquer outro código deve ser interpretado como erro. Na tabela abaixo está a descrição dos parâmetros de resposta do serviço de consulta de cartão:
Parâmetro | Descrição | Formato |
---|---|---|
code | Código de resposta do Carat. Qualquer código diferente de 0 significa falha. Saiba mais. | < 4 N |
message | Mensagem de resposta do Carat. | < 500 AN |
payment | ||
status | Status da transação de pagamento no Carat. Saiba mais. | = 3 AN |
card | ||
authorizer_code | Código de resposta do autorizador. | < 10 AN |
authorizer_message | Mensagem de resposta do autorizador. | < 500 AN |
acquirer_name | Nome do roteamento. Ex.: Cielo | < 256 AN |
authorizer_id | Código da autorizadora (utilizar este ID ao realizar o pagamento). | < 3 N |
is_customer_id_required | Indica a obrigatoriedade da coleta do documento do cliente. | < 5 T/F |
is_expiry_date_required | Indica a obrigatoriedade da coleta da data de validade do cartão do comprador. | < 5 T/F |
is_installment_funding_enabled | Indica se o parcelamento está habilitado. | < 5 T/F |
is_security_code_required | Indica a obrigatoriedade da coleta do código de segurança. | < 5 T/F |
is_spot_sale_enabled | Indica se o pagamento à vista está habilitado. | < 5 T/F |
is_with_interest_sale_enabled | Indica se o pagamento com juros está habilitado. | < 5 T/F |
is_without_interest_sale_enabled | Indica se o pagamento sem juros está habilitado. | < 5 T/F |
max_installments_with_interest | Parcelamento máximo com juros. | < 2 N |
min_installments_with_interest | Parcelamento mínimo com juros. | < 2 N |
visa_checkout_data | Objeto com os dados retornados pela Visa Checkout. | O |
financing_plan_list | Objeto que consiste em um array de planos de financiamento apresentados em roteamento Via Certa Financiadora. Um plano de financiamento consiste dos seguintes campos:cod_plano : código de identificação do plano de financiamento, que deve ser enviado no momento da efetivação do pagamento;tipo_plano : código do tipo do plano de financiamento;desc_plano : descrição do plano, que pode ser apresentado ao comprador;parc_plano : número máximo de parcelas possíveis para o plano. | O |
is_customer_postal_code_required | Indica a obrigatoriedade da coleta do código postal do usuário (CEP no Brasil). | < 5 T/F |
par | Valor do PAR retornado pela VISA caso o campo do_par_inquiry seja enviado com o valor true na requisição. | < 32 AN |
card.prefixes[] | Este campo contém os prefixos (dados adicionais) retornados pelo SiTef. | |
key | Nome do prefixo. | < 1024 AN |
value | Valor do prefixo. | < 1024 AN |
details[] | Este campo contém detalhamentos retornados pelo roteamento IPG | |
brand | A bandeira do cartão. The card brand. | < 1024 AN |
brand_product_id | ID de produto da bandeira do cartão. The product ID of the brand. | < 1024 AN |
card_function | Função do cartão. Card function. | CREDIT, DEBIT, PREPAID, VOUCHER, UNDEFINED |
commercialCard | Indica se o cartao é corporativo ou nao-corporativo. Indicates whether it is a corporate or non-corporate card. | CORPORATE, NON_CORPORATE |
issuer_country | O país da emissora do cartão. The country of the issuer. | < 1024 AN |
issuer_name | O nome da emissora do cartão. The name of the issuer. | < 1024 AN |
#
Roteamentos que permitem consulta de cartão.Cód. | Roteamento | Possui consulta de cartão |
---|---|---|
1004 | VisaNet via SiTef (rede:4) | |
1005 | Redecard via SiTef (rede:5) | |
1018 | Standby (Excard) via SiTef (rede:18) | |
1019 | Edmcard via SiTef (rede:19) | |
1021 | Vero via SiTef (rede:21) | |
1026 | CCCWeb (Master/Visa/Amex) via SiTef (rede:26) | |
1029 | Softway via SiTef (rede:29) | |
1030 | Multicheque via SiTef (rede:30) | |
70 | Ticket via SiTef (rede:41) | |
430 | Senff via SiTef (rede:43) | |
1045 | Coopercred via SiTef (rede:45) | |
1047 | Sorocred via SiTef (rede:47) | |
1051 | Hipercard via SiTef (rede:51) | |
1052 | Tricard via SiTef (rede:52) | |
1054 | Policard via SiTef (rede:54) | |
1057 | CCC (Master/Visa) via SiTef (rede:57) | |
1059 | Telenet via SiTef (rede:59) | |
1061 | Brasilcard via SiTef (rede:61) | |
1064 | CCC (Amex) via SiTef (rede:64) | |
1068 | Banese via SiTef (rede:68) | |
1072 | Bigcard via SiTef (rede:72) | |
1077 | Valecard via SiTef (rede:77) | |
1081 | Supercard via SiTef (rede:81) | |
1182 | GetNet via SiTef (rede:82) | |
1086 | Marisa via SiTef (rede:86) | |
1087 | Maxicred via SiTef (rede:87) | |
1089 | Expansiva via SiTef (rede:89) | |
1091 | Leader II via SiTef (rede:91) | |
1093 | Cetelem via SiTef (rede:93) | |
1094 | Cabal via SiTef (rede:94) | |
1095 | Credsystem via SiTef (rede:95) | |
1096 | BBVA via SiTef (rede:96) | |
1102 | Check Check (Smart Shop) via SiTef (rede:102) | |
1103 | Dacasa via SiTef (rede:103) | |
1104 | Bradesco Private Label via SiTef (rede:104) | |
1105 | Platinum (Credimais) via SiTef (rede:105) | |
1111 | Tredenexx via SiTef (rede:111) | |
1113 | Credishop via SiTef (rede:113) | |
1115 | IBI via SiTef (rede:115) | |
1118 | Oboe via SiTef (rede:118) | |
1121 | Hot Card via SiTef (rede:121) | |
1122 | PAN via SiTef (rede:122) | |
1125 | Cielo via SiTef (rede:125) | |
1127 | Marisa Cartao Presente via SiTef (rede:127) | |
1128 | Cooplife via SiTef (rede:128) | |
1129 | BOD via SiTef (rede:129) | |
1144 | Accredito (ACSP) via SiTef (rede:144) | |
1149 | Fidelidade Mais via SiTef (rede:149) | |
160 | Orbitall via SiTef (rede:160) | |
1161 | iCards via SiTef (rede:161) | |
1165 | Banco Ge (Tivit) via SiTef (rede:165) | |
1169 | Banescard via SiTef (rede:169) | |
1181 | GetNet Lac via SiTef (rede:181) | |
1187 | Sicredi - nao usar, usar o bin via SiTef (rede:187) | |
1192 | AVISTA via SiTef (rede:192) | |
1193 | Algorix via SiTef (rede:193) | |
1194 | Amex EMV via SiTef (rede:194) | |
1006 | Amex EMV via SiTef (rede:194) | |
1201 | SmartNet via SiTef (rede:201) | |
1203 | Peela via SiTef (rede:203) | |
1206 | GlobalPayments via SiTef (rede:206) | |
1207 | Elavon via SiTef (rede:207) | |
218 | Hug via SiTef (rede:218) | |
225 | Fidelity via SiTef (rede:225) | |
1229 | Bin via SiTef (rede:229) | |
1236 | Conductor via SiTef (rede:236) | |
1249 | Riachuelo PL via SiTef (rede:249) | |
1257 | Bradescard via SiTef (rede:257) | |
1265 | Stone via SiTef (rede:265) | |
1266 | DM Card via SiTef (rede:266) | |
1271 | CardSE via SiTef (rede:271) | |
1279 | Sodexo via SiTef (rede:279) | |
1280 | Kredilig via SiTef (rede:280) | |
1283 | ConductorDUP via SiTef (rede:283) | |
1296 | Safra via SiTef (rede:296) | |
1297 | Rede Ticket via SiTef (rede:297) | |
1303 | SiPag via SiTef (rede:303) | |
1309 | ADIQ via SiTef (rede:309) | |
1313 | Via Certa Financiadora via SiTef (rede:313) |