Field Schema Reference

The field-by-field schema for all eleven FlexFactor CSV reports, with reconciliation notes and workflows.

The field-by-field schema for all eleven FlexFactor CSV reports. Each report lists every column with its data type, business meaning, a sample value, and a reconciliation note, followed by the calculation formulas and the reconciliation workflow for that report. For a fast overview, use the Report Catalog; for shared data types and enumerations, see Data Formats & Enumerations.

Each field is documented with:

  • Field Name — the exact CSV column header.
  • Data Type — format and validation rules (see Data Formats & Enumerations for patterns).
  • Description — business meaning and usage.
  • Sample Value — an illustrative example. All sample values are fictitious.
  • Reconciliation Notes — how to use the field when matching against your own systems.

Amounts are fixed-decimal strings with two places; negative values indicate reductions (refunds, fees, chargebacks, reserve holds). Timestamps are ISO 8601 UTC.


Report 1: Activity Detail

Report name: activity-detail
Use case: transaction-level detail for all merchant activity
Reconciliation use: match individual transactions against your order systems

#Field NameData TypeDescriptionSample ValueReconciliation Notes
1PidUUIDPartner unique identifiera1b2c3d4-...Group all merchants under your partner account
2MidUUIDMerchant unique identifiere5f6a7b8-...Filter transactions by specific merchant
3ExternalMerchantIdentifierStringYour merchant account / reference number; - if not configuredMERCH-001, -Match to your merchant master file
4OrderIdUUIDFlexFactor internal order ID9c8d7e6f-...Unique key for each transaction
5ExternalIdStringYour order reference numberORD-2024-001Match to your order management system
6TransactionTypeEnumTransaction categoryOrder, ReturnSeparate sales from refunds in reconciliation
7EventTimestampDateTime (UTC)When the transaction occurred07/28/2026 14:30:45MM/DD/YYYY HH:MM:SS, UTC despite no timezone suffix — see format note below
8CurrencyString (ISO 4217)Transaction currencyUSDEnsure currency matching in multi-currency systems
9AmountDecimal (String)Transaction amount150.77, 45.7, 100Negative for returns; trailing zeros may be omitted
10OrderStateEnumCurrent order statuscompleted, voidedFilter completed transactions for revenue recognition
11BinString (6–8 digits)First 6–8 digits of card42424242, N/ACard-network identification; PCI-compliant partial data
12Last4String (4 digits)Last 4 digits of card1111, N/ACustomer payment-method verification
13PaymentInstrumentTypeStringPayment instrument typeCredit CardPayment-method classification
14PaymentInstrumentSubtypeStringCard brandVisa, MastercardCard-brand mix and fee analysis

Total columns: 14

🚧

Format exceptions in this report. EventTimestamp uses MM/DD/YYYY HH:MM:SS (values are UTC even though no timezone suffix is present) rather than ISO 8601, and amounts may omit trailing zeros (100, 45.7) rather than always carrying two decimal places. Parse both accordingly.

📘

Population: activity-detail carries processed transactions only (sales, returns, voids). Declined and failed authorization attempts never appear in this or any other report.

Reconciliation workflow

  1. Import the CSV and parse EventTimestamp into your reporting timezone.
  2. Join on ExternalId to match your orders.
  3. Sum Amount where OrderState = 'completed' for revenue.
  4. Sum Amount where TransactionType = 'Return' for refunds.
  5. Verify card data (Bin / Last4) matches expected payment methods.

Report 2: Activity Summary

Report name: activity-summary
Use case: aggregated activity metrics by merchant for performance analysis
Reconciliation use: high-level revenue and fee verification by merchant and period

#Field NameData TypeDescriptionSample ValueReconciliation Notes
1PidUUIDPartner unique identifiera1b2c3d4-...Partner-level aggregation key
2MidUUIDMerchant unique identifiere5f6a7b8-...Merchant-level aggregation key
3ExternalMerchantIdentifierStringYour merchant account numberMERCH-001Match to merchant master data
4FromDateTime (UTC)Reporting period start2026-07-01T00:00:00ZPeriod boundary (inclusive)
5ToDateTime (UTC)Reporting period end2026-07-31T23:59:59ZPeriod boundary (inclusive)
6TotalProcessedAmountDecimal (String)Gross transaction volume50000.00Total sales before fees/exceptions
7ProcessingFeesDecimal (String)Total fees charged1250.50Fee expense for the period
8NetAmountDecimal (String)Net after fees48749.50TotalProcessedAmount - ProcessingFees
9MerchantStringMerchant DBA nameAcme Store Inc.Human-readable merchant name
10CurrencyString (ISO 4217)Transaction currencyUSDCurrency for all amounts
11CurrencyCodeString (ISO 4217)Transaction currency (duplicate)USDLegacy field; same as Currency
12ReturnsAmountDecimal (String)Total refunds/returns500.00Negative impact on revenue
13ChargebacksAmountDecimal (String)Total chargebacks150.00Dispute-related reductions
14OrderCountIntegerNumber of orders324Transaction-volume metric

Total columns: 14

Formula

Expected Net Revenue = TotalProcessedAmount - ProcessingFees - ReturnsAmount - ChargebacksAmount
📘

TotalProcessedAmount sums completed orders only — refunds sit in ReturnsAmount, not netted into the gross. All reduction columns (ProcessingFees, ReturnsAmount, ChargebacksAmount) are positive magnitudes; subtract them as shown.

Reconciliation workflow

  1. Verify From and To match your reporting period.
  2. Compare TotalProcessedAmount to your sales ledger.
  3. Verify ProcessingFees match fee invoices.
  4. Reconcile NetAmount to expected deposits.
  5. Cross-check OrderCount with transaction logs.

Report 3: Activity Exceptions

Report name: activity-exceptions
Use case: track refunds, chargebacks, voids, and credits
Reconciliation use: exception tracking and dispute management

#Field NameData TypeDescriptionSample ValueReconciliation Notes
1PidUUIDPartner unique identifiera1b2c3d4-...Partner context
2MidUUIDMerchant unique identifiere5f6a7b8-...Merchant context
3ExternalMerchantIdentifierStringYour merchant account numberMERCH-001Merchant matching key
4OrderIdUUIDFlexFactor internal order ID9c8d7e6f-...Link to the original transaction
5ExternalIdStringYour order referenceORD-2024-001Link to your order system
6EventTimestampDateTime (UTC)When the exception occurred2026-07-22T16:45:00ZException event date/time
7CurrencyString (ISO 4217)Transaction currencyUSDCurrency context
8AmountDecimal (String)Exception amount75.00Value of the exception
9OrderStateEnumCurrent order statusrefunded, voidedCurrent state after the exception
10ExceptionTypeEnumType of exceptionrefunded, disputed, voidedException category
11ExceptionReasonStringReason / descriptionCustomer requested refundBusiness reason for the exception
12BinString (6 digits)First 6 digits of card424242, N/ACard identification
13Last4String (4 digits)Last 4 digits of card4242, N/ACard verification

Total columns: 13

Exception types

  • refunded — customer refund processed (including RDR auto-refunds — an RDR appears here as a refund and in dispute-detail as a Kind = RDR row; count the financial impact once, from this report)
  • disputed — chargeback or dispute filed
  • voided — transaction cancelled before settlement

Reconciliation workflow

  1. Match ExternalId to original orders.
  2. Verify Amount matches refund/chargeback records.
  3. Classify by ExceptionType for accounting entries.
  4. Update order status based on OrderState.
  5. Review ExceptionReason for pattern analysis.

Report 4: Settlement Summary

Report name: settlement-summary
Use case: settlement-batch summaries for payout reconciliation
Reconciliation use: match settlement batches to bank deposits

#Field NameData TypeDescriptionSample ValueReconciliation Notes
1PidUUIDPartner unique identifiera1b2c3d4-...Partner context
2MidUUIDMerchant unique identifiere5f6a7b8-...Merchant receiving settlement
3CEDStringFlexFactor settlement tracking referenceCED-202607-001Settlement tracking ID
4TxnIdStringTransaction ID from batchTXN-ABC123Settlement-batch identifier
5SettlementDateDateTime (UTC)When settlement processed2026-07-22T09:00:00ZSettlement execution date
6FromDateTime (UTC)Batch period start2026-07-21T00:00:00ZTransactions included from this date
7ToDateTime (UTC)Batch period end2026-07-21T23:59:59ZTransactions included through this date
8TotalProcessedAmountDecimal (String)Gross batch amount10000.00Total transactions in the batch
9ProcessingFeesDecimal (String)Fees deducted250.00Platform fees for this batch
10SettlementAmountDecimal (String)Net settlement9750.00Amount sent to the merchant
11MerchantStringMerchant DBA nameAcme Store Inc.Merchant display name
12ExternalMerchantIdentifierStringYour merchant accountMERCH-001Merchant matching key
13CurrencyString (ISO 4217)Settlement currencyUSDCurrency for all amounts
14CurrencyCodeIntegerNumeric currency code840ISO 4217 numeric code for USD
15ReturnsAmountDecimal (String)Returns in batch200.00Refunds included
16ChargebacksAmountDecimal (String)Chargebacks in batch50.00Disputes included
17ReserveAmountDecimal (String)Amount held in reserve1000.00Reserve balance held
18ReserveReleaseAmountDecimal (String)Reserve funds released500.00Reserve released this batch
19ReserveUtilizationAmountDecimal (String)Reserve applied50.00Reserve applied to losses other than this batch's own chargebacks
20AdjustmentsDecimal (String)Manual adjustments0.00FlexFactor sends a notification explaining any non-zero adjustment
21BatchIdUUIDSettlement-batch unique IDb1a2c3d4-...Batch tracking identifier
22SenderIdUUID (nullable)Sender financial account IDs1s2s3s4-... or blankSource account (may be null)
23ReceiverIdUUID (nullable)Receiver financial account IDr1r2r3r4-... or blankDestination account (may be null)

Total columns: 23

📘

All reduction columns are positive magnitudes — subtract them per the formula. ReserveUtilizationAmount covers losses other than this batch's own chargebacks (already in ChargebacksAmount), so both appearing in one batch is not double-counting.

Formula

SettlementAmount = TotalProcessedAmount
                   - ProcessingFees
                   - ReturnsAmount
                   - ChargebacksAmount
                   - ReserveAmount
                   + ReserveReleaseAmount
                   - ReserveUtilizationAmount
                   + Adjustments

Reconciliation workflow

  1. Match SettlementDate to the bank-deposit date.
  2. Verify SettlementAmount matches the bank deposit.
  3. Reconcile BatchId or CED with internal settlement records.
  4. Review reserve changes (ReserveAmount, ReserveReleaseAmount, ReserveUtilizationAmount).
  5. Account for Adjustments separately.

Report 5: Settlement Detail

Report name: settlement-detail
Use case: transaction-level detail within settlements
Reconciliation use: detailed breakdown of what is included in each settlement

#Field NameData TypeDescriptionSample ValueReconciliation Notes
1PidUUIDPartner unique identifiera1b2c3d4-...Partner context
2MidUUIDMerchant unique identifiere5f6a7b8-...Merchant receiving settlement
3ExternalMerchantIdentifierStringYour merchant accountMERCH-001Merchant matching key
4OrderIdUUIDFlexFactor internal order ID9c8d7e6f-...Transaction identifier
5ExternalIdStringYour order referenceORD-2024-001Link to your order system
6TransactionTypeEnumTransaction categoryOrder, ReturnDistinguish sales from refunds
7EventTimestampDateTime (UTC)Transaction date/time2026-07-22T14:30:45ZWhen the transaction occurred
8CurrencyString (ISO 4217)Transaction currencyUSDCurrency context
9ConsumerAmountDecimal (String)Amount charged to the consumer100.00, -25.00Customer-facing amount; negative for returns
10ConsumerFeeDecimal (String)Fee charged to the consumer0.00Reserved for future use — always 0.00 today
11FlexFactorFeeDecimal (String)Platform fee retained2.50Fee deducted from settlement
12DepositAmountDecimal (String)Net deposited to the merchant97.50Amount you receive for this transaction
13OrderStateEnumCurrent order statuscompleted, voidedOrder status
14BinString (6 digits)First 6 digits of card424242, N/ACard identification
15Last4String (4 digits)Last 4 digits of card4242, N/ACard verification

Total columns: 15

Formula

DepositAmount = ConsumerAmount - ConsumerFee - FlexFactorFee

For returns, ConsumerAmount is negative, so DepositAmount is also negative.

Reconciliation workflow

  1. Group by settlement batch (join with Settlement Summary if needed).
  2. Sum DepositAmount to verify the batch total.
  3. Match ExternalId to your order records.
  4. Verify FlexFactorFee matches your fee agreement.
  5. Account for returns separately (negative ConsumerAmount).

Report 6: Settlement Exceptions

Report name: settlement-exceptions
Use case: track failed or rejected settlement batches
Reconciliation use: identify and resolve settlement failures

#Field NameData TypeDescriptionSample ValueReconciliation Notes
1PidUUIDPartner unique identifiera1b2c3d4-...Partner context
2MidUUIDMerchant unique identifiere5f6a7b8-...Affected merchant
3ExternalMerchantIdentifierStringYour merchant accountMERCH-001Merchant matching key
4BatchIdUUIDFailed batch identifierb1a2c3d4-...Settlement batch that failed
5SettlementDateDateTime (UTC)When the failure occurred2026-07-22T09:00:00ZFailure timestamp
6CurrencyString (ISO 4217)Batch currencyUSDCurrency context
7BatchAmountDecimal (String)Failed batch amount10000.00Amount that was not settled
8ExceptionTypeEnumType of failureFAILED, ERROR, REJECTEDFailure classification
9ExceptionReasonStringFailure descriptionInvalid bank accountDetailed failure reason
10PayoutStatusEnumCurrent payout statusFAILED, PENDINGCurrent state of the payout

Total columns: 10

Exception types

  • FAILED — settlement-batch processing failed
  • ERROR — system error during settlement
  • REJECTED — settlement rejected by the bank/processor

Reconciliation workflow

  1. Identify missing settlements by comparing expected vs. actual deposits.
  2. Match BatchId to expected settlement batches.
  3. Review ExceptionReason to determine remediation.
  4. Track resolution of failed settlements.
  5. Re-reconcile once failures are resolved.
📘

Retries keep the same BatchId. When a failed batch is retried and succeeds, the same BatchId appears in settlement-summary with the payout completed — match on BatchId and there is no double-count risk.


Report 7: Fees

Report name: fees
Use case: detailed fee breakdown per transaction
Reconciliation use: fee expense accounting and verification

#Field NameData TypeDescriptionSample ValueReconciliation Notes
1PidUUIDPartner unique identifiera1b2c3d4-...Partner context
2MidUUIDMerchant unique identifiere5f6a7b8-...Merchant incurring the fee
3ExternalMerchantIdentifierStringYour merchant accountMERCH-001Merchant matching key
4OrderIdUUIDFlexFactor internal order ID9c8d7e6f-...Associated transaction
5ExternalIdStringYour order referenceORD-2024-001Link to your order
6EventTimestampDateTime (UTC)When the fee was recorded2026-07-22T14:30:45ZFee recording date/time
7CurrencyString (ISO 4217)Fee currencyUSDCurrency context
8FeeTypeEnumCategory of feeFlexFee, FlexReturnFee, FlexChargebackFeeFee classification
9FeeAmountDecimal (String)Fee charged2.50, 1.00Fee amount
10OrderAmountDecimal (String)Original order amount100.00Transaction amount the fee is based on

Total columns: 10

Fee types

  • FlexFee — standard processing fee (charged on orders)
  • FlexReturnFee — fee for processing a refund/return (including RDR auto-refunds)
  • FlexChargebackFee — fee for processing a chargeback/dispute
📘

This report is the fee statement of record. Fees are net-settled — deducted from payouts, never invoiced separately — and these three types cover all fee expense. The finer fee labels in the disbursement-fee report (Processing Fee, Refund Fee, Dispute Fee, ...) are subtypes of the same fees, not additional charges.

Reconciliation workflow

  1. Sum FeeAmount by FeeType for expense classification.
  2. Verify total fees match settlement deductions.
  3. Calculate the effective fee rate: FeeAmount / OrderAmount.
  4. Match ExternalId to transaction records.
  5. Reconcile with fee invoices or agreements.

Report 8: Monthly Settlement Summary

Report name: monthly-settlement-summary
Use case: monthly aggregated settlement overview
Reconciliation use: monthly financial close and performance analysis

#Field NameData TypeDescriptionSample ValueReconciliation Notes
1PidUUIDPartner unique identifiera1b2c3d4-...Partner context
2MidUUIDMerchant unique identifiere5f6a7b8-...Merchant summary
3ExternalMerchantIdentifierStringYour merchant accountMERCH-001Merchant matching key
4MonthStringMonth nameJanuary, JulyHuman-readable month
5YearIntegerCalendar year2026Year of settlement
6TotalSettledAmountDecimal (String)Gross settled amount150000.00Total settled before fees
7TotalFeesDecimal (String)Total fees deducted3750.00Monthly fee expense
8NetSettlementDecimal (String)Net amount settled146250.00Amount deposited to the merchant
9BatchCountIntegerNumber of batches20Settlement-batch count
10OrderCountIntegerTotal orders settled1500Transaction count
11CurrencyString (ISO 4217)Settlement currencyUSDCurrency context

Total columns: 11

Formula

NetSettlement = TotalSettledAmount - TotalFees

Reconciliation workflow

  1. Verify Month / Year match your accounting period. The month boundary is the UTC calendar month — if your ledger runs on a local timezone or a non-calendar fiscal period, account for the offset.
  2. Sum all daily settlements and compare with TotalSettledAmount.
  3. Verify NetSettlement matches total monthly deposits.
  4. Compare OrderCount with transaction logs.
  5. Use for monthly financial reporting and variance analysis.

Report 9: Monthly Settlement Detail

Report name: monthly-settlement-detail
Use case: detailed monthly settlement with batch-level breakdown
Reconciliation use: monthly settlement audit and batch-by-batch verification

This report is structurally identical to Settlement Summary (23 fields) but filtered to a specific month, and it supports month-to-date reporting.

#Field NameData TypeDescriptionSample ValueReconciliation Notes
1PidUUIDPartner unique identifiera1b2c3d4-...Partner context
2MidUUIDMerchant unique identifiere5f6a7b8-...Merchant receiving settlement
3CEDStringFlexFactor settlement tracking referenceCED-202607-001Settlement tracking ID
4TxnIdStringTransaction ID from batchTXN-ABC123Settlement-batch identifier
5SettlementDateDateTime (UTC)When settlement processed2026-07-22T09:00:00ZSettlement execution date
6FromDateTime (UTC)Batch period start2026-07-21T00:00:00ZTransactions included from
7ToDateTime (UTC)Batch period end2026-07-21T23:59:59ZTransactions included through
8TotalProcessedAmountDecimal (String)Gross batch amount10000.00Total transactions in the batch
9ProcessingFeesDecimal (String)Fees deducted250.00Platform fees for the batch
10SettlementAmountDecimal (String)Net settlement9750.00Amount sent to the merchant
11MerchantStringMerchant DBA nameAcme Store Inc.Merchant display name
12ExternalMerchantIdentifierStringYour merchant accountMERCH-001Merchant matching key
13CurrencyString (ISO 4217)Settlement currencyUSDCurrency for all amounts
14CurrencyCodeIntegerNumeric currency code840ISO 4217 numeric (840 = USD)
15ReturnsAmountDecimal (String)Returns in batch200.00Refunds included
16ChargebacksAmountDecimal (String)Chargebacks in batch50.00Disputes included
17ReserveAmountDecimal (String)Amount held in reserve1000.00Reserve balance held
18ReserveReleaseAmountDecimal (String)Reserve funds released500.00Reserve released this batch
19ReserveUtilizationAmountDecimal (String)Reserve applied50.00Reserve used to cover losses
20AdjustmentsDecimal (String)Manual adjustments0.00Manual corrections applied
21BatchIdUUIDSettlement-batch unique IDb1a2c3d4-...Batch tracking identifier
22SenderIdUUID (nullable)Sender financial account IDs1s2s3s4-... or blankSource account (may be null)
23ReceiverIdUUID (nullable)Receiver financial account IDr1r2r3r4-... or blankDestination account (may be null)

Total columns: 23

Reconciliation workflow

  1. Filter by Month (implicit in report generation).
  2. Sum SettlementAmount to verify the monthly total.
  3. Match individual batches to bank deposits.
  4. Track month-to-date progress if the report is run mid-month.
  5. Cross-reference with Monthly Settlement Summary totals.

Report 10: Dispute Detail

Report name: dispute-detail
Use case: chargeback and dispute tracking
Reconciliation use: dispute liability and resolution tracking
Format: multi-section CSV, Braintree-compatible

Each row begins with a record-type prefix identifying its section:

  • RH — report header (metadata about the report)
  • RD — report detail (individual dispute records)
  • RF — report footer (record counts)

The prefix is a section identifier, not a counted field; the field counts below exclude it. Total documented fields: 53 (RH 4 + RD 46 + RF 3).

📘

Braintree-compatible. This report mirrors the Braintree Dispute Detail export. Many RD columns exist for format compatibility only and are not populated by FlexFactor — they are marked "not tracked; always empty" below. Because the Outcome, Status, and Amount Won columns are always empty, dispute win/loss resolution cannot be read from this report; track it in your own dispute system.

📘

Each section begins with a header row. The first row for each prefix carries the section's column names, followed by the data rows — skip the header rows when loading data. Two RD header names contain a double space — Postalcode Response Code and Chargeback Protection — so match headers exactly rather than assuming single spacing.

🚧

PII note. Unlike the flat CSV reports, the RD section carries customer PII — Customer Name and Customer Email. The card number is fully masked (****); no full PAN, CVV, or expiry is present. Handle this report as containing customer PII even though it stays outside PCI cardholder-data scope. Sample values below are fictitious.

Section RH — Report Header

#Field NameData TypeDescriptionSample Value
1Report nameStringReport title (fixed)Dispute Detail Report
2Report statusStringGeneration status (fixed)Success
3Report Date and TimestampDateTime (UTC)When the report was generated2026-07-22T15:30:00Z
4HierarchyUUIDPartner ID (from the report parameter)a1b2c3d4-...

Total RH fields: 4

Section RD — Report Detail (dispute records)

46 fields per dispute record. Fields marked "not tracked; always empty" are present for Braintree format compatibility but are not populated by FlexFactor.

#Field NameData TypeDescriptionSample Value
1Merchant Account IDStringExternal merchant ID; may be blankMERCH-001 or (empty)
2Dispute IDUUIDDispute identifierd1e2f3a4-...
3Original Dispute IDStringOriginal dispute reference(empty; not tracked)
4Received DateDateDate the dispute was received2026-07-20
5Effective DateDateDispute effective date (same as Received Date)2026-07-20
6Updated Date and TimestampDateTime (UTC)Last-modified timestamp2026-07-22T10:15:30Z
7Dispute AmountDecimal (String)Disputed amount125.50
8Dispute Amount CurrencyString (ISO 4217)Dispute currencyUSD
9OutcomeStringDispute outcome(empty; not tracked)
10Amount WonStringAmount won by the merchant(empty; not tracked)
11KindStringDispute stage / kindCHARGEBACK — see Kind values below
12ReasonStringDispute reason — the card-network reason code104, 4837
13StatusStringDispute status(empty; not tracked)
14Dispute Case NumberStringProcessor case numberCB-2026-001
15Reply Before DateDateDeadline to respond2026-08-05 or (empty)
16Disputed dateDateDate disputed (same as Received Date)2026-07-20
17Transaction Date and TimestampDateTime (UTC)Original transaction time2026-06-15T14:30:00Z
18Presentment AmountDecimal (String)Original transaction amount125.50
19Presentment CurrencyString (ISO 4217)Original currencyUSD
20Record IDUUIDAssociated transaction IDt1r2a3n4-...
21Order IDStringYour order referenceORD-2024-001 or (empty)
22Settlement AmountStringSettled amount(empty; not tracked)
23Settlement CurrencyStringSettlement currency(empty; not tracked)
24RefundedString (Boolean)Whether the transaction was refundedTRUE or FALSE
25Customer IDStringCustomer identifier(empty; not tracked)
26Customer NameStringCustomer full name (first + last) — PIIJane Roe
27Customer EmailStringCustomer email — PII[email protected] or (empty)
28Credit Card NumberStringMasked card number — fully masked in current exports****
29Card TypeStringCard brandVISA
30Postalcode Response CodeStringAVS postal-code response(empty; not tracked)
31Street Address Response CodeStringAVS street-address response(empty; not tracked)
32AVS response textStringAVS full response(empty; not tracked)
33CVV Response codeStringCVV verification code(empty; not tracked)
34CVV response textStringCVV verification text(empty; not tracked)
35Fraud detectedStringEarly fraud warningTRUE if an early fraud warning exists; (empty) otherwise
36Payment Instrument TypeStringPayment instrument type, processor-suppliedcredit, debit, prepaid
37Payment Instrument SubtypeStringPayment subtype(empty; not tracked)
38Paypal Payer EmailStringPayPal email(empty; not tracked)
39Payment Method TokenStringPayment token(empty; not tracked)
40Chargeback ProtectionStringProtection coverage(empty; not tracked)
41Reason CodeStringNetwork reason code(empty; not tracked)
42Reason Code DescriptionStringReason-code text(empty; not tracked)
43Acquirer Reference NumberStringARN12345678901234567890 or (empty)
443D Secure Liability ShiftedString3DS liability shift(empty; not tracked)
45Transaction Created AtDateTime (UTC)Transaction created time2026-06-15T14:25:30Z
46Disbursement DateDateDisbursement date(empty in current exports)

Total RD fields: 46

Kind field values (RD field 11)

The Kind field carries the dispute stage. Ten values are defined:

ValueDescriptionStage
RDRRapid Dispute ResolutionPre-dispute automated refund
CHARGEBACKChargebackStandard chargeback dispute
PRE-DISPUTEPre-Dispute WarningPre-chargeback warning stage — funds move at this stage: the disputed amount and the dispute fee are debited when the pre-dispute is received, not later at the chargeback stage
REVERSEDReversedChargeback reversed / won — the returned funds post as a credit in the settlement batch covering the reversal date
EARLY_WARNINGEarly WarningEarly fraud-warning alert
DISPUTE_NOTICEDispute NoticeDispute notice received (TC 15)
FRAUD_NOTICEFraud NoticeFraud notice received (TC 40)
UNMAPPEDUnmappedUnknown / unmapped dispute type
ORDER_INSIGHTOrder InsightVisa Order Insight inquiry
CONSUMER_CLARITYConsumer ClarityMastercard Consumer Clarity

Section RF — Report Footer

#Field NameData TypeDescriptionSample Value
1File numberStringFile sequence number1 (always)
2Total RecordsStringNumber of RD rows15
3Total FilesStringNumber of files1 (always)

Total RF fields: 3

Reconciliation workflow

  1. Parse the multi-section format by line prefix (RH, RD, RF).
  2. Verify RF Total Records matches the actual RD row count.
  3. Match Dispute ID, Record ID (transaction), or Order ID to your systems.
  4. Group by Kind to separate dispute stages (RDR vs. chargeback vs. pre-dispute warnings vs. network inquiries such as Order Insight and Consumer Clarity).
  5. Monitor Reply Before Date for time-sensitive responses.
  6. Track win/loss in your own dispute system — the report Outcome, Status, and Amount Won columns are always empty.
  7. Cross-reference with the activity-exceptions report for financial impact.

Report 11: Disbursement Fee

Report name: disbursement-fee
Use case: Braintree-compatible disbursement and fee detail
Reconciliation use: comprehensive settlement and fee reconciliation
Format: multi-section CSV, Braintree-compatible

  • RH — report header (report metadata)
  • RS — report summary (merchant-level aggregation)
  • RD — report detail (transaction-level detail)
  • RF — report footer (record counts)

The prefix is a section identifier, not a counted field; the field counts below exclude it. Total documented fields: 81 (RH 4 + RS 14 + RD 60 + RF 3).

📘

Braintree-compatible. This report mirrors the Braintree disbursement/fee export.

📘

Each section begins with a header row. The first row for each prefix carries the section's column names (e.g. RD,Record ID,Merchant Account ID,...) followed by the data rows. Skip the header rows when loading data — see the layout example in Data Formats & Enumerations.

Section RH — Report Header

#Field NameData TypeDescriptionSample Value
1Report nameStringReport title (fixed)Disbursement and Fees
2Report statusStringGeneration status (fixed)Success
3Report date and timestampDateTime (UTC)When the report was generated2026-07-29T13:44:17Z
4HierarchyUUIDPartner ID (from the report parameter)a1b2c3d4-...

Total RH fields: 4

Section RS — Report Summary (merchant aggregation)

#Field NameData TypeDescriptionSample ValueReconciliation Notes
1Merchant Account IDStringMerchant account identifier; may be blankMERCH-001 or (empty)Match to ExternalMerchantIdentifier
2Transfer ID(s)StringAssociated bank transfer IDs (comma-separated if multiple)AB12CD34Link to bank transfers; RD rows reference the same value in Transfer ID
3Bank AccountStringLast 2 of bank account (masked)XXMasked bank account
4CurrencyString (ISO 4217)Settlement currencyUSDCurrency context
5SalesDecimal (String)Total sales amount50000.00Gross sales in the period
6RefundsDecimal (String)Total refund amounts (negative)-500.00Returns/refunds (negative value)
7DisputesDecimal (String)Total chargeback amounts (negative)-250.00Chargebacks (negative value)
8OtherDecimal (String)Other adjustments0.00Reserve / adjustments
9Gross FeesDecimal (String)Total gross fees1500.00All fees charged before credits
10Net FeesDecimal (String)Net fees charged (negative)-1250.00Gross Fees less any fee refunds, credits, or waivers in the period
11Net Disbursed AmountDecimal (String)Net amount disbursed47750.00Actual disbursement amount
12BalanceDecimal (String)Post-disbursement balance0.00Account balance
13Previous Failed Disbursement Amount(s)Decimal (String)Prior failed payout amounts0.00Failed previous disbursements
14Previous Transfer ID(s)StringPrior transfer IDs (comma-separated)(empty) or TR-000Previous transfers

Total RS fields: 14

Formula

NetDisbursedAmount = Sales + Refunds + Disputes + Other + NetFees

Refunds, Disputes, and NetFees are negative values.

Section RD — Report Detail (transaction-level)

The RD section carries 60 fields per row. Rows are signed: sale rows are positive; refund, dispute, and fee rows are negative. Fields marked (empty in current exports) exist for Braintree format compatibility and are not populated today.

#Field NameData TypeDescriptionSample Value
1Record IDUUIDUnique identifier for this row01a2b3c4-...
2Merchant Account IDStringExternal merchant ID; may be blankMERCH-001 or (empty)
3Record TypeEnumRow classificationSale, Refund, Dispute, Adjustments, Fees
4Record SubtypeStringFiner classification (see mapping below); empty for SaleChargeback, Processing Fee
5Account NameStringMerchant display nameAcme Store Inc.
6Account IDStringMerchant account reference(empty in current exports)
7Created AtDateTime (UTC)When the underlying event was recorded2026-07-28T16:51:13Z
8Settlement DateDateSettlement date2026-07-28
9Disbursement DateDateDisbursement date — see note below2026-07-28
10Presentment CurrencyString (ISO 4217)Original currencyUSD
11Gross Presentment AmountDecimal (String, signed)Row amount in presentment currency410.86, -45.70
12Exchange RateDecimal (String)Presentment-to-settlement FX rate1.0000000000
13Settlement CurrencyString (ISO 4217)Settlement currencyUSD
14Gross Settlement AmountDecimal (String, signed)Row amount in settlement currency410.86, -38.41
15Total Gross FeesDecimal (String)Aggregate gross fees for the row — 0.00 today; fees appear as their own Fees rows0.00
16Total Net FeesDecimal (String)Aggregate net fees for the row — 0.00 today; see note below0.00
17Net Disbursed AmountDecimal (String, signed)The row's net contribution to the disbursement410.86, -45.70
18Tax AmountDecimal (String)Tax on the row(empty in current exports)
19Tax ExemptStringTax-exemption flag(empty in current exports)
20Transfer IDStringBank transfer the row disburses under; matches RS Transfer ID(s)AB12CD34
21Order IDStringYour order referenceORD-2024-001
22Dispute IDStringDispute identifier — the dispute reference is carried in Description instead(empty in current exports)
23Purchase Order NumberStringPurchase-order reference; carries the order reference todayORD-2024-001
24Original Record IDStringReference to the original record(empty in current exports)
25Original Order IDStringOrder reference of the original transaction, on refund/dispute/fee rowsORD-2024-001
26Acquirer Reference NumberStringARN(empty) or ARN value
27Payment Instrument TypeStringPayment instrument typeCredit Card
28Payment Instrument SubtypeStringCard brandVisa, Mastercard
29Payment NetworkStringPayment network(empty in current exports)
30Payment Method TokenStringPayment token(empty in current exports)
31Number of InstallmentsIntegerInstallment count(empty in current exports)
32Installment NumberIntegerInstallment sequence(empty in current exports)
33Bank AccountStringBank account, maskedXX
34Payment ChannelStringPayment channel(empty in current exports)
35Dispute Case NumberStringProcessor case number, on dispute rowsCB-2026-001
36Store IDStringStore identifier(empty in current exports)
37Reader IDStringCard-reader/terminal identifier(empty in current exports)
38Customer IDStringCustomer identifier(empty in current exports)
39Authorization CodeStringAuthorization code(empty in current exports)
40Direct Bank Return CodeStringBank return code(empty in current exports)
41Variable FeeDecimal (String)Variable fee component(empty in current exports)
42Fixed FeeDecimal (String)Fixed fee component(empty in current exports)
43Foreign Exchange FeeDecimal (String)FX fee(empty in current exports)
44Cross-Border FeeDecimal (String)Cross-border fee(empty in current exports)
45Chargeback Protection FeeDecimal (String)Chargeback-protection fee(empty in current exports)
46BINStringCard BIN (6 or 8 digits)42424242
47Issuing BankStringCard issuing bank(empty in current exports)
48Card Issuing CountryStringCard issuing country(empty in current exports)
49DescriptionStringFree-text detail; on dispute rows carries the network reason code and dispute reference104 Dispute ref: <dispute-uuid>
50Interchange CurrencyStringInterchange currency(empty in current exports)
51Interchange RateDecimal (String)Interchange rate(empty in current exports)
52Interchange FixedDecimal (String)Fixed interchange component(empty in current exports)
53Total Interchange FeesDecimal (String)Interchange fee total(empty in current exports)
54Total Scheme FeesDecimal (String)Scheme fee total(empty in current exports)
55Total Pass-Through FeesDecimal (String)Pass-through fee total(empty in current exports)
56CountIntegerRecords aggregated in the row (1 for transaction-level rows)1
57Total Processing FeesDecimal (String)Aggregate processing fees for the row0.00
58Pass-Through Fee MonthString (YYYY-MM)Month pass-through fees accrue to(empty in current exports)
59Processing Fee MonthString (YYYY-MM)Month the fee accrues to2026-07
60Custom FieldsStringCustom field payload(empty in current exports)

Total RD fields: 60

📘

Fees are their own rows. Each fee appears as a separate RD row (Record Type = Fees) with a negative amount, tied to its transaction via Order ID — the per-row Total Gross Fees / Total Net Fees columns stay 0.00. The RS Net Fees aggregate is the sum of the Fees rows. This enables per-order fee reconciliation directly from the RD section.

📘

Note on Disbursement Date (field 9): populated, but it currently carries the same value as Settlement Date rather than a distinct disbursement timestamp. Do not rely on it to distinguish disbursement timing from settlement timing.

RecordType → RecordSubtype mapping

The RD Record Type / Record Subtype pair classifies each row:

Record TypeRecord SubtypeMeaning
Sale(empty)Order / sale transaction
RefundMerchant CreditMerchant-issued credit
Refund(empty)Return / refund
DisputeChargebackDispute debit — covers all dispute stages, including pre-disputes (a PRE-DISPUTE in dispute-detail appears here as a Chargeback row)
AdjustmentsManual AdjustmentManual batch adjustment
AdjustmentsReserve HoldReserve amount held
AdjustmentsReserve ReleaseReserve amount released
AdjustmentsReserve CancellationReserve hold cancelled
AdjustmentsReserve UtilizationReserve applied to cover losses
AdjustmentsReserve DeductionReserve deduction
FeesProcessing FeeStandard processing fee
FeesPartner Processing FeePartner processing fee
FeesDispute FeeChargeback fee
FeesRefund FeeRefund fee
FeesInterchange FeeInterchange fee

Section RF — Report Footer

#Field NameData TypeDescriptionSample Value
1Page numberStringPage number1 (always)
2Total recordsStringNumber of RD rows1234
3Total pagesStringNumber of pages1 (always)

Total RF fields: 3

Reconciliation workflow

  1. Parse the multi-section CSV format by line prefix (RH, RS, RD, RF).
  2. Verify RF Total records matches the actual RD row count.
  3. For each RS record, verify the disbursement calculation.
  4. Match Merchant Account ID to your merchant master.
  5. Reconcile RS Net Disbursed Amount to bank deposits.
  6. Match Transfer ID(s) to actual bank-transfer references.
  7. Drill into RD records for transaction-level detail; use the RecordType → RecordSubtype mapping to classify each row.
  8. Reconcile RS Sales with the activity-summary totals.

Did this page help you?