SafraPay

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 é o SafraPay.

Nesta página será usada a nomenclatura "SafraPay" 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 SafraPay 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 SafraPay:

  • Pagamento REST
  • Pré-autorização REST
  • Pagamento HTML
  • Pré-autorização HTML
  • Cancelamento REST
  • Cancelamento via Portal

Autorizadoras permitidas#

As seguintes autorizadoras são suportadas pelo roteamento SafraPay:

  • VISA
  • MASTERCARD
  • ELO
  • AMERICAN EXPRESS
  • HIPERCARD

Credenciais necessárias#

A loja deve obter com a SafraPay as credenciais listadas abaixo, e repassá-las à Software Express ou fazer o cadastro como explicado mais a frente neste mesmo documento.

CampoDescriçãoFormato
merchantIDCódigo de EC cadastrado na SafraPay.< 15 AN
terminalIdIdentificação do Terminal.< 8 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 Carat#

O próprio lojista pode cadastrar as informações obtidas com a SafraPay no Portal do Lojista do Carat. Para essa finalidade, o lojista deve selecionar a autorizadora e entrar na tela de edição como no exemplo exibido abaixo:

Portal SafraPay -no-filter

Saiba mais detalhes sobre o Portal do Lojista.

Fluxos#

Nesta seção serão apresentadas as particularidades do fluxo transacional SafraPay.

Pagamento REST/HTML#

Abaixo estão listados os campos que são diferenciados e são relevantes para o SafraPay:

REST Begin / HTML Init#

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âmetroDescriçãoFormatoObrigatório
soft_descriptorTexto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. Saiba mais< 30 ANNÃO
additional_dataElemento para envio de dados adicionais.
postpone_confirmationCampo que permite que loja mantenha a transação como Pendente de Confirmação, e posteriormente, confirmá-la ou desfazê-la.< 5 ANÃO
transaction_initiated_byIndica se a transação foi iniciada pelo Lojista ou pelo Comprador. Relevante quando utilizado em conjunto com, por exemplo, transações recorrentes que são iniciadas pelo Lojista (merchant).

Valores permitidos:
customer – Transação iniciada pelo Comprador.
merchant – Transação iniciada pelo Lojista.
< 8 ANNÃO
total_order_amountMontante final da compra.< 8 ANNÃO
tax_amountMontante da taxa.< 8 ANNÃO
additional_data.payerElemento para envio de dados referentes ao comprador.
idIdentificação do comprador.< 200 ANNÃO
nameNome do comprador.
Obs.: a concatenação de nome com o sobrenome não pode ultrapassar 255 caracteres.
< 200 ANNÃO
surnameSobrenome do comprador.
Obs.: a concatenação do nome com o sobrenome não pode ultrapassar 255 caracteres.
< 200 ANNÃO
identification_numberNúmero de identificação do comprador.< 200 ANNÃO
identification_typeTipo da identificação informada pelo comprador (RG, CPF, etc.).< 200 ANNÃO
emailE-mail do comprador.< 255 ANNÃO
additional_data.
payer.phones[]
Apenas 1 telefone será repassado para o Safrapay.
ddiDDI do telefone.< 255 ANNÃO
dddDDD do telefone.< 15 ANNÃO
numberNúmero do telefone.< 50 ANNÃO
additional_data.
shipment.receiver_address
Elemento para envio de dados referentes ao endereço de entrega.
street_nameEndereço de entrega.< 255 ANNÃO
street_numberNúmero do endereço de entrega.< 15 ANNÃO
complementComplemento do endereço de entrega.< 50 ANNÃO
countyBairro do endereço de entrega.< 150 ANNÃO
zip_codeCEP do endereço de entrega. Ex.: 21241-140.< 9 ANNÃO
cityCidade do endereço de entrega.< 50 ANNÃO
stateEstado do endereço de entrega.= 2 ANNÃO
countryPaís do endereço de entrega seguindo a AN 3166-1. Ex.: BRA= 3 ANNÃO
additional_data.
billing_data.address
Elemento para envio de dados referentes ao endereço de cobrança.
street_nameEndereço de cora.< 255 ANNÃO
street_numberNúmero do endereço de cora.< 15 ANNÃO
complementComplemento do endereço de cora.< 50 ANNÃO
countyBairro do endereço de cora.< 150 ANNÃO
zip_codeCEP do endereço de cora. Ex.: 21241-140.< 9 ANNÃO
cityCidade do endereço de cora.< 50 ANNÃO
stateEstado do endereço de cora.= 2 ANNÃO
countryPaís do endereço de cora seguindo a AN 3166-1. Ex.: BRA= 3 ANNÃO
additional_data.items[]Elemento para envio de dados referentes aos produtos do comprador.
titleNome do produto.< 255 ANNÃO
quantityQuantidade do produto a ser adquirido.< 15 NNÃO
idCódigo comerciante identificador do produto.< 255 ANNÃO
unit_pricePreço unitário do produto em centavos.< 15 NNÃO
discount_amountValor em centavos de desconto sobre o produto< 12 ANNÃO

Atualmente, o SafraPay não permite parcelamento com juros da administradora do cartão, ou seja, o campo installments_type não pode receber o valor 3 e o valor 6.

Efetivação de Pagamento#

Campos relevantes na chamada descrita no Serviço de efetivação de pagamento:

ParâmetroDescriçãoFormatoObrigatório
external_authenticationEste elemento recebe campos de autenticação MPI.
eciEletronic Commerce Indicator – indica o nível de segurança da transação com autenticação do dono do cartão< 3 NNÃO
xidIdentificador da transação de autenticação do dono do cartão, feita em serviço externo ao Carat< 40 NNÃO
cavvCardholder Authentication Verification Value - Código que indica o resultado da autenticação do dono do cartão.< 40 NNÃO
cavv_key_indicatorIndicador de 2 digitos utilizado pela bandeira ELO.< 2 NNÃO
unpredictable_numberIndicador numérico utilizado pela bandeira ELO.-NÃO
auth_tracking_numberIndicador numérico utilizado pela bandeira ELO.-NÃO

Entre os campos de resposta do Serviço de efetivação de pagamento, o campo issuer será preenchido com o código de bandeira do cartão que foi reconhecido no pagamento. Abaixo está a lista de códigos e bandeira:

CódigoBandeira
1VISA (crédito)
20002VISA (débito)
2MASTERCARD
20001MASTERCARD (débito)
4AMEX
12HIPERCARD (crédito)
20037HIPERCARD (débito)
31ELO (crédito)
20032ELO (débito)

Confirmação de Pagamento#

É possível confirmar um valor inferior ao valor das autorizações criadas via HTML e via via REST utilizando o campo additional_data.postpone_confirmation igual a true.

Para isso, envie na chamada de confirmação REST o valor de amount desejado:

ParâmetroDescriçãoFormatoObrigatório
confirmEste campo deve ser enviado com o valor true caso se deseje confirmar a transação, ou false, caso queira desfazer o pagamento.< 5 T/FSIM
amountValor em centavos do valor que será confirmado. Caso não seja enviado, o valor completo da transação será confirmado.< 12 NNÃO

Recorrência#

O SafraPay aceita o parâmetros de sinalização de recorrência de transações. Para isso, envie na chamada de efetivação de pagamento REST o campo acquirer.recurrency com o valor true.

Para mais informações consulte a página sobre o Serviço de Efetivação de Pagamento REST.

Pré-Autorização#

Normalmente, o parcelamento de uma pré-autorização é processado no Serviço de Captura de Pré-Autorização, mas o SafraPay é uma das exceções. O preenchimento dos campos installments e installment_type será processado na efetuação da pré-autorização ou na inicialização de uma transação de pré-autorização. Para maiores detalhes do preenchimento deste campo, veja:

Atualmente, o SafraPay não permite parcelamento com juros da administradora do cartão, ou seja, o campo installments_type não pode utilizar o valor 3 e o valor 6 (IATA).

Cancelamento#

O Cancelamento de uma transação pode ser feito no Portal do Lojista ou via Web Service REST. Poderão ser canceladas as transações efetuadas no dia corrente do cancelamento (D+0) ou em outros dias (D+N). O lojista pode cancelar transações de pagamento que foram confirmadas como também as que ainda não foram.

É possível também cancelar valores inferiores aos do pagamento original, tanto nas transações confirmadas e não confirmadas. No caso de transações não confirmadas é possível realizar apenas um cancelamento parcial.

O processamento de transações de cancelamento do SafraPay ocorre na janela entre 0 hora até às 6 horas da manhã. Aconselhamos que os cancelamentos não sejam efetuados nesse período.

IATA#

O roteamento SafraPay suporta pagamentos com IATA (International Air Transport Association). Portanto, os campos departure_tax e first_installment serão processados no serviço de criação de transação do pagamento REST.