Getnet
A loja tem a possibilidade de configurar o roteamento de transações feitas com cartão de crédito no Carat por vários meios de pagamento, um desses meios é a Getnet.
Nesta página será usada a nomenclatura "GetnetWS" para referenciar o roteamento no Carat.
Assim, a loja pode configurar o Carat para que as transações feitas com cartões VISA, por exemplo, sejam roteadas pela GetnetWS enquanto que as feitas com MASTERCARD sejam roteadas pela CIELO.
Interfaces Carat suportadas para integração#
É possível utilizar as seguintes interfaces para a integração com o roteamento GetnetWS:
- Pagamento REST
- Pré-Autorização REST
- Cancelamento REST
- Pagamento HTML
- Pré-Autorização HTML
Autorizadoras permitidas#
As seguintes autorizadoras são suportadas pelo roteamento GetnetWS:
- VISA
- MASTERCARD
- ELO
- AMERICAN EXPRESS
- HIPERCARD
Credenciais necessárias#
A loja deve obter com a GetnetWS as credenciais listadas abaixo, e repassá-las à Software Express ou fazer o cadastro como explicado mais a frente neste mesmo documento.
| Campo | Descrição | Formato |
|---|---|---|
username | Usuário de acesso. | < 20 N |
password | Senha de acesso. | < 40 AN |
merchantID | Código de EC cadastrado na GetnetWS. | < 10 AN |
terminal | Identificação do Terminal. | < 7 AN |
subMerchantId | ID do Sub comércio. | < 15 AN |
Importante para Pagamento HTML: No caso de uma autorizadora da loja não ter cadastrado essas credenciais, essa autorizadora não será exibida na tela de seleção de cartão de crédito durante a operação de pagamento.
Cadastro das informações pelo portal do lojista#
O próprio lojista pode cadastrar as informações obtidas com a GetnetWS no Portal do Lojista do Carat. Nesse ambiente será possível alterar as configurações e a senha de autenticação das transações. Para essa finalidade, o lojista deve selecionar a autorizadora e entrar na tela de edição como no exemplo exibido abaixo:
No Portal do Lojista, no ambiente de edição da Autorizadora, é possível alterar a senha cadastrada no ambiente Carat. Nesse caso, a alteração ocorrerá somente para esta autorizadora. Note que se as lojas utilizam a mesma conta na Getnet, será necessário que os lojistas alterem manualmente as senhas pra todas as outras autorizadoras.
Ainda nesse ambiente, pode-se também alterar a senha de cadastro na Getnet. É importante lembrar que ao alterar essa senha no ambiente da Getnet todas as lojas associadas à essa conta na Getnet terão que alterar também a senha cadastrada no ambiente Carat indo na tela de edição de suas autorizadoras, caso contrário terão suas transações negadas pela Getnet.
A tela de exemplo de alteração de senha na Getnet segue abaixo:
A nova senha deve seguir as regras definidas pela Getnet. Essas regras encontram-se no documento de integração.
Subadquirência#
Informações referentes a subadquirência são cadastradas pela nossa equipe de suporte. Os seguintes dados são necessários:
| Parâmetro | Formato |
|---|---|
| ID do subcomércio | < 15 AN |
| Cidade do subcomércio | < 13 A |
| Estado do subcomércio | = 2 A |
| CEP do subcomércio | = 8 N |
| CNPJ ou CPF do subcomércio | < 15 AN |
| Logradouro do subcomércio | < 40 AN |
| MCC | = 4 N |
| Soft-Descriptor | < 22 AN Saiba mais sobre esse recurso. |
Também é possível enviar os campos abaixo nas requisições feitas ao Carat:
| Parâmetro | Campo | Observações |
|---|---|---|
| ID do subcomércio | subacquirer_merchant_id | Enviado no serviço de efetivação da transação. |
| MCC | mcc | Enviado no serviço de efetivação da transação. |
| Soft-Descriptor | soft_descriptor | Enviado no serviço de criação da transação. |
Caso os campos acima estejam cadastrados na loja do Carat e sejam enviados na requisição, o valor que consta na requisição tem prioridade.
Recorrências#
Para que as recorrências sejam reconhecidas pela GetnetWS, existem algumas regras que explicaremos a seguir.
Os campos usados para a recorrência são apresentados na tabela abaixo.
| Campo | Descrição | Formato |
|---|---|---|
acquirer.recurrency | Enviado na requisição. Flag que define se o pagamento é ou não recorrente. | < 5 T/F |
acquirer.recurrency_tid | Enviado na requisição. ID da transação da primeira transação da recorrência. Identificador que diferencia a primeira recorrência das subsequentes. | = 18 N |
acquirer.recurrency_seq_id | Enviado na requisição. Número da parcela da recorrência. | < 3 N |
payment.tid | Recebido na resposta. ID da transação no adquirente. | = 18 N |
Caso o lojista opte por fazer as recorrências por conta própria, deverá seguir os passos:
- Passo 1: Primeira recorrência:
- Enviar
acquirer.recurrencycom valor true; - Armazenar o
payment.tidpara usar nas recorrências seguintes.
- Enviar
- Passo N: Recorrências seguintes:
- Enviar
acquirer.recurrencycom valor true; - Enviar
acquirer.recurrency_tidcom o valor retornado nopayment.tiddo Passo 1; - Enviar
acquirer.recurrency_seq_idcom o número da parcela correspondente a recorrência feita (de 1 até 999 no máximo).
- Enviar
Caso o lojista opte por fazer as recorrências por meio do serviço de agendamento do Carat, os parâmetros de recorrência serão enviados automaticamente e o acompanhamento poderá ser feito pelo relatório de agendamentos normalmente.
Caso o lojista opte por fazer as recorrências por meio do serviço de pagamento com agendamento do Carat, os parâmetros de recorrência serão enviados automaticamente e o acompanhamento poderá ser feito pelo relatório de agendamentos normalmente. Porém, uma peculiaridade é que o ID usado para identificar a primeira transação da recorrência é o ID do pagamento inicial e não o ID do primeiro agendamento.
Fluxos#
Nesta seção serão apresentadas as particularidades do fluxo transacional GetnetWS.
Pagamento HTML#
É possível realizar um pagamento com autenticação 3DS. Para isso, basta enviar o parâmetro authorizer_authentication com valor true na etapa de criação da transação.
Campos relevantes na chamada descrita no Serviço de criação de transação HTML e no Serviço de criação de transação REST:
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
authorizer_authentication | Define se o lojista deseja um pagamento com autenticação na autorizadora. Enviar true caso positivo. | < 5 AN | SIM para crédito com autenticação |
| iata | Este elemento contém campos específicos de transações IATA | ||
first_installment | Valor de entrada em centavos | < 12 N | Condicional (uso obrigatório apenas para transações IATA - venda de passagens aéreas) |
departure_tax | Taxa de embarque em centavos. | < 12 N | Condicional (uso obrigatório apenas para transações IATA - venda de passagens aéreas) |
Pré-Autorização#
Não é possível realizar uma pré-autorização com parcelamento via emissor.
Campos relevantes na chamada descrita no Serviço de criação de transação HTML e no Serviço de criação de transação REST:
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
| iata | Este elemento contém campos específicos de transações IATA | ||
first_installment | Valor de entrada em centavos | < 12 N | Condicional (uso obrigatório apenas para transações IATA - venda de passagens aéreas) |
departure_tax | Taxa de embarque em centavos. | < 12 N | Condicional (uso obrigatório apenas para transações IATA - venda de passagens aéreas) |
Alteração de Pré-Autorização#
É possível re-enviar a requisição de efetivação de pré-autorização acrescida do campo amount para alterar seu valor.
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
amount | Novo valor da pré-autorização em centavos. | < 12 N | SIM |
Pagamento e Pré-Autorização REST#
- O campo
card.holderé obrigatório. - A GetnetWS aceita o envio dos dados de autenticação
eci,xidecavv.
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
card.holder | Nome do portador impresso no cartão | < 26 AN | SIM |
external_authentication.eci | Código ECI da transação Autenticada 3D Secure. | = 2 N | NÃO |
external_authentication.xid | Identificador do MPI para cada transação autenticada. | < 40 AN | NÃO |
external_authentication.cavv | Código de autenticação criptografado pela Bandeira. | < 40 AN | NÃO |
Cancelamento#
O Cancelamento de uma transação pode ser feito no Portal do Lojista. Só poderão ser canceladas as transações efetuadas no dia corrente do cancelamento. O lojista pode cancelar transações de pré-autorização com ou sem captura e transações de pagamento. No caso de cancelar uma transação de pré-autorização com captura, a Getnet efetua o cancelamento da captura, porém, o Carat exibirá essa transação de pré com status cancelada (e captura confirmada).