Multiple transactions status query

These services can be called to retrieve data from multiple transactions for a store or store group. It is essential to use this operation in cases of communication error to check the current status of transactions, which may have been carried out or not received by e-SiTef.

Note:

Consultation of transactions on e-SiTef ** DOES NOT perform a query on the status of transactions on the acquirer / authorizer **. This service returns the status of the transaction in the e-SiTef database.

Example: If a payment transaction is confirmed in e-SiTef, but is reversed via telephone directly to the acquirer / authorizer, this reversal will not necessarily be reflected in the e-SiTef transaction query service.

Call details

Resource: /v1/transactions
HTTP Method: GET
Request format: query string
Response format: JSON
Header parameters:

Parameter	Description	Format	Mandatory
`merchant_id`	Merchant code on e-SiTef. The production and certification codes will be different.	< 15 AN	YES
`merchant_key`	Merchant authentication key on e-SiTef. The production and certification keys will be different.	< 80 AN	YES
`group_id`	Store group code in e-SiTef. If sent, a search will be made for the store group. It is necessary that the store code is within the group.	< 38 N	NO

Request parameters:

Parameter	Description	Format	Mandatory
`start_date`	Start date of the transactions to be listed. Format: `dd/MM/yyyy`	= 10 AN	YES
`end_date`	End date of the transactions to be listed. Maximum period: 5 DAYS (configurable). Format: `dd/MM/yyyy`	= 10 AN	YES
`status`	Transaction status filter. Ex.: "CON"	= 3 N	NO
`page`	Listing page. The first page has a value of "0". If it is not sent, we will assume the value "0".	< 1000 N	NO
`limit`	Maximum number of records per page. If not sent, we will assume the maximum value of 1000 transactions at a time (configurable).	< 4 N	NO
`payment_link`	Filter to query by payment link transactions. Only active in true value	< 5 T/F	NO

Examples

Below are some examples of the query services calls using the cURL tool.

Payment query

Request:

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions?start_date=25/11/2020&end_date=27/11/2020&status=CON&page=0&limit=50"
--header "merchant_id: xxxxxxxxxxxxxxx" 
--header "merchant_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
--header "group_id: 12345"
--verbose

Response:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "current_page":"0",
   "total_pages":"1",
   "count":"2",
   "transactions":[
      {
         "type":"P",
         "authorizer_code":"000",
         "authorizer_message":"Transacao OK",
         "status":"CON",
         "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
         "order_id":"13064421440",
         "customer_receipt":"==== CUPOM COMPRADOR ====",
         "merchant_receipt":"==== CUPOM ESTABELECIMENTO ====",
         "authorizer_id":"2",
         "acquirer_id":"1005",
         "acquirer_name":"Redecard",
         "authorizer_date":"13/07/2017T18:44",
         "authorization_number":"132048",
         "merchant_usn":"13064421441",
         "esitef_usn":"170713097341620",
         "sitef_usn":"132048",
         "host_usn":"999132048   ",
         "payment_date":"13/07/2017T18:44",
         "amount":"1000",
         "payment_type":"C",
         "issuer":"2",
         "authorizer_merchant_id":"000000000000005",
         "merchant_id": "xxxxxxxxxxxxxxx",
         "creation_date": "13/07/2017T18:43",
         "installments": "1"
      },
      {
         "type":"F",
         "authorizer_code":"000",
         "authorizer_message":"Transacao OK",
         "status":"CON",
         "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
         "order_id":"13064421440",
         "customer_receipt":"==== CUPOM COMPRADOR ====",
         "merchant_receipt":"==== CUPOM ESTABELECIMENTO ====",
         "authorizer_id":"2",
         "acquirer_id":"1005",
         "acquirer_name":"Redecard",
         "authorizer_date":"13/07/2017T18:44",
         "authorization_number":"132048",
         "merchant_usn":"13064421441",
         "esitef_usn":"170713097341620",
         "sitef_usn":"132048",
         "host_usn":"999132048   ",
         "payment_date":"13/07/2017T18:44",
         "amount":"1000",
         "payment_type":"C",
         "issuer":"2",
         "authorizer_merchant_id":"000000000000005",
         "merchant_id": "xxxxxxxxxxxxxxx",
         "creation_date": "13/07/2017T18:42",
         "installments": "3"
      }
   ]
}

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 multiple transactions query:

Parameter	Description	Format
`code`	e-SiTef response code. Any code different from `0` means failure. Learn more.	< 4 N
`message`	e-SiTef response message.	< 500 AN
`current_page`	Current page of records.	< 4 N
`total_pages`	Total number of pages.	< 4 N
`count`	Total count of records.	< 4 N
transactions[]	List of transactions found for the selected filters. We will return only the fields in common between the various types of transaction, besides the new "type" field, which explains what the type of transaction is.
`type`	Type of transaction. Ex.: `G = Pre Authorization Capture, A = AVS Consultation, E = Cancel, P = Payment, F = pre Authorization, R = Recharge`	< 1 A
`authorizer_code`	Authorizer response code.	< 10 AN
`authorizer_message`	Authorizer response message.	< 500 AN
`status`	Status of the payment transaction on e-SiTef. Learn more.	= 3 AN
`nit`	Identifier of the payment transaction on e-SiTef.	= 64 AN
`merchant_id`	Merchant code on e-SiTef. The production and certification codes will be different.	< 15 AN
`order_id`	Order code sent by the merchant on the creation of the transaction.	< 40 AN
`merchant_usn`	Unique sequential number sent by the merchant on the creation of the transaction.	< 12 N
`amount`	Total price of the purchase specified by the merchant (in cents) on the creation of the transaction.	< 12 N
`sitef_usn`	Unique sequential number of the payment transaction on SiTef.	= 6 N
`esitef_usn`	Unique sequential number of the payment transaction on e-SiTef.	= 15 N
`customer_receipt`	Customer's receipt.	< 4000 AN
`merchant_receipt`	Merchant's receipt.	< 4000 AN
`authorizer_id`	Code of the authorizer used on the transaction.	< 4 N
`acquirer_id`	Code of the acquirer used on the transaction.	< 4 N
`acquirer_name`	Name of the acquirer used on the transaction.	< 100 AN
`authorizer_date`	Payment authorization date returned by the authorizer in `dd/MM/yyyy'T'HH:mm` format. Example: 13/07/2017T16:03	= 16 D
`authorization_number`	Authorization number.	< 6 AN
`host_usn`	Host USN.	< 15 AN
`tid`	ID of the transaction on the acquirer. This field is only returned on transactions with acquirers that are external to SiTef.	< 40 AN
`payment_date`	Payment authorization date on e-SiTef in `dd/MM/yyyy'T'HH:mm` format. Example: 13/07/2017T16:03	= 16 D
`issuer`	Issuer code returned by the authorizer.	< 5 AN
`authorizer_merchant_id`	Affiliation code of the merchant on the authorizer.	< 100 AN
`payment_type`	Type of payment of the chosen authorizer. `C = Credit, D = Debit`	< 1 A
`creation_date`	Transaction creation date on e-SiTef in `dd/MM/yyyy'T'HH:mm` format. Example: `13/07/2017T16:03`	= 16 D
`installments`	Transaction installments number	< 2 N