List dealers service
Call details#
- Resource:
/v3/rechargedealers - HTTP Method:
GET - Request format:
query string - Response format:
JSON - Header parameters:
| Parameter | Description | Format | Mandatory |
|---|---|---|---|
Authorization | Authenticity signature in Bearer {signature} format. Learn more.Example: Bearer hh39458f73hf45324765ft349h5f73t4h95f34.This field is mandatory if the transaction was created with the signature process. | < 2000 AN | COND. |
Examples#
Below are some examples of the list dealers service call using the cURL tool.
List dealers of normal recharge#
Request:
To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br
Response:
List dealers of other products recharge#
Request:
To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br
Response:
List dealers of signature invoice payment (invoice)#
Request:
To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br
Response:
List dealers with sent signature#
Request:
To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br
Response:
Request parameters#
The table below describes the request parameters of the list dealers service:
| Parameter | Description | Format | Mandatory |
|---|---|---|---|
nit | Identification of the recharge transaction on Carat Portal | = 64 A | SIM |
generalhash | Identification code of the table with the data related to the recharges (dealers, branches, amount ranges, expiration periods, among others). | = 16 A | NÃO |
Response parameters#
If successful, the HTTP response code will be 200. Any other code must be interpreted as an error. The table below describes the response parameters of the list dealers service:
| Parameter | Description | Format |
|---|---|---|
status | Status of the recharge transaction on Carat Portal. Learn more. | = 3 AN |
| esitef | ||
code | Carat Portal response code. Any code different from 0(zero) means failure. Learn more. | < 4 N |
message | Carat Portal response message. | < 500 AN |
| authorizer | ||
code | Response code returned by the authorizer | < 4 AN |
message | Message returned by the authorizer | < 64 AN |
| hashes | ||
general | Identification code of the table with the data related to the recharges (dealers, branches, amount ranges, expiration periods, among others). | = 16 AN |
| dealers[] | ||
code | Dealer code | = 3 N |
name | Dealer name | < 100 AN |
| dealers[].branches[] | ||
code | Branch code | = 11 N |
name | Branch name | < 100 AN |
| questions[] This field adds a list of questions for positive confirmation. The returned questions must, necessarily, be answered by the user and have their answers sent to Carat Portal in the next step (list branch data). | ||
id | Question identification code | < 20 AN |
display | Text of the question to be presented | < 180 AN |
rule | Indicates where the data must be collected. Learn more. | < 2 AN |
min | Indicates the minimum response size | < 4 N |
max | Indicates the maximum response size | < 5 N |
type | Indicates the data type of the response to be collected. Learn more. | < 3 AN |
min_value | Indicates the minimum response value | < 3 N |
max_value | Indicates the maximum response value | < 3 N |
Return of the questions.rule field#
| Rule | Description |
|---|---|
0 | Operator keyboard |
1 | PinPad (Not applicable) |
2 | Magnetic track reading on PIN PAD (Not applicable) |
3 | Automation (The question should not be presented to the operator / customer to collect the response. In this case, the automation itself must answer the question without operator / customer intervention). |
4 | Supervisor password (not PINPAD) |
5 | Operator keyboard with double typing. The <Display> must contain two texts, the first one refers to the request for the input of the data and the second, refers to the confirmation of the input of the data, which must be the same as the first.The texts must be separated by ; as informed below.<Display> = Text for 1st collection; Text for 2nd collection (confirmation) |
6 | Barcode reader |
7 | Typing with confirmation (In this case, a screen must be displayed for confirmation of the collected data). |
Return of the questions.type field#
| Type | Description |
|---|---|
A | Alphabetical. |
AN | Special alphanumeric (ans). |
LN | Letters (not accented) and numbers. |
Nx | Numeric where x is the number of decimal digits supported. |
Vx | Value with x decimal digits. |
S | Menu type Yes / No. |
Sc | Menu type Yes / No conditional. If the input is "No", the transaction must be aborted. |
M | Free menu. In this case, the <Display> field will have the following format: the menu text must be separated by a | character from the options. The options, in turn, should consist of index and text separated by :, while one option is separated by the other by ^. That is:<Display> = <Menu Text>|<option 1>^<option 2>^...^<option N> At where, <Menu Text> = Menu header text (Ex: Choose the banner of the card)<Option N> = <Index>:<Option Text> (Ex: 1:Visa) |
Mc | Free menu with confirmation. Here is the Free Menu rule, where: <Display> = <Menu Text>|<Confirmation Text>|<option 1>^<option 2>^...^<option N> |
M0 | Free menu type 0 (zero). (Not applicable) It follows the rule of the Free Menu with confirmation, however, the selection indexes of the menu in the display must be suppressed and only selected with the POS arrows. Free Menu Display Example: 1 – Yes2 – NoSample Free Menu Display Type 0: Yes No |