Settlement Detail
The settlement summary file is a CSV that contains a row for each of the summary details so this can be processed by financial systems.
File Format
Statement Summary file is available in CSV format, other formats can be supported upon request.
⚠️ 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 |
|---|---|---|
| Brand | Alphanumeric | The Brand Name. This is the name of the brand in the TOTUS system. |
| FinancialPresentationName | Alphanumeric | The brand billing name, if brand requires an alternative name for receivables/payables processing. |
| SettlementNo | Alphanumeric. SettlementAccount-M-YYMMDD | A human readable identifier connecting settlement transactions to a summary settlement statement for a brand and period. |
| SettlementID | Alphanumeric | A unique TOTUS ID for each settlement transaction. |
| ProcessorTransactionId | Alphanumeric | A unique ID from the processor for a specific transaction. Can be different formats depending on the processor. |
| UTCTransactionDateTime | Date/Time in yyyy-MM-ddTHH:mm:ssZ format. Date/Time is UTC | Dates/Times in UTC, ISO 8601 format |
| Processor | Alphanumeric | The name of the processor. |
| SourceInfo | Alphanumeric | The Shopify site URL. This may be blank or spaces. |
| CurrencyCode | Alphanumeric | The Currency of the Settlement. 3 letter format. ISO 3166 format. |
| SKU | Alphanumeric | The SKU for the product. |
| Channel | Alphanumeric | The channel that the card was distributed into. |
| ProcessorProgram | Alphanumeric | The name or ID of the program the card was activated in. CardSet for Clutch. This may be blank or spaces. |
| ProductID | Alphanumeric | A product identifier that consists of the SKU, Form Factor and Channel. |
| FormFactor | Alphanumeric | The type of card. Values will be Digital or Physical. |
| ItemName | Alphanumeric | A human-readable name for the product. |
| TOTUSOrderId | Alphanumeric | A TOTUS generated ID to identify the order the card was in. |
| ExternalNote | Alphanumeric | A free form field that can note details about a transaction. This may be blank or spaces. |
| ExternalOrderID | Alphanumeric | An External identified for an order. This may be blank or spaces. |
| ExternalSKU | Alphanumeric | An External Merchant SKU. This may be blank or spaces. |
| ExternalUPC | Alphanumeric | An External UPC. This may be blank or spaces. |
| GiftCardId | Alphanumeric | A unique TOTUS ID for a Gift Card. For Shopify brands, this is the Shopify Gift Card ID. |
| BuyerName | Alphanumeric | The name of organization that either activated the card or facilitated the activation for the merchant. This may be blank. |
| MerchantName | Alphanumeric | The name of the organization that the card was activated for. This may be blank. |
| SettlementOrgId | Alphanumeric | A unique ID to identify the settlement organization. This may be blank. |
| SettlementOrgName | Alphanumeric | The settlement organization if different from the client name. This may be blank. |
| TransactionType | Alphanumeric | Transaction Types: New transaction types may be added in the future, please implement with this in mind. - Activation - ActivationVoid - BrandActivation - BrandActivationVoid - Redemption - RedemptionVoid |
| TransactionAmount | Decimal | The full dollar amount of the transaction. Transactions which increase card value are expressed as positive; transactions which decrease card value are expressed as negative |
| ActivationFeeRate | Alphanumeric | % of activation value. The set rate of the activation fee. |
| ActivationFeeAmount | Decimal | The amount of the activation fee charged. |
| MerchantProcessingFeeRate | Alphanumeric | Merchant processing fee % of TransactionAmount. Typically applies to 1st party Activation transactions processed through an external partner. The set rate of the merchant processing fee. |
| MerchantProcessingFeeAmount | Decimal | The amount of the merchant processing fee charged. |
| DigitalCardFulfillmentFeeAmount | Decimal | The amount of the digital fulfillment fee charged. |
| PhysicalCardFulfillmentFeeAmount | Decimal | The amount of the physical fulfillment fee charged. |
| PhysicalCardShippingFeeAmount | Decimal | The amount of the physical shipping fee charged. |
| BrandDiscountRate | Alphanumeric | The set rate of the brand discount. |
| BrandDiscountAmount | Decimal | The amount of the brand discount charged. |
| RedemptionFeeRate | Alphanumeric | Redemption fee % of TransactionAmount. The set rate of the redemption fee. |
| RedemptionFeeAmount | Decimal | The amount of the redemption fee charged. |
| NetAmount | Decimal | Net dollar value due or owed after fee amounts are applied to TransactionAmount. |
Updated 4 months ago
What’s Next