documentation
Search…
Glossary of Fields
Find the definition of the fields included in our reports
Here you see the full list of fields available in our reports. Fields are divided in the following groups for easier navigation.

General Information

Field
Description
Data Type
TransactionDate
Date in which transaction is processed [DD/MM/YYYY]
Date
TransactionTime
Time in which transaction is processed [HH:MM:SS]
Time
TransactionId
Order Id created by merchant
Defined by merchant
ShortId
PPRO short Id of the transaction
Numeric
UniqueId
PPRO unique identifier of the transaction
Alphanumeric
ReferenceId
Unique Id of the referenced transaction. For example, for a refund this field shows the Unique Id of the referenced sale
Alphanumeric
Channel
Channel Id where the transaction is processed
Alphanumeric

Compliance Data

Field
Description
Data Type
GivenName
User's given name
Alphabetic
FamilyName
User's family name
Alphabetic
CPF
User's tax id
Numeric
Email
User's email
Alphanumeric
State
State in which user starts transaction
Alphabetic
IP
User's IP address
Numeric
Website
Merchant's website
Defined by merchant
Merchant
Merchant name
Defined by merchant
ProductDescription
Merchant product description
Defined by merchant

Transaction Details

Field
Description
Data Type
PaymentMethod
Payment method that corresponds to the transaction ["CC": Credit Card; "PP": Pre-payment; "VA": Virtual Account]
Alphabetic
Brand
Applicable for cards only. Brand used for transaction
Alphabetic
PaymentType
Type of transaction. Further detailed in the table Payment Types in this section
Alphabetic
Credit
Transaction amount if in favor of merchant, e.g. a sale
Numeric
Debit
Transaction amount if in favor of customer, e.g. a refund
Numeric
Currency
Currency in which transaction is processed [ISO 4217]
Alphabetic

Additional Information

Field
Description
Data Type
WithholdingTaxes
Retention for income taxes applicable to transactions
Numeric
FinancialTaxes
Retention for taxes over financial transfers applicable to transactions
Numeric
LocalTaxes
Retention for other local taxes applicable to transactions
Numeric
VAT
Retention for Value Added Tax applicable to transactions
Numeric
TotalTaxes
Total sum of taxes
Numeric
AmountAfterTaxes
Gross amount of transaction minus taxes
Numeric
Fees
PPRO processing and installment fees
Numeric
NetPayout
Gross amount of transaction minus taxes and fees
Numeric
PayoutWOWht
Percentage of gross amount to be paid out considering deduction of withholding taxes
Numeric
PayoutWithWht
Percentage of gross amount to be paid out not considering deduction of withholding taxes
Numeric
PayoutDate
Date in which funds become available for settlement
Date

Payment Types

Payment Type
Description
Pre-authorization (PA)
Authorizes and reserves an amount. A following Capture (CP) will trigger the actual booking
Capture (CP)
Captures a pre-authorized amount (PA), the charge for the cardholder becomes effective
Debit (DB)
Pre-authorization and Capture in a single step, the charge becomes immediately effective
Reversal (RV)
Reverses an already processed Pre-authorization (PA) or Debit (DB) transaction
Refund (RF)
Credits the account of the end customer with a reference to a prior Debit (DB) transaction
Confirmation (CF)
Is automatically generated for a successful Registration (RG)
Reregistration (RR)
Changes the registered data of a Registration (RG)
Deregistration(DR)
In order to deactivate a prior registration, a deregistration transaction can be submitted to the system
Rescheduling (RS)
Reschedules a prior scheduled (recurring) job while the job is already running
Descheduling (DS)
Cancels a running (recurring) job
Receipt (RC)
Payment confirmation for Prepayment methods (e.g. Boleto Bancário and OXXO)
Rebill (RB)
Debits the account of the end customer with a reference to a prior Debit (DB) transaction
Registration (RG)
Initial registration of a customer. Later Debit (DB) transactions can always reference to a valid registration
Scheduling (SD)
Schedules upcoming payment transactions of the same type and amount (recurring)
Chargeback (CB)
A negative booking on the merchant account, which is generally triggered by the end customer or bank
Chargeback reversal (CR)
Cancels the negative booking in the merchant account and reimburses the funds to the merchant
Last modified 1yr ago