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 permitidasAs seguintes autorizadoras são suportadas pelo roteamento SafraPay:
- VISA
- MASTERCARD
- ELO
- AMERICAN EXPRESS
- HIPERCARD
#
Credenciais necessáriasA 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.
Campo | Descrição | Formato |
---|---|---|
merchantID | Código de EC cadastrado na SafraPay. | < 15 AN |
terminalId | Identificaçã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 CaratO 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:
Saiba mais detalhes sobre o Portal do Lojista.
#
FluxosNesta seção serão apresentadas as particularidades do fluxo transacional SafraPay.
#
Pagamento REST/HTMLAbaixo estão listados os campos que são diferenciados e são relevantes para o SafraPay:
#
REST Begin / HTML InitCampos 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 |
---|---|---|---|
soft_descriptor | Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. Saiba mais | < 30 AN | NÃO |
additional_data | Elemento para envio de dados adicionais. | ||
postpone_confirmation | Campo que permite que loja mantenha a transação como Pendente de Confirmação, e posteriormente, confirmá-la ou desfazê-la. | < 5 A | NÃO |
transaction_initiated_by | Indica 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 AN | NÃO |
total_order_amount | Montante final da compra. | < 8 AN | NÃO |
tax_amount | Montante da taxa. | < 8 AN | NÃO |
additional_data.payer | Elemento para envio de dados referentes ao comprador. | ||
id | Identificação do comprador. | < 200 AN | NÃO |
name | Nome do comprador. Obs.: a concatenação de nome com o sobrenome não pode ultrapassar 255 caracteres. | < 200 AN | NÃO |
surname | Sobrenome do comprador. Obs.: a concatenação do nome com o sobrenome não pode ultrapassar 255 caracteres. | < 200 AN | NÃO |
identification_number | Número de identificação do comprador. | < 200 AN | NÃO |
identification_type | Tipo da identificação informada pelo comprador (RG, CPF, etc.). | < 200 AN | NÃO |
email | E-mail do comprador. | < 255 AN | NÃO |
additional_data. payer.phones[] | Apenas 1 telefone será repassado para o Safrapay. | ||
ddi | DDI do telefone. | < 255 AN | NÃO |
ddd | DDD do telefone. | < 15 AN | NÃO |
number | Número do telefone. | < 50 AN | NÃO |
additional_data. shipment.receiver_address | Elemento para envio de dados referentes ao endereço de entrega. | ||
street_name | Endereço de entrega. | < 255 AN | NÃO |
street_number | Número do endereço de entrega. | < 15 AN | NÃO |
complement | Complemento do endereço de entrega. | < 50 AN | NÃO |
county | Bairro do endereço de entrega. | < 150 AN | NÃO |
zip_code | CEP do endereço de entrega. Ex.: 21241-140. | < 9 AN | NÃO |
city | Cidade do endereço de entrega. | < 50 AN | NÃO |
state | Estado do endereço de entrega. | = 2 AN | NÃO |
country | País do endereço de entrega seguindo a AN 3166-1. Ex.: BRA | = 3 AN | NÃO |
additional_data. billing_data.address | Elemento para envio de dados referentes ao endereço de cobrança. | ||
street_name | Endereço de cora. | < 255 AN | NÃO |
street_number | Número do endereço de cora. | < 15 AN | NÃO |
complement | Complemento do endereço de cora. | < 50 AN | NÃO |
county | Bairro do endereço de cora. | < 150 AN | NÃO |
zip_code | CEP do endereço de cora. Ex.: 21241-140. | < 9 AN | NÃO |
city | Cidade do endereço de cora. | < 50 AN | NÃO |
state | Estado do endereço de cora. | = 2 AN | NÃO |
country | País do endereço de cora seguindo a AN 3166-1. Ex.: BRA | = 3 AN | NÃO |
additional_data.items[] | Elemento para envio de dados referentes aos produtos do comprador. | ||
title | Nome do produto. | < 255 AN | NÃO |
quantity | Quantidade do produto a ser adquirido. | < 15 N | NÃO |
id | Código comerciante identificador do produto. | < 255 AN | NÃO |
unit_price | Preço unitário do produto em centavos. | < 15 N | NÃO |
discount_amount | Valor em centavos de desconto sobre o produto | < 12 AN | NÃ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 valor3
e o valor6
.
#
Efetivação de PagamentoCampos relevantes na chamada descrita no Serviço de efetivação de pagamento:
Parâmetro | Descrição | Formato | Obrigatório |
---|---|---|---|
external_authentication | Este elemento recebe campos de autenticação MPI. | ||
eci | Eletronic Commerce Indicator – indica o nível de segurança da transação com autenticação do dono do cartão | < 3 N | NÃO |
xid | Identificador da transação de autenticação do dono do cartão, feita em serviço externo ao Carat | < 40 N | NÃO |
cavv | Cardholder Authentication Verification Value - Código que indica o resultado da autenticação do dono do cartão. | < 40 N | NÃO |
cavv_key_indicator | Indicador de 2 digitos utilizado pela bandeira ELO. | < 2 N | NÃO |
unpredictable_number | Indicador numérico utilizado pela bandeira ELO. | - | NÃO |
auth_tracking_number | Indicador 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ódigo | Bandeira |
---|---|
1 | VISA (crédito) |
20002 | VISA (débito) |
2 | MASTERCARD |
20001 | MASTERCARD (débito) |
4 | AMEX |
12 | HIPERCARD (crédito) |
20037 | HIPERCARD (débito) |
31 | ELO (crédito) |
20032 | ELO (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âmetro | Descrição | Formato | Obrigatório |
---|---|---|---|
confirm | Este campo deve ser enviado com o valor true caso se deseje confirmar a transação, ou false , caso queira desfazer o pagamento. | < 5 T/F | SIM |
amount | Valor em centavos do valor que será confirmado. Caso não seja enviado, o valor completo da transação será confirmado. | < 12 N | NÃO |
#
RecorrênciaO 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çãoNormalmente, 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 valor3
e o valor6
(IATA).
#
CancelamentoO 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.
#
IATAO 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.