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â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:<br/>01 – Consulta de saldos<br/>02 – Consulta de extrato resumido | 2 N | Não |
card_entry_mode | Modo de entrada. Os valores possíveis para este campo são:<br/>1 – Cartão magnético<br/>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<br/>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<br/>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<br/>Sim, se card_entry_mode for igual a "1" |
card_expiry_date | Data de vencimento do cartão. | 4 N (MMAA) | CONDICIONAL<br/> Sim, se card_entry_mode for igual a "2" |
card_security_code | Código de segurança. | < 10 N | CONDICIONAL<br/> 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<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â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. |
<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â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<br/>Ausência indica não utilização desta funcionalidade. |
skip_cycles_periods | Quantidade de períodos ou ciclos no formato 99. Exemplo 01<br/>Ausência indica não utilização desta funcionalidade. |
free_installments_indicator | 0-Indica sem parcela grátis.<br/>1-Indica com parcela grátis.<br/> Ausência é assumida com o valor 0 |
card_holder_biometric_authentication | X;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 />