Getnet

Merchants can configure transactions on Carat Portal to be routed by many acquirers and payment methods. One of these is Getnet e-commerce, hereafter mentioned as GetnetWS.

In this page, the nomenclature "GetnetWS" will be used to reference the acquirer on Carat Portal.

Thus, the store can configure Carat Portal so that transactions made with VISA cards, for example, are routed through GetnetWS while those made with MASTERCARD are routed through CIELO.

Supported Carat Portal interfaces#

The following interfaces for integration with GetnetWS are available:

  • REST Payment
  • REST Pre-Authorization
  • REST Cancel
  • HTML Payment
  • HTML Pre-Authorization

Allowed Authorizers / Issuers#

The following authorizers / issuers are available for integration with GetnetWS:

  • VISA
  • MASTERCARD
  • ELO
  • AMERICAN EXPRESS
  • HIPERCARD

Required credentials#

The merchant must obtain with GetnetWS the credentials listed below, and pass them to Software Express or make the registration as explained later in this document.

ParameterDescriptionFormat
usernameAccess user name.20 N
passwordAccess password.40 AN
merchantIDEC code registered on GetnetWS.10 AN
terminalTerminal identification.7 AN
subMerchantIdSubmerchant ID.< 15 AN

Important for HTML Payment: If the merchant has not registered these credentials, this authorizer will not be displayed on the credit card selection screen during the payment transaction.

Registration of information through the merchant's portal#

The merchant can register the information obtained with GetnetWS on the Merchant's Portal on Carat Portal. In this environment, you can change the authentication settings and password of the transactions. For this purpose, the merchant must select the authorizer and enter the editing screen as in the example shown below:

In the editing environment of the Authorizer, you can change the password registered on the Carat Portal environment. In this case, the change will only occur for this authorizer. Note that if merchant uses the same GetnetWS account, it will be necessary to manually change passwords for all the other authorizers.

Also in this environment, you can also change the registration password on Getnet. It is important to remember that when changing this password on the Getnet environment all the stores associated with this account on Getnet will also have to change the password registered on the Carat Portal environment by going to the edit screen of their authorizer, otherwise Getnet will deny their transactions.

The screen for changing the password on Getnet:

The new password must follow the rules defined by Getnet. These rules can be found in the integration document.

SoftDescriptor Registration on Carat Portal#

Subacquiring#

Information related to subacquiring are registered by our support team. The following data are required:

ParameterFormat
Submerchant ID< 15 AN
Submerchant City< 13 A
Submerchant State= 2 A
Submerchant Zip Code= 8 N
Submerchant CNPJ or CPF< 15 AN
Submerchant Street Name< 40 AN
MCC= 4 N
Soft-Descriptor< 22 AN Learn more

The following fields can also be sent inside Carat Portal requests:

ParameterFieldNotes
Submerchant IDsubacquirer_merchant_idSent in the payment effectuation service request.
MCCmccSent in the payment effectuation service request.
Soft-Descriptorsoft_descriptorSent in the transaction creation service request.

If the fields above are both registered in the merchant's configurations and sent inside the request, the value inside the request has precedence.

Recurrency#

In order to acknowledge a recurrent payment, the GetnetWS integration establishes some rules that will be explained in this section.

The fields used in recurrencies are presented below.

FieldDescriptionFormat
acquirer.recurrencySent inside the request. Flag that defines whether or not the payment is recurring.< 5 T/F
acquirer.recurrency_tidSent inside the request. First transaction's TID. This field tells the first and the subsequent transactions apart.= 18 N
acquirer.recurrency_seq_idSent inside the request. Represents the current installment number.< 3 N
payment.tidReceived inside the response. It is the acquirer's transaction ID.= 18 N

If the merchant does the recurrencies by himself/herself, he/she must follow the following steps:

  • Step 1: First recurrency:
    • Send acquirer.recurrency as true;
    • Store payment.tid to use in the subsequent recurrencies.
  • Step N: Subsequent recurrencies:
    • Send acquirer.recurrency as true;
    • Send acquirer.recurrency_tid with the value of the payment.tid field stored in Step 1;
    • Send acquirer.recurrency_seq_id with the current installment number (from 1 up to 999).

If the merchant does the recurrencies by using Carat Portal schedule service, the recurrency fields will be sent automatically and the recurrency processing can be monitored in the schedules reports as usual.

If the merchant does the recurrencies by using Carat Portal payment with schedule service, the recurrency fields will be sent automatically and the recurrency processing can be monitored in the schedules reports as usual. However, the ID used to identify the first recurrency transaction is the initial payment transaction ID and it is not the first scheduled payment ID.

Transaction Flow#

In this section, we will present the particularities of the Getnet transactional flow.

HTML Payment#

It's possible to do a payment with 3DS authentication. For this, just send the authorizer_authentication parameter with the value true on the transaction creation phase.

Relevant fields in the call described in HTML Transaction Creation Service and REST Transaction Creation Service:

ParameterDescriptionFormatMandatory
authorizer_authenticationIdentifies whether the merchant wants a payment with authentication. If positive, send true.< 5 ANYES for credit with authentication
iataThis element contains specific fields that will be mandatory, if are with IATA transactions.
first_installmentAmount of the first installment on IATA transactions in cents.< 12 NConditional (required only for IATA transactions - sale of airline tickets)
departure_taxDeparture tax in cents.< 12 NConditional (required only for IATA transactions - sale of airline tickets)

Pre-Authorization#

It isn't possible to perform a pre-authorization with issuer installment funding.

Relevant fields in the call described in HTML Transaction Creation Service and REST Transaction Creation Service:

ParameterDescriptionFormatMandatory
iataThis element contains specific fields that will be mandatory, if are with IATA transactions.
first_installmentAmount of the first installment on IATA transactions in cents.< 12 NConditional (required only for IATA transactions - sale of airline tickets)
departure_taxDeparture tax in cents.< 12 NConditional (required only for IATA transactions - sale of airline tickets)

Edit Pre-Authorization#

It's possible to re-send the pre-authorization effectuation request with the amount field to alter its amount.

ParameterDescriptionFormatMandatory
amountNew pre-authorization amount in cents.< 12 NYES

REST Payment and Pre-Authorization#

  • The card.holder field is mandatory.
  • GetnetWS accepts sending authentication data: eci, xid and cavv.
ParameterDescriptionFormatMandatory
card.holderCard holder name.< 26 ANYES
external_authentication.eciECI Code of the 3D Secure authenticated transaction.= 2 NNO
external_authentication.xidMPI ID for each authenticated transaction.< 40 ANNO
external_authentication.cavvAuthentication code encrypted by the issuer.< 40 ANNO

Refund#

Transaction refunding can be done through the Merchant’s Portal. Only transactions made on the current day can be refunded. The merchant can refund pre-authorization transactions with or without capture and payment transactions. If you refund a pre-authorization transaction with capture, Getnet will refund the capture, however, Carat Portal will display this pre-transaction with status refunded (and confirmed capture).