Forecast file layout
Record 0 - Header
Identifies the header of the Forecast File:
| Position | Field | Description | Seller Extract | Type | Size | Example |
|---|---|---|---|---|---|---|
| 1 | Record Type | Identifies the header record type (start of the file). 0 - Header | Yes | number | 2 | 0 |
| 2 | Layout Version | Version of the layout used to generate the file. | Yes | number | 3 | 1 |
| 3 | Document Number | Document number (CNPJ/CPF). | Yes | alphanumeric | 14 | 0000000000 |
| 4 | Generation Date | Indicates the file generation date. | Yes | datetime | 17 | 20220119 09:43:10 |
| 5 | Sequence | Sequential number of the file. | Yes | number | 2 | 1 |
| 6 | File Type | Extract type. Example: Forecast File | Yes | number | 2 | 1 |
| 7 | Minimum Processed Date* | Minimum scheduling date of operations in the file - Internal processing | Yes | datetime | 17 | 20220118 09:43:10 |
| 8 | Maximum Processed Date* | Maximum scheduling date of operations in the file - Internal processing | Yes | datetime | 17 | 20220118 09:43:10 |
| 9 | Minimum Transactional Event Date* | Initial capture date of items included in the file. | Yes | date | 17 | 20220118 |
| 10 | Maximum Transactional Event Date* | Final capture date of items included in the file. | Yes | date | 17 | 20220118 |
| 11 | Reprocessed | Indicates if the file was generated through the reprocessing flow. | Yes | number | 1 | 0 (False) or 1 (True) |
*Not required; may be empty if there is no movement on the day.
Record 1 - Merchant
Identifies merchant data:
| Position | Field | Description | Seller Extract | Type | Size | Example |
|---|---|---|---|---|---|---|
| 1 | Record Type | Indicates the record type. 1 - Merchant | Yes | number | 2 | 1 |
| 2 | Merchant Identifier | Identifier number of the merchant where the sale was made. | Yes | GUID | 36 | 1B917293-8B8D-4180-B2D8-C514A1F8512D |
| 3 | Merchant Type | Indicates the merchant type. See Table I. | Yes | number | 2 | 3 |
Record 2 - Transactional Events
Identifies transactional events:
| Position | Field | Description | Seller Extract | Type | Size | Example |
|---|---|---|---|---|---|---|
| 1 | Record Type | Indicates the record type. 2 - Transactional Events | Yes | number | 2 | 2 |
| 2 | Transactional Event Type | Type of transactional events. See Table II | Yes | number | 2 | 1 |
| 3 | Transactional Event Identifier | Unique identifier of the event recorded in the financial schedule. | Yes | GUID | 36 | D6CDD768-CDFE-479A-B090-CD03253EEE2B |
| 4 | Transactional Event Date | Date when the operation occurred. For a transaction, represents the authorization date; for others, represents the date the operation occurred. | Yes | datetime | 17 | 20220119 09:43:10 |
| 5 | Confirmation Date | Date when the operation was completed. - Transaction: capture date; - Other events: confirmation date. | Yes | date | 8 | 20220119 |
| 6 | Scheduling Date | Date when the event was processed in the financial schedule. | Yes | datetime | 17 | 20220119 09:43:10 |
| 7 | Operation Amount | Operation amount in cents. Can be positive or negative. | No | number | 20 | R$100.01 = 10001 or -10001 |
| 8 | Administrative Fee (MDR) | Percentage applied to the gross operation amount. | No | number | 20 | 1.55% = 1.55 |
| 9 | Administrative Fee Amount (MDR) | Calculated administrative fee amount in cents for the transactional event. | No | number | 20 | R$100.01 = 10001 |
| 10 | Administrative Tariff (Fee) | Fixed fee charged per transaction. Amount charged separately in the financial schedule. | No | number | 20 | R$100.01 = 10001 |
| 11 | Receba Rápido Fee Value* | Amount deducted for sellers' advance payment via Receba Rápido | No | number | 20 | R$100.01 = 10001 |
| 12 | Boleto Fee* | Fee charged for boleto issued or paid for boleto transactions. | No | number | 20 | R$100.01 = 10001 |
| 13 | Direct Sale Gross Value* | Gross value of direct sale by the Master, if the Master is a participant in the transaction. | No | number | 20 | R$100.01 = 10001 |
| 14 | Direct Sale Administrative Fee Value* | Calculated administrative fee value, in cents, on the direct sale. | No | number | 20 | R$100.01 = 10001 |
| 15 | Direct Sale Net Value* | Net value of the direct sale. | No | number | 20 | R$100.01 = 10001 |
| 16 | Commission Gross Value* | Gross commission value received by the Master. | No | number | 20 | R$100.01 = 10001 |
| 17 | Commission Administrative Fee Value* | Calculated administrative fee value, in cents, on the commission, including the Receba Rápido fee. | No | number | 20 | R$100.01 = 10001 |
| 18 | Commission Net Value* | Net commission value received from sellers. | No | number | 20 | R$100.01 = 10001 |
| 19 | Transaction Identifier | Transaction identifier. | Yes | GUID | 36 | ED6C8828-F92B-42F4-B6B3-6CA276830733 |
| 20 | Authorization Date | Sale date. | Yes | datetime | 17 | 20220119 09:43:10 |
| 21 | Adjustment Code | Code identifying the financial adjustment posted in the schedule. See Table VII | Yes | alphanumeric | 4 | A001 |
| 22 | Capture Date | Transaction confirmation date. | Yes | date | 8 | |
| 23 | Transaction Value | Transaction value in cents. | Yes | number | 20 | R$100.01 = 10001 |
| 24 | Product Code | Code identifying the product. See Table III | Yes | number | 2 | 1 |
| 25 | Brand Code | Code identifying the brand or bank. See Table IV | Yes | number | 2 | 2 |
| 26 | Authorization Code | Transaction authorization code. This number is not unique and may be repeated. | Yes | alphanumeric | 10 | 251411 |
| 27 | NSU/DOC | Sequential transaction number, also known as DOC (document number), identifying the transaction on the day it was made. This number may be repeated. | Yes | alphanumeric | 8 | 053181 |
| 28 | Total Installments | Total installments of the transaction. | Yes | number | 2 | 10 |
| 29 | Order Number | Order number provided by the merchant in the transaction. | Yes | number | 50 | Order123456 |
| 30 | Truncated Card Number | Truncated card number used for the purchase. | Yes | alphanumeric | 19 | 111111*******1111 |
| 31 | Acquirer Transaction Identifier | Transaction identifier at the acquirer for e-commerce transactions (TID) | Yes | alphanumeric | 20 | 99999999111Q1A2A3A4A |
| 32 | Terminal Logical Number | Logical number of the terminal where the transaction occurred. | Yes | alphanumeric | 50 | 99999999 |
| 33 | Capture Method | Method by which the transaction was captured. See Table V | Yes | number | 2 | 1 |
| 34 | EndToEnd | Pix end-to-end code | Yes | string | 36 | S3187249520241212151562W9Qb1L1us |
*Not required.
Record 3 - Transactional Event Participants
Identifies the participants (Master and Sellers) of the Transactional Event:
| Position | Field | Description | Seller Extract | Type | Size | Example |
|---|---|---|---|---|---|---|
| 1 | Record Type | Indicates the record type. 3 - Transaction Participants | Yes | number | 2 | 3 |
| 2 | Division Identifier | Division identifier. | Yes | GUID | 36 | CCC2E1DD-C47D-4722-A8A2-4DC51746CB0C |
| 3 | Establishment Identifier | Identifies the establishment participating in the split. | Yes | GUID | 36 | AAA2E1DD-C47D-4722-A8A2-4DC51746CB0C |
| 4 | Document Number | Identifies the participant's CPF/CNPJ number. | Yes | alphanumeric | 17 | 00000000000 |
| 5 | Establishment Type | Identifies the participant type. See Table I | Yes | number | 2 | 3 |
| 6 | Participant Gross Value | Gross operation value allocated to the participant. | Yes | number | 2 | R$100.01 = 10001 |
| 7 | Discount Percentage | Percentage discounted from the participant's gross value. | Yes | number | 20 | 20% = 20 |
| 8 | Discount Value | Calculated discount value in cents applied to the gross value. | Yes | number | 20 | R$100.01 = 10001 |
| 9 | Fixed Discount Fee | Fixed value discounted from the participant's gross value. | Yes | number | 20 | R$100.01 = 10001 |
| 10 | Participant Net Value | Net operation value to be received by the participant. | Yes | number | 20 | R$100.01 = 10001 |
| 11 | Commission Indicator | Indicates if the division refers to the master's commission or not. 0 – No; 1 - Yes | Yes | number | 1 | 0 |
| 12 | Receba Rápido Installment Percentage* | Percentage per installment of Receba Rápido. | Yes | number | 20 | 20% = 20 |
| 13 | Receba Rápido Total Percentage* | Total percentage of Receba Rápido. | Yes | number | 20 | 20% = 20 |
| 14 | Receba Rápido Calculated Value* | Calculated value of Receba Rápido. | Yes | number | 20 | R$100.01 = 10001 |
*Not required.
Record 4 - Financial Schedule
| Position | Field | Description | Seller Extract | Type | Size | Example |
|---|---|---|---|---|---|---|
| 1 | Record Type | Indicates the record type. 4 - Financial Schedule | Yes | number | 2 | 4 |
| 2 | Financial Event Identifier | Originating identifier of the event posted in the financial schedule. | Yes | GUID | 36 | 4717A632-D6C4-4B74-9422-235905D1857D |
| 3 | Origin Identifier | Financial schedule identifier. Transactional event identifier. | Yes | GUID | 36 | D8D26880-7BBB-4761-A2A7-B4C835B4923C |
| 4 | Establishment Identifier | Identifies the establishment. | Yes | GUID | 36 | 5CB61E99-1B4D-4E7A-886F-6BFB4FF71219 |
| 5 | Document Number | Identifies the participant's CPF/CNPJ number. | Yes | alphanumeric | 17 | 00000000000 |
| 6 | Installment Number | Identifies the installment to be settled. | Yes | number | 2 | 10 |
| 7 | Event Type | Identifies the type of event posted in the financial schedule. (link table) | Yes | number | 2 | 23 |
| 8 | Transactional Event Type | Identifies the type of transactional event originating the schedule entry. | Yes | number | 2 | 1 |
| 9 | Expected Settlement Date | Expected settlement date. | Yes | date | 8 | YYYYMMDD |
| 10 | Net Value | Net value to be settled. | Yes | number | 20 | R$100.01 = 10001 |
| 11 | Commission Indicator | Indicates if the schedule entry refers to the master's commission or not. 0 - No; 1 – Yes | No | number | 1 | 0 |
Record 9 - Footer
| Position | Field | Description | Seller Extract | Type | Size | Example |
|---|---|---|---|---|---|---|
| 1 | Record Type | Indicates the record type. 9- Footer (end of file) | Yes | number | 2 | 9 |
| 2 | Record Count | Number of records in the file excluding the "header" and "footer". | Yes | number | 20 | 1000 |
Updated 10 days ago