Estrutura de resposta

Descrição: Este objeto representa a resposta de uma lista de transações.

{
"status": 200,
"timestamp": "18148517815",
"page": "1",
"items_per_page": "100",
"transactions": [
{
"cod_sit": 5,
"transaction_date": "2023-10-01",
"nsu_sitef": "1234567890",
"sitef_store_code": "001",
"trunk_store_code": "002",
"transaction_time": "12:34:56",
"transaction_value": "100.00",
"transaction_type": "SALE",
"response_code": "00",
"transaction_status_code": "APPROVED",
"authorization_code": "AUTH123",
"cupom_fiscal": "CF123456",
"card_type": "VISA",
"transaction_info": "Additional info",
"document": "DOC123456",
"installments_number": "1",
"pos_number": "POS001",
"nsu_host": "HOST123456",
"nsu_host_original": "HOST654321",
"input_mode": "CHIP",
"establishment_code": "EST001",
"cnpj": "12345678000195",
"network_description": "Network description",
"client_code": "CLIENT001",
"denied_by": "None",
"fiscal_date": "2023-10-01",
"fiscal_time": "12:34:56",
"codcli": "CODCLI001",
"mobile_operator_code": "MOBILE001",
"store_branch_code": "BRANCH001",
"rebate_amount": "10.00",
"amount_paid_in_full": "90.00",
"amount_paid_by_card": "100.00",
"network_authorization_code": "NETAUTH123",
"export_date_time": "2023-10-01T12:34:56",
"authorization_code_aux": "AUTH_AUX123",
"nsu_host_aux": "HOST_AUX123456",
"payment_method_cd": "PM001",
"subtype_payment_cd": "STP001",
"brand_payment_cd": "BP001",
"psp": "PSP001",
"tid": "TID123456",
"payment_value1": "50.00",
"payment_method1": "CREDIT",
"payment_value2": "30.00",
"payment_method2": "DEBIT",
"payment_value3": "20.00",
"payment_method3": "CASH",
"payment_value4": "0.00",
"payment_method4": "NONE",
"doc_cancel": "DOC_CANCEL123"
}
]
}

Definição dos Campos:

  • status (integer): O status HTTP da resposta.
  • timestamp (string): O timestamp da resposta.
  • page (integer): O número da página atual.
  • items_per_page (integer): O tamanho da página.
  • transactions (array de Transaction): A lista de transações.

Exemplo de resposta de estornos#

Descrição: Este objeto representa a resposta de uma lista de transações.

{
"status": 200,
"timestamp": "18148517815",
"page": "1",
"items_per_page": "100",
"transactions": [
{
"reversal": {
"cod_sit": 5,
"transaction_date": "20231001",
"nsu_sitef": "123456",
"sitef_store_code": "00000001",
"trunk_store_code": "00000001",
"transaction_time": "123456",
"transaction_value": "10000",
"transaction_type": "SALE",
"response_code": "00",
"transaction_status_code": "APPROVED",
"authorization_code": "AUTH123",
"cupom_fiscal": "CF123456",
"card_type": "VISA",
"transaction_info": "Additional info",
"document": "DOC123456",
"installments_number": "1",
"pos_number": "POS001",
"nsu_host": "HOST123456",
"nsu_host_original": "HOST654321",
"input_mode": "CHIP",
"establishment_code": "EST001",
"cnpj": "12345678000195",
"network_description": "Network description",
"client_code": "CLIENT001",
"denied_by": "None",
"fiscal_date": "20231001",
"fiscal_time": "123456",
"codcli": "CODCLI001",
"mobile_operator_code": "MOBILE001",
"store_branch_code": "BRANCH001",
"rebate_amount": "1000",
"amount_paid_in_full": "9000",
"amount_paid_by_card": "10000",
"network_authorization_code": "NETAUTH123",
"export_date_time": "20231001T123400",
"authorization_code_aux": "AUTH_AUX123",
"nsu_host_aux": "HOST_AUX123456",
"payment_method_cd": "PM001",
"subtype_payment_cd": "STP001",
"brand_payment_cd": "BP001",
"psp": "PSP001",
"tid": "TID123456",
"payment_value1": "5000",
"payment_method1": "CREDIT",
"payment_value2": "3000",
"payment_method2": "DEBIT",
"payment_value3": "2000",
"payment_method3": "CASH",
"payment_value4": "000",
"payment_method4": "NONE",
"doc_cancel": "DOC_CANCEL123"
},
"reversed": {
"cod_sit": 5,
"transaction_date": "20231001",
"nsu_sitef": "123457",
"sitef_store_code": "00000001",
"trunk_store_code": "00000001",
"transaction_time": "123456",
"transaction_value": "10000",
"transaction_type": "SALE",
"response_code": "00",
"transaction_status_code": "APPROVED",
"authorization_code": "AUTH123",
"cupom_fiscal": "CF123456",
"card_type": "VISA",
"transaction_info": "Additional info",
"document": "DOC123456",
"installments_number": "1",
"pos_number": "POS001",
"nsu_host": "HOST123456",
"nsu_host_original": "HOST654321",
"input_mode": "CHIP",
"establishment_code": "EST001",
"cnpj": "12345678000195",
"network_description": "Network description",
"client_code": "CLIENT001",
"denied_by": "None",
"fiscal_date": "20231001",
"fiscal_time": "123456",
"codcli": "CODCLI001",
"mobile_operator_code": "MOBILE001",
"store_branch_code": "BRANCH001",
"rebate_amount": "10.00",
"amount_paid_in_full": "9000",
"amount_paid_by_card": "10000",
"network_authorization_code": "NETAUTH123",
"export_date_time": "20231001123456",
"authorization_code_aux": "AUTH_AUX123",
"nsu_host_aux": "HOST_AUX123456",
"payment_method_cd": "PM001",
"subtype_payment_cd": "STP001",
"brand_payment_cd": "BP001",
"psp": "PSP001",
"tid": "TID123456",
"payment_value1": "5000",
"payment_method1": "CREDIT",
"payment_value2": "3000",
"payment_method2": "DEBIT",
"payment_value3": "2000",
"payment_method3": "CASH",
"payment_value4": "000",
"payment_method4": "NONE",
"doc_cancel": "DOC_CANCEL123"
}
}
]
}

Definição dos Campos:

  • status (integer): O status HTTP da resposta.
  • timestamp (string): O timestamp da resposta.
  • page (integer): O número da página atual.
  • items_per_page (integer): O tamanho da página.
  • transactions (array de Reversal): A lista de transações estornadas.

Definição dos objetos Transaction e Reversal:#

  1. Objeto transaction:
  • cod_sit (long): O código de status da transação.
  • transaction_date (string): A data da transação.
  • nsu_sitef (string): O número sequencial único gerado pelo Sitef.
  • sitef_store_code (string): O código da loja no Sitef.
  • trunk_store_code (string): O código da loja tronco.
  • transaction_time (string): A hora da transação.
  • transaction_value (string): O valor da transação.
  • transaction_type (string): O tipo da transação.
  • response_code (string): O código de resposta da transação.
  • transaction_status_code (TransactionStatusCode): O código de status da transação.
  • authorization_code (string): O código de autorização da transação.
  • cupom_fiscal (string): O cupom fiscal.
  • card_type (string): O tipo de cartão usado na transação.
  • transaction_info (string): Informações adicionais sobre a transação.
  • document (string): O documento associado à transação.
  • installments_number (string): O número de parcelas da transação.
  • pos_number (string): O número do POS.
  • nsu_host (string): O NSU do host.
  • nsu_host_original (string): O NSU original do host.
  • input_mode (string): O modo de entrada da transação.
  • establishment_code (string): O código do estabelecimento.
  • cnpj (string): O CNPJ do estabelecimento.
  • network_description (string): A descrição da rede.
  • client_code (string): O código do cliente.
  • denied_by (string): A entidade que negou a transação.
  • fiscal_date (string): A data fiscal da transação.
  • fiscal_time (string): A hora fiscal da transação.
  • codcli (string): O código do cliente.
  • mobile_operator_code (string): O código da operadora móvel.
  • store_branch_code (string): O código da filial da loja.
  • rebate_amount (string): O valor do reembolso.
  • amount_paid_in_full (string): O valor pago integralmente.
  • amount_paid_by_card (string): O valor pago com cartão.
  • network_authorization_code (string): O código de autorização da rede.
  • export_date_time (string): A data e hora de exportação.
  • authorization_code_aux (string): O código de autorização auxiliar.
  • nsu_host_aux (string): O NSU auxiliar do host.
  • payment_method_cd (string): O código do método de pagamento.
  • subtype_payment_cd (string): O código do subtipo de pagamento.
  • brand_payment_cd (string): O código da marca de pagamento.
  • psp (string): O PSP.
  • tid (string): O TID.
  • payment_value1 (string): O valor do primeiro pagamento.
  • payment_method1 (string): O primeiro método de pagamento.
  • payment_value2 (string): O valor do segundo pagamento.
  • payment_method2 (string): O segundo método de pagamento.
  • payment_value3 (string): O valor do terceiro pagamento.
  • payment_method3 (string): O terceiro método de pagamento.
  • payment_value4 (string): O valor do quarto pagamento.
  • payment_method4 (string): O quarto método de pagamento.
  • doc_cancel (string): O cancelamento do documento.

Exemplo de resposta de erro:#

Descrição: Este objeto representa a resposta de um erro.

{
"timestamp": "18148517815",
"status": 400,
"message": "Invalid request parameters"
}

Definição dos Campos:

  • timestamp (string): O timestamp do erro.
  • status (integer): O status HTTP do erro.
  • message (string): A mensagem descrevendo o erro.