Returns of requests
Below are the various possible return formats for the various requests above.
Transaction List#
The returned JSON will have the following format:
| Field | Description | Type | Format |
|---|---|---|---|
| transacoes | List of Transactions Found | List | - |
| status | Requisition Status: OK (Transaction found) No records found | Text | - |
| codsit | SiTef Network Code (see network code table) | Numeric | - |
| datatrn | Transaction date | Numeric | YYYYMMDD |
| nsusitef | Sitef´s NSU Transaciton | Numeric | - |
| codlojasitef | SiTef´s store code | Alphanumeric | - |
| codlojatronco | Sub-acquirer store code | Alphanumeric | - |
| horatrn | Transaction Time | Numeric | HHMMSS |
| valor | Transaction Value | Numeric | - |
| tipo | Transaction Type (see Type Table) | Alphanumeric | - |
| codResp | Response Code | Numeric | - |
| estado | Transaction Status (see Transaction Status Table) | Alphanumeric | - |
| codAutorizacao | Authorization Code | Alphanumeric | - |
| cupomFiscal | Invoice | Text | - |
| produto | Product associated with the transaction | Text | - |
| infoTransacao | Type of transaction (see Transaction Table) | Text | - |
| documento | Credit Card Number / Bar Code / Cell phone number / European Article Number | Text | - |
| numParcelas | Number of installments in the transaction | Numeric | - |
| numPdv | POS terminal identification | Alphanumeric | - |
| nsuHost | NSU Host | Alphanumeric | - |
| modoEntrada | Description of the input mode used in the transaction (see Input Mode Description Table) | Texto | - |
| codEstabelecimento | company code | Alphanumeric | - |
| cnpj | CNPJ of the SiTef store of the transaction | Numeric | - |
| descRede | Description of the SiTef Network (see Network Code Table) | Alphanumeric | - |
| codigoCliente | Custommer code on GW/Express platform (in case of SiTefWeb, fixed value null) | Numeric | - |
| quem_negou | Indication of who denied the transaction (see Table of "Who Denied" the Transaction) | Alphanumeric | * |
| data_fiscal | Transaction tax date (sent by cash front automation) | Numeric | YYYYMMDD |
| hora_fiscal | Transaction tax time (sent by cash front automation) | Numeric | HHMMSS |
| id_cliente | Custommer Identification (sent by cash front automation) | Alphanumeric | - |
| cod_operadora | Identification of the telephone company (see Table of Operators) | Numeric | ** |
| cod_filial | Identification of the concessionaire's branch unit (see Table of Branches) | Numeric | ** |
| valor_repasse | Numeric transferred value | *** | |
| valor_avista | Amount received in cash Numeric | *** | |
| valor_cartao | Amount received in Numerical TEF | ** | |
| cod_rede_autoriz | Authorizing network code (this field is only present for CardSE module transactions) (see Authorizing network table) | Numeric | - |
| data_exportacao | Date and time the export or re-export was performed | Numeric | YYYYMMDD HHMMSS |
| cod_autorizacao_aux | Auxiliary authorization code (This field is present only for Vero module transactions (formerly Banrisul)) | Numeric | - |
| nsuHostaux | NSU Host aux. The informationnull or nsu of the Authorizer may be displayed, in the case of authorizations by FEPAS(SE) | Alphanumeric | - |
| forma_pagto_cd | Payment method used in the Digital Wallet. The informationnull or nsu of the Authorizer may be displayed, in the case of authorizations by FEPAS(SE) | Alphanumeric | 01 = Credit 02 = Debit 04 = Prprepaid 05 = fleet |
| subtipo_pagto_cd_estorno | Payment code used in the Digital Wallet. The informationnull or nsu of the Authorizer may be displayed, in the case of authorizations by FEPAS(SE) | Alphanumeric | 01 = Food 02 = Meal 03 = Culture 04 = Premium 05 = Benefit 06 = Drugstore 07 = Multiples 19 = Outhers 20 = Balance 30 = Pix |
| band_pagto_cd | Credit Card Company Code used in the Digital Wallet. The informationnull or nsu of the Authorizer may be displayed, in the case of authorizations by FEPAS(SE)) | Numeric | - |
| psp | PSP Code. The informationnull or nsu of the Authorizer may be displayed, in the case of authorizations by FEPAS(SE) | Alphanumeric | - |
| forma_pagamento_1 ... 4 | Payment method used to load the Voucher in the SAV (there can be 4 ways) | Alphanumeric | - |
| valor_pagamento_1 ... 4 | Payment amount used to load the Voucher in the SAV (can be 4 amounts) | Numeric | - |
* In case of transactions with status other than “denied”, ignore field value.
** These fields are filled in for cell top up transactions only.
*** These fields are filled in for PBM(Drug Benefit Program) transactions only.
List of Reversal and Reversal Transactions#
| Field | Description | Type | Format |
|---|---|---|---|
| transacoes | List of Found Transactions | List | - |
| estorno | Reversal Transaction Information | - | - |
| estornada | Reversed Transaction Information | - | - |
| status | Requisition Status: OK (Transaction Found) No records found | Texto | - |
| codsit | SiTef Network Code (see Network Code Table) | Numeric | - |
| datatrn | Transaction date | Numeric | AAAAMMDD |
| nsusitef | NSU SiTef Transaction | Numeric | - |
| codlojasitef | SiTef store code | Alphanumeric | - |
| codlojatronco | Sub-acquirer store code | Alphanumeric | - |
| horatrn | Transaction Time | Numeric | HHMMSS |
| valor | Transaction value | Numeric | - |
| tipo | Transaction Type (see Type Table) | Alphanumeric | - |
| codResp | Response Code | Numeric | - |
| estado | Transaction Status (see Transaction Status Table) | Alphanumeric | - |
| codAutorizacao | Authorization Code | Alphanumeric | - |
| cupomFiscal | Invoice | Text | - |
| produto | Product associated with the transaction | Text | - |
| infoTransacao | Transaction type (see Transactions Table) | Texto | - |
| documento | Credit Card Number / Bar Code / Cell phone number / (EAN)European Article Number | Text - | |
| numParcelas | Number of installments in the transaction | Numeric | - |
| numPdv | POS terminal identification | Alphanumeric | - |
| nsuHost | NSU | Host | Alphanumeric |
| modoEntrada | Description of the input mode used in the transaction (see Input Mode Description Table) | Texto | - |
| codEstabelecimento | Company Code | Alphanumeric | - |
| cnpj | CNPJ of the SiTef store of the transaction | Numeric | - |
| descRede | Description of the SiTef Network (see Network Code Table) | Alphanumeric | - |
| codigoCliente | Client code on GW/Express platform (in case of SiTefWeb, fixed value null) | Numeric | - |
| quem_negou | Indication of who denied the transaction (see Table of "Who Denied" the Transaction) | Alphanumeric | * |
| data_fiscal | Transaction tax date (sent by cash front automation) | Numeric | YYYYMMDD |
| hora_fiscal | Transaction tax time (sent by the cash front automation) | Numeric | HHMMSS |
| id_cliente | Custommer Identification (sent by cash front automation) | Alphanumeric | - |
| cod_operadora | Identification of the telephone company (see Table of Operators) | Numeric | ** |
| cod_filial | Identification of the concessionaire's branch unit (see Table of Branches) | Numeric | ** |
| valor_repasse | Numeric transferred value | *** | |
| valor_avista | Amount received in cash Numeric | *** | |
| valor_cartao | Amount received in TEF Numeric | ** | |
| cod_rede_autoriz | Authorizing network code (this field is only present for CardSE module transactions) (see Authorizing network table) | Numeric | - |
| data_exportacao | Date and time the export or re-export was performed | Numeric | YYYYMMDD HHMMSS |
| cod_autorizacao_aux | Auxiliary authorization code (This field is only present for Vero module transactions (formerly Banrisul)) | Numeric | - |
| nsuHostaux | NSU Host aux. null or Authorizer's nsu may be displayed, in the case of authorizations by FEPAS (SE) | Alphanumeric | - |
| forma_pagto_cd | Payment method used in the Digital Wallet. null or code informed by FEPAS (SE) may be displayed | Alphanumeric | 01 = Credit 02 = Debit 04 = prepaid 05 = Fleet |
| subtipo_pagto_cd_estorno | Payment code used in the Digital Wallet.null or code informed by FEPAS (SE) may be displayed | Alphanumeric | 01 = Food 02 = meal 03 = Culture 04 = Premium 05 = pension benefits 06 = Drugstore 07 = Multiples 19 = Others 20 = Balance 30 = Pix |
| band_pagto_cd | Credit Card Company Code used in the Digital Wallet. null or code informed by FEPAS (SE) may be displayed | Numeric | - |
| psp | PSP Code. null or code informed by FEPAS (SE) may be displayed | Alphanumeric | - |
| forma_pagamento_1 ... 4 | Payment method used to load the Voucher in the SAV (there can be 4 ways) | Alphanumeric | - |
| valor_pagamento_1 ... 4 | Payment amount used to load the Voucher in the SAV (can be 4 amounts) | Numeric | - |
*In case of transactions with status other than “denied”, ignore field value.
**These fields are filled in for cell top up transactions only.
*** These fields are filled in for PBM(Pharmacy benefit manager) transactions only.