Bradescard

import ResponseCodes from './codigos-de-resposta.md'; import BradescardVoucher from './roteamento-bradescard-voucher.md';

A loja tem a possibilidade de configurar o roteamento de transações feitas no Carat por vários meios de pagamento, um desses meios é o Bradescard.

Interfaces Carat suportadas para integração

Utilizaremos as seguintes interfaces para a integração com o roteamento Bradescard:

  • Pagamento REST
  • Pagamento HTML
  • Cancelamento REST
  • Cancelamento via Portal do Lojista
  • Operação genérica para realizar consultas Bradescard

Serviço de Consultas Bradescard

Nas consultas Bradescard é possível realizar a consulta de extrato resumido e a consulta de saldos de um determinado cartão.

Detalhes da chamada

O serviço de consulta Bradescard é um serviço disponibilizado pela interface de operação genérica (Saiba mais). No caso da operação de consulta Bradescard, é obrigatório o token de autenticidade para cada consulta realizada, logo é necessário obter o token (Saiba mais) e depois realizar a chamada de operação genérica (Saiba mais).

A consulta Bradescard é identificada com o código de operação 172 (utilize este valor no campo operation na requisição).

Parâmetros das consultas Bradescard

Abaixo, seguem os parâmetros que são utilizados pela operação de consultas Bradescard.

ParâmetroDescriçãoFormatoObrigatório
dateData fiscal.NNão
timeHora fiscal.NNão
subfunctionSubfunção da transação de consulta. Estão previstas as seguintes consultas:<br/>01 – Consulta de saldos<br/>02 – Consulta de extrato resumido2 NNão
card_entry_modeModo de entrada. Os valores possíveis para este campo são:<br/>1 – Cartão magnético<br/>2 – Número do cartão digitado1 NSim
card_numberEste campo deve ser preenchido com o número do cartão.NCONDICIONAL<br/>Sim, se card_entry_mode for igual a "2"
track1Este campo deve ser preenchido com a trilha 1 do cartão.< 99 ANCONDICIONAL<br/>Sim, se card_entry_mode for igual a "1"
track2Este campo deve ser preenchido com a trilha 2 do cartão.< 99 NCONDICIONAL<br/>Sim, se card_entry_mode for igual a "1"
card_expiry_dateData de vencimento do cartão.4 N (MMAA)CONDICIONAL<br/> Sim, se card_entry_mode for igual a "2"
card_security_codeCódigo de segurança.< 10 NCONDICIONAL<br/> Sim, se for solicitado na consulta de cartão (Saiba mais).
card_issue_dateData da emissão do cartão.6 N (MMAAAA)CONDICIONAL<br/>Sim, se for solicitado na consulta de cartão (Saiba mais).

Parâmetros de resposta

Em 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 consultas Bradescard:

ParâmetroDescrição
response_codeCódigo de resposta do Carat.
response_messageMensagem de resposta do Carat.
authorizer_response_codeCódigo de resposta da autorizadora.
authorizer_response_messageMensagem de resposta da autorizadora.
parameters.dateData.
parameters.timeHora.
parameters.acquirer_idId da rede adquirente no SiTef.
parameters.host_usnNSU host.
parameters.sitef_usnNSU SiTef.
parameters.institution_response_codeCódigo de resposta da autorizadora/adquirente.
parameters.institution_nameNome da instituição.
parameters.authorization_numberNúmero da autorização.
parameters.affiliation_codeCódigo do estabelecimento na autorizadora/adquirente.
parameters.confirmation_dataDados da confirmação.
parameters.customer_receiptComprovante do comprador.
parameters.merchant_receiptComprovante da loja.
parameters.sale_response_dataDados de resposta da venda.

<ResponseCodes />

Parâmetros adicionais

Os campos abaixo devem ser inseridos na estrutura additional_data na chamada de criação de transação. (Saiba mais)

ParâmetroDescriçãoFormatoObrigatório
additional_dataElemento para envio de dados adicionais.
skip_cycles_daysou "Carencia". Indica o adiamento do pagamento em dias nas compras a crédito parceladas.< 2 NNÃO
skip_cycles_periodsou "Carencia". Indica o adiamento do pagamento em perídos ou ciclos nas compras a crédito parceladas.< 2 NNÃO
free_installments_indicatorIndica que a existência de parcela grátis.1 NNÃO
card_holder_biometric_authenticationInformações referente a autenticação biométrica.< 6 ANNÃO

Detalhes dos parâmetros

ParâmetroExplicação
skip_cycles_daysNúmero de dias no formato 99. Exemplo: 30<br/>Ausência indica não utilização desta funcionalidade.
skip_cycles_periodsQuantidade de períodos ou ciclos no formato 99. Exemplo 01<br/>Ausência indica não utilização desta funcionalidade.
free_installments_indicator0-Indica sem parcela grátis.<br/>1-Indica com parcela grátis.<br/>   Ausência é assumida com o valor 0
card_holder_biometric_authenticationX;Y onde<br/>   X - Código do tipo de autenticação, com os valores:<br/>      1-Cliente desde MM/AA (Formato de Y é AAMM)<br/>      2-Biometria (sem envio de valores em Y)<br/>      3-Conta armazenada (sem envio de valores em Y)<br/>   Y-Informação referente ao tipo de autenticação do portador do cartão.<br/><br/>Exemplos:<br/>   1;2304<br/>   2

Exemplo

Abaixo está um exemplo de chamada do serviço de criação de transações utilizando a ferramenta cURL.

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor<br/> <URLPOSTMAN/>

curl
--request POST "https://{{url}}/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header “merchant_key: xxxxxxxxxxx”
--data-binary
{
   "merchant_usn":"12042142155",
   "order_id":"12042142155",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
    "additional_data": {
         "skip_cycles_days": "45",
         "free_installments_indicator": "1"
    }
}
--verbose

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "status": "NOV",
    "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
    "order_id": "12042142155",
    "merchant_usn": "12042142155",
    "amount": "1000"
  }
}

Bradescard Voucher

<BradescardVoucher />