Transaction Detail
The Transaction Detail report contains transactions in a monthly time frame and their associated details. This report can be sent to specified parties as requested.
File Format
The Transaction Detail file can be available in CSV or Excel file types as requested.
⚠️ 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 |
|---|---|---|
| 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 name or can be a sub-brand. |
| CurrencyCode | Alphanumeric | Currency – 3 letter format. ISO 3166 format |
| TransactionDateTimeUTC | Date/Time in yyyy-MM-ddTHH:mm:ssZ format. Date/Time is UTC. | Dates/Times in UTC. ISO 8601 format. |
| SettlementId | Alphanumeric | A unique ID for each settlement transaction. |
| SettlementPeriodId | INTEGER | An an identifier for all transactions in a specific settlement period. This will be an INTEGER (ex: 36). This may be blank. |
| ProcessorTransactionId | Alphanumeric | A unique ID from the processor for a specific transaction. Can be different formats depending on the processor. |
| Processor | Alphanumeric | The name of the processor. |
| GiftCardId | Alphanumeric | A unique TOTUS ID for a Gift Card. For Shopify brands, this is the Shopify Gift Card ID. |
| 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 is the organization that the card was activated for. This may be blank. |
| SettlementOrgName | Alphanumeric | The settlement organization if different from the client name. This may be blank. |
| SettlementOrgId | Alphanumeric | A unique ID to identify the settlement organization. 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 |
| ActivationAmount | N 17 including a negative(-) sign if applicable, a decimal point, and two 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 two decimal positions | The amount of the Redemption. This is populated based on Transaction Types of either a Redemption, RedemptionVoid. |
| ItemName | Alphanumeric | A human-readable name for the product. |
| TOTUSOrderId | Alphanumeric | A TOTUS generated ID to identify the order the card was in. |
| SKU | Alphanumeric | The SKU for the product. |
| Channel | Alphanumeric | The channel that the card was distributed into. |
| ProductId | Alphanumeric | A product identifier that consists of the SKU, Form Factor and Channel. |
| ExternalOrderId | Alphanumeric | An External Order ID. 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. |
| FormFactor | Alphanumeric | The type of card. Values will be Digital or Physical. |
| IsTest | Boolean | Indicates if the transaction is a test transaction and should not result in money movement. |
| SourceInfo | Alphanumeric | The Shopify site URL. This may be blank or spaces. |
| ExternalNote | Alphanumeric | A free form field that can note details about a transaction. This may be blank of spaces. |
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 7 months ago