Transaction Detail
As part of the reconciliation process between you (the Brand) and TOTUS, TOTUS generates a Settlement Detail File, a CVS file containing all financial transactions processed during the settlement period. The file aligns with the Settlement Summary Statement, which summarizes the activations, redemptions and associated fees.
File Format
Statement Detail file is available in CSV format:
⚠️ Please Note
The order of the fields may change, and additional fields may be added. The names of the headers will not change, so when parsing the file, use the header names as an indicator of the field location and ignore any other unknown fields. This will ensure you are future-proofing your import so that changes will not break your imports.
Field Name | Type | Comment |
---|---|---|
ClientName | Alphanumeric | The client name. This is the name of the client in the TOTUS system. |
ClientBrand | Alphanumeric | The name of the brand for the card. This may be different from the Client's Name. |
CurrencyCode | Alphanumeric | Currency – 3 letter format. ISO 3166 format |
TransactionDateTime | Date/Time in yyyy-MM-ddTHH:mm:ssZ format. Date/Time is UTC | Dates/Times in UTC, ISO 8601 format |
SettlementId | Alphanumeric | An identifier of the settlement processed for this transaction. |
SettlementPeriodId | Alphanumeric | An identifier of the settlement job that this transaction was placed. |
TotusTransactionId | Alphanumeric | A transaction ID created by TOTUS to represent the transaction |
ProcessorTransactionId | Alphanumeric | The transaction id from the processor |
Processor | Alphanumeric | The name of the processor |
GiftCardId | Alphanumeric | The TOTUS ID for the Gift Card |
MaskedGiftCardNumber | Alphanumeric | The masked card number |
ProxyCardNumber | Alphanumeric | Left justified with trailing spaces if the card number is less than 32 char. Blank if there is no proxy number |
ProcessorGiftCardId | Alphanumeric | The processor identifier for the gift card. This may be Blank |
BuyerName | Alphanumeric | The buyer is the organization that either activated the card or facilitated the activation for the merchant. This may be blank |
MerchantName | Alphanumeric | The merchant name. This is the organization that the card was activated for. This may be blank |
MerchantId | Alphanumeric | The merchant id that identifies the merchant. This may be Blank |
MerchantTransactionId | Alphanumeric | The ID from the merchant that initiated the transaction (optional) |
SourceInfo | Alphanumeric | How the transaction was processed (POS, Manual, etc.) |
TransactionType | Alphanumeric | Transaction Type: • Activation • ActivationVoid • BrandActivation • BrandActivationVoid • Redemption • RedemptionVoid Note New transaction types may be added in the future, so please implement with this in mind. |
ActivationAmount | N 17 including a negative(-) sign if applicable, a decimal point, and four decimal positions | The amount of the Activation. This is populated based on Transaction Types of either an Activation, ActivationVoid, BrandActivation or a BrandActivationVoid. Only a BrandActivation or a BrandActivationVoid affects the Net Amount. |
RedemptionAmount | N 17 including a negative(-) sign if applicable, a decimal point, and four decimal positions | The amount of the Redemption. This is populated based on Transaction Types of either a Redemption, RedemptionVoid. |
ActivationFees | N 17 including a negative(-) sign if applicable, a decimal point, and four decimal positions | The transaction fees associated with the Activation, Brand Activation, or voids of the card. In the case of fees owed to TOTUS the amount will be negative. When fees are going back to the Client, then the fees will be positive. |
RedemptionFees | N 17 including a negative(-) sign if applicable, a decimal point, and four decimal positions | The transaction fees associated with the Redemption or RedemptionVoid of the card. In the case of fees owed to TOTUS the amount will be negative. When fees are going back to the Client, then the fees will be positive |
NetAmount | N 17 including a negative(-) sign if applicable, a decimal point, and four decimal positions | Net amount for the Transaction. When TOTUS owes to the Client, the amount will be positive. When TOTUS is owed from the Client, the amount will be negative. |
FeeDetails | Alphanumeric | Describes the transaction fee as either the amount or percentage |
ItemName | Alphanumeric | A human-readable name for the product |
OrderId | Alphanumeric | A TOTUS order ID |
SKU | Alphanumeric | The SKU for the product |
Program | Alphanumeric | The name of the program for the gift card |
Channel | Alphanumeric | The channel that the card was distributed into. |
ExternalOrderID | Alphanumeric | External Order ID if this is available at the processor or through the TOTUS API |
ExternalSKU | Alphanumeric | External Merchant SKU If there is no External Merchant SKU, this field will be blank or spaces |
ExternalUPC | Alphanumeric | If there is no External UPC, this field will be blank or spaces |
Form Factor | Alphanumeric | Physical or Digital |
IsTest | Boolean | If the transaction is a test transaction and should not result in money movement |
Transaction Types
Transaction | Definition |
---|---|
Activation | Money placed on a card. Typically, 1st Party, B2B or 3rd Party card activations. |
ActivationVoid | Money removed from an activated card. Typically, cancelled card orders or manual adjustments. |
BrandActivation | Money placed on a card by the Brand. Typically, a gift card created for merchandise return if money not put on original payment type (credit card) or a customer appeasement. |
BrandActivationVoid | Money removed from an activated card by the Brand. Typically, a cancelled return or appeasement. |
Redemption | Money removed from a card for a completed purchase. |
RedemptionVoid | Money placed back on the card for a merchandise return when the gift card was used in the original order or a manual adjustment. |
Updated 9 months ago