Response Structure
Description: This object represents the response of a transaction list.
Field Definitions:
status(integer): The HTTP status of the response.timestamp(string): The response timestamp.page(integer): The current page number.items_per_page(integer): The page size.transactions(array deTransaction): The list of transactions.
Example of reversal response#
Description: This object represents the response of a list of transactions.
Field Definitions:
status(integer): The HTTP status of the response.timestamp(string): The response timestamp.page(integer): The current page number.items_per_page(integer): The page size.transactions(array of Reversal): The list of reversed transactions.
Definition of Transaction and Reversal objects:
- Transaction object:
cod_sit(long): The transaction status code.transaction_date(string): The transaction date.nsu_sitef(string): The unique sequential number generated by Sitef.sitef_store_code(string): The store code in Sitef.trunk_store_code(string): The trunk store code.transaction_time(string): The transaction time.transaction_value(string): The transaction amount.transaction_type(string): The transaction type.response_code(string): The transaction response code.transaction_status_code(TransactionStatusCode): The transaction status code.authorization_code(string): The transaction authorization code.cupom_fiscal(string): The fiscal coupon.card_type(string): The type of card used in the transaction.transaction_info(string): Additional information about the transaction.document(string): The document associated with the transaction.installments_number(string): The number of installments in the transaction.pos_number(string): The POS number.nsu_host(string): The host NSU.nsu_host_original(string): The original host NSU.input_mode(string): The transaction input mode.establishment_code(string): The establishment code.cnpj(string): The establishment CNPJ.network_description(string): The network description.client_code(string): The client code.denied_by(string): The entity that denied the transaction.fiscal_date(string): The transaction fiscal date.fiscal_time(string): The transaction fiscal time.codcli(string): The client code.mobile_operator_code(string): The mobile operator code.store_branch_code(string): The store branch code.rebate_amount(string): The rebate amount.amount_paid_in_full(string): The amount paid in full.amount_paid_by_card(string): The amount paid by card.network_authorization_code(string): The network authorization code.export_date_time(string): The export date and time.authorization_code_aux(string): The auxiliary authorization code.nsu_host_aux(string): The auxiliary host NSU.payment_method_cd(string): The payment method code.subtype_payment_cd(string): The payment subtype code.brand_payment_cd(string): The payment brand code.psp(string): The PSP.tid(string): The TID.payment_value1(string): The first payment amount.payment_method1(string): The first payment method.payment_value2(string): The second payment amount.payment_method2(string): The second payment method.payment_value3(string): The third payment amount.payment_method3(string): The third payment method.payment_value4(string): The fourth payment amount.payment_method4(string): The fourth payment method.doc_cancel(string): The document cancelation.
Error response example:#
Description: This object represents an error response.
Field Definitions:
timestamp(string): O timestamp do erro.status(integer): O status HTTP do erro.message(string): A mensagem descrevendo o erro.