Create Recharge Service

import RecargaVisaoGeral from './recarga-html-fluxo.md';

Transaction creation process

The transaction creation process must follow these steps:

• The transaction is created according to the parameters sent in the request key and represented by a JSON object via POST in the request;
• The merchant receives a success or error message, formatted as XML or JSON, according to the response_type parameter in the URL sent when starting a transaction.

URL to start a transaction via HTTPS POST:

Attention: The IP should never be used instead of the domain esitef-ec.softwareexpress.com.br (or esitef-homologacao.softwareexpress.com.br for the homologation environment). IP can change at any time and without notice, so it is important to always use the domain to access Carat Portal.

POST parameters:

• Key: request;
• Value: JSON object;
• [response_type]: json or xml;

JSON request example (JavaScriptObjectNotation):

URL: https://esitef-homologacao.softwareexpress.com.br/e-sitef-hml/init/json.se

Basic JSON request example:

{
  "merchant_id": "codigoDaLoja",
  "amount": "1800"
}

JSON object request with some additional parameters:

{
  "merchant_id": "codigoDaLoja",
  "order_id": "123456",
  "installments": "4",
  "recharge_included": "true",
  "recharge": {
    "dealer_code": "2",
    "phone": {
      "number": "87654321",
      "ddd": "11"
    }
  }
}

Test tools

For initial testing in this interface, if necessary, some tools can be used in order to better understand REST communication:

• Application for Windows/Linux/Mac:
  • POSTMAN
• Firefox extension:
  • RESTClient

Sample screens of these tools:

Request parameters

To initiate a transaction in the new HTML payment interface, the following parameters can be initially filled in JSON format:

{
  "merchant_id": "codigoDaLoja",
  "recharge_included": "true",
  "recharge": {}
}

RECHARGE (recharge)

{
  "dealer_code": "1",
  "phone": {}
}

PHONE (phone)

{
  "number": "123456789",
  "ddd": "11"
}

Response parameters

The response of the transaction creation operation (JSON format):

{
  "responseCode": 0,
  "description": "OK. Transaction successful.",
  "url": "https:// esitef-homologacao.softwareexpress.com.br/e-sitef/do.se?input['nit']= 1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
  "nsuesitef": "123456789012345",
  "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
}

The returned fields are described in table below: