New Settlement Detail

The settlement detail report is a CSV file reporting on the fields listed below. Each gift card transaction which occurs during the settlement period is included as a record.

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	Description
Brand	Alphanumeric	The brand name in the Totus system.
FinancialPresentationName	Alphanumeric	The billing name, used only when receivables or payables processing needs a different name.
SettlementNo	Alphanumeric. SettlementAccount-M-YYMMDD	A readable ID linking settlement transactions to a settlement summary statement for a brand and period.
SettlementId	Alphanumeric	A unique Totus ID for the settlement transaction.
ProcessorTransactionId	Alphanumeric	A unique ID from the processor for the transaction. Format varies by processor.
UTCTransactionDateTime	Date/Time in yyyy-MM-ddTHH:mm:ssZ format. Date/Time is UTC	The transaction date and time, in UTC. Format: ISO 8601.
Processor	Alphanumeric	The name of the processor.
SourceInfo	Alphanumeric	This field is deprecated and will be blank going forward.
CurrencyCode	Alphanumeric	The settlement currency, in 3-letter ISO 4217 format.
Sku	Alphanumeric	This field is deprecated and will be blank going forward.
Channel	Alphanumeric	The channel that distributed the card.
ProcessorProgram	Alphanumeric	The program that activated the card, as defined by the processor. Can be blank.
ProductId	Alphanumeric	A product ID combining the SKU, form factor, and channel.
FormFactor	Alphanumeric	The card type: Digital or Physical.
ItemName	Alphanumeric	This field is deprecated and will be blank going forward.
TOTUSOrderId	Alphanumeric	The Totus ID for the order containing the card.
ExternalNote	Alphanumeric	A free-text note on the transaction. Can be blank.
ExternalOrderId	Alphanumeric	The order ID sent to the processor. The brand is responsible for providing this value. Can be blank.
ExternalSKU	Alphanumeric	This field is deprecated and will be blank going forward.
ExternalUPC	Alphanumeric	An external UPC. Can be blank.
GiftCardId	Alphanumeric	A unique Totus ID for the gift card. For Shopify brands, this is the Shopify gift card ID.
BuyerName	Alphanumeric	The organization that activated the card, or helped the merchant activate it. Can be blank.
MerchantName	Alphanumeric	The organization the card was activated for. Can be blank.
SettlementOrgId	Alphanumeric	This field is deprecated and will be blank going forward.
SettlementOrgName	Alphanumeric	This field is deprecated and will be blank going forward.
TransactionType	Alphanumeric	The parent transaction type. Values: Activation, ActivationVoid, BrandActivation, BrandActivationVoid, Redemption, RedemptionVoid.
DetailTransactionType	Alphanumeric	The granular transaction type under TransactionType. May be the same as TransactionType.
TransactionAmount	Decimal	The full dollar amount of the transaction. Positive values increase card value; negative values decrease it.
ActivationFeeRate	Alphanumeric	The activation fee rate, as a percent of the activation value.
ActivationFeeAmount	Decimal	The activation fee charged.
MerchantProcessingFeeRate	Alphanumeric	The merchant processing fee rate, as a percent of TransactionAmount.
MerchantProcessingFeeAmount	Decimal	The merchant processing fee charged.
DigitalCardFulfillmentFeeAmount	Decimal	The digital fulfillment fee charged.
PhysicalCardFulfillmentFeeAmount	Decimal	The physical fulfillment fee charged.
PhysicalCardShippingFeeAmount	Decimal	The physical shipping fee charged.
PromotionDiscountDetail	Alphanumeric	The name or rate of the promotion applied.
PromotionDiscountAmount	Decimal	The discount amount from the promotion.
BrandDiscountRate	Alphanumeric	The brand discount rate.
BrandDiscountAmount	Decimal	The brand discount charged.
RedemptionFeeRate	Alphanumeric	The redemption fee rate, as a percent of TransactionAmount.
RedemptionFeeAmount	Decimal	The redemption fee charged.
NetAmount	Decimal	The net dollar value due or owed, after fees apply to TransactionAmount.
ProcessorAccountId	Alphanumeric	The ID of the account for the transaction.
ProcessorAccountName	Alphanumeric	The name of the account for the transaction.
ProcessorLocationId	Alphanumeric	The ID of the physical store location for the transaction.
ProcessorLocationName	Alphanumeric	The name of the physical store location for the transaction.

Transaction Types

Transaction	Definition
Activation	Money added to a card. Typically a first-party, B2B, or third-party activation.
ActivationVoid	Money removed from an activated card. Typically a cancelled card order or a manual adjustment.
BrandActivation	Money added to a card by the brand. Typically issued for a merchandise return when funds are not returned to the original payment method, or for a customer appeasement.
BrandActivationVoid	Money removed from a card activated by the brand. Typically a cancelled return or appeasement.
Redemption	Money removed from a card for a completed purchase.
RedemptionVoid	Money added back to a card for a merchandise return, when the original order used a gift card, or for a manual adjustment.