Bradescard

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âmetro	Descrição	Formato	Obrigatório
`date`	Data fiscal.	N	Não
`time`	Hora fiscal.	N	Não
`subfunction`	Subfunção da transação de consulta. Estão previstas as seguintes consultas: 01 – Consulta de saldos 02 – Consulta de extrato resumido	2 N	Não
`card_entry_mode`	Modo de entrada. Os valores possíveis para este campo são: 1 – Cartão magnético 2 – Número do cartão digitado	1 N	Sim
`card_number`	Este campo deve ser preenchido com o número do cartão.	N	CONDICIONAL Sim, se `card_entry_mode` for igual a "2"
`track1`	Este campo deve ser preenchido com a trilha 1 do cartão.	< 99 AN	CONDICIONAL Sim, se `card_entry_mode` for igual a "1"
`track2`	Este campo deve ser preenchido com a trilha 2 do cartão.	< 99 N	CONDICIONAL Sim, se `card_entry_mode` for igual a "1"
`card_expiry_date`	Data de vencimento do cartão.	4 N (MMAA)	CONDICIONAL Sim, se `card_entry_mode` for igual a "2"
`card_security_code`	Código de segurança.	< 10 N	CONDICIONAL Sim, se for solicitado na consulta de cartão (Saiba mais).
`card_issue_date`	Data da emissão do cartão.	6 N (MMAAAA)	CONDICIONAL 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âmetro	Descrição
`response_code`	Código de resposta do Carat.
`response_message`	Mensagem de resposta do Carat.
`authorizer_response_code`	Código de resposta da autorizadora.
`authorizer_response_message`	Mensagem de resposta da autorizadora.
`parameters.date`	Data.
`parameters.time`	Hora.
`parameters.acquirer_id`	Id da rede adquirente no SiTef.
`parameters.host_usn`	NSU host.
`parameters.sitef_usn`	NSU SiTef.
`parameters.institution_response_code`	Código de resposta da autorizadora/adquirente.
`parameters.institution_name`	Nome da instituição.
`parameters.authorization_number`	Número da autorização.
`parameters.affiliation_code`	Código do estabelecimento na autorizadora/adquirente.
`parameters.confirmation_data`	Dados da confirmação.
`parameters.customer_receipt`	Comprovante do comprador.
`parameters.merchant_receipt`	Comprovante da loja.
`parameters.sale_response_data`	Dados de resposta da venda.

Códigos de resposta

Veja a referencia no Códigos da API - códigos de resposta

Parâmetros adicionais#

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

Parâmetro	Descrição	Formato	Obrigatório
additional_data	Elemento para envio de dados adicionais.
`skip_cycles_days`	ou "Carencia". Indica o adiamento do pagamento em dias nas compras a crédito parceladas.	< 2 N	NÃO
`skip_cycles_periods`	ou "Carencia". Indica o adiamento do pagamento em perídos ou ciclos nas compras a crédito parceladas.	< 2 N	NÃO
`free_installments_indicator`	Indica que a existência de parcela grátis.	1 N	NÃO
`card_holder_biometric_authentication`	Informações referente a autenticação biométrica.	< 6 AN	NÃO

Detalhes dos parâmetros#

Parâmetro	Explicação
`skip_cycles_days`	Número de dias no formato 99. Exemplo: 30 Ausência indica não utilização desta funcionalidade.
`skip_cycles_periods`	Quantidade de períodos ou ciclos no formato 99. Exemplo 01 Ausência indica não utilização desta funcionalidade.
`free_installments_indicator`	0-Indica sem parcela grátis. 1-Indica com parcela grátis. Ausência é assumida com o valor 0
`card_holder_biometric_authentication`	X;Y onde X - Código do tipo de autenticação, com os valores: 1-Cliente desde MM/AA (Formato de Y é AAMM) 2-Biometria (sem envio de valores em Y) 3-Conta armazenada (sem envio de valores em Y) Y-Informação referente ao tipo de autenticação do portador do cartão. Exemplos: `1;2304` `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
esitef-homologacao.softwareexpress.com.br

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#

O Bradescard Voucher permite à um cliente que ainda não tem um cartão Bradescard realizar uma compra com este cartão numa loja física parceira do Bradescard. Este cenário é exclusivo para o roteamento da Bradescard.

Neste caso, existem dois cenários:

A loja possui uma impressora de cartões Bradescard e gera um cartão na hora.
A loja não possui uma impressora de cartões Bradescard, então gera uma solicitação e recebe um PDF contendo as informações necessárias para efetuar a transação.

Interfaces Carat suportadas para integração#

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

Pagamento REST
Cancelamento REST
Cancelamento via Portal do Lojista

Pagamento REST#

O pagamento via Bradescard Voucher segue o fluxo transacional de pagamentos REST, sendo diferenciado pelo envio obrigatório dos campos abaixo durante a operação de pagamento:

card.number - número do cartão fictício;
acquirer.authorization_number - código de autorização do voucher.

Demais campos relacionados aos dados do cartões (cvv, data de expiração etc.) não são utilizados.

Cancelamento#

O cancelamento de transações via Bradescard Voucher segue o fluxo já existente, sem necessidade de envio de campos novos.

Para cancelamento via Portal do Lojista, é necessário preencher o número de cartão utilizado na transação.

Para mais detalhes, consulte as documentações abaixo:

Consultas de Saldo e Extrato#

O Bradescard Voucher não permite consultas de saldo e de extrato.

Home

Interfaces Carat suportadas para integração#

Serviço de Consultas Bradescard#

Detalhes da chamada#

Parâmetros das consultas Bradescard#

Parâmetros de resposta#

Parâmetros adicionais#

Detalhes dos parâmetros#

Exemplo#

Bradescard Voucher#

Interfaces Carat suportadas para integração#

Pagamento REST#

Cancelamento#

Consultas de Saldo e Extrato#