Forecast report
Transactions to send
For the purpose of a business case, two months of data will suffice.
All historical payment transaction types need to be sent:
- Successful transactions
- Failed transactions
- Refunded transactions
- Chargebacks
Data layout
Please follow our required data layout, one record per transaction. This file cannot contain any PII or PCI data.
Template
We support .csv and .xlsx files.
| Format | Download |
|---|---|
| .csv | Download the .csv template |
| .xlsx | Download the .xlsx template |
Fields
| Field | Type | Requirement | Description |
|---|---|---|---|
| Merchant | string | required | Identifier for the merchant |
| OrderId | string | optional | Unique transaction identifier |
| SiteUrl | string | optional | URL of the merchant's site |
| Transaction_Timestamp | datetime | required | Timestamp of the transaction |
| Transaction_Amount | decimal | required | Amount involved in the transaction |
| Transaction_Currency | string | required | Currency code for the transaction amount |
| Transaction_TransactionType | string | required | Type of transaction (e.g., Capture, Authorization) |
| Transaction_ResponseStatus | string | required | Status of the transaction (e.g., Declined, Approved) |
| Transaction_ProcessorName | string | optional | Name of the payment processor |
| Transaction_ResponseCodeSource | string | optional | Source of the transaction response code |
| Transaction_ResponseCode | string | optional | Code returned by the processor in response to the transaction |
| Transaction_ResponseDescription | string | required | Description of the transaction response |
| Transaction_AvsResultCode | string | optional | AVS result code for address verification |
| Transaction_CvvResultCode | string | optional | CVV result code from the payment processor |
| Transaction_CavvResultCode | string | optional | CAVV result code for cardholder authentication |
| Transaction_CardNotPresent | boolean | recommended | Indicates if the transaction was card-not-present |
| IsMIT | boolean | recommended | Indicates if the transaction is a Merchant Initiated Transaction |
| IsRecurring | boolean | optional | Indicates if the transaction is part of a recurring payment |
| Payer_Id | string | optional | Identifier for the payer |
| Payer_Email (masked) | string | required (masked) | Email address of the payer. Mask this info using SHA-256 |
| Payer_Phone (masked) | string | optional (masked) | Phone number of the payer. Mask this info using SHA-256 |
| PaymentMethod_Type | string | required | Type of payment method (e.g., CREDIT, DEBIT, PAYPAL) |
| PaymentMethod_CardBinNumber | string | required | BIN number of the card used |
| PaymentMethod_CardLast4Digits | string | recommended | Last four digits of the card used |
| PaymentMethod_ExpirationMonth | integer | recommended | Expiration month of the card used |
| PaymentMethod_ExpirationYear | integer | recommended | Expiration year of the card used |
| PaymentMethod_HolderName (masked) | string | optional (masked) | Name of the cardholder. Mask this info using SHA-256 |
Masking sensitive information
Please do not send PII or PCI data in this file. Use SHA-256 hashing to mask sensitive or private information.
Transfer modes
Historical data is typically transferred to Flex in one of the following ways:
- Send a password-protected ZIP file
- sFTP upload