Forecast file layout

Record 0 - Header

Identifies the header of the Forecast File:

PositionFieldDescriptionSeller ExtractTypeSizeExample
1Record TypeIdentifies the header record type (start of the file).
0 - Header
Yesnumber20
2Layout VersionVersion of the layout used to generate the file.Yesnumber31
3Document NumberDocument number (CNPJ/CPF).Yesalphanumeric140000000000
4Generation DateIndicates the file generation date.Yesdatetime1720220119 09:43:10
5SequenceSequential number of the file.Yesnumber21
6File TypeExtract type.
Example: Forecast File
Yesnumber21
7Minimum Processed Date*Minimum scheduling date of operations in the file - Internal processingYesdatetime1720220118 09:43:10
8Maximum Processed Date*Maximum scheduling date of operations in the file - Internal processingYesdatetime1720220118 09:43:10
9Minimum Transactional Event Date*Initial capture date of items included in the file.Yesdate1720220118
10Maximum Transactional Event Date*Final capture date of items included in the file.Yesdate1720220118
11ReprocessedIndicates if the file was generated through the reprocessing flow.Yesnumber10 (False) or 1 (True)

*Not required; may be empty if there is no movement on the day.

Record 1 - Merchant

Identifies merchant data:

PositionFieldDescriptionSeller ExtractTypeSizeExample
1Record TypeIndicates the record type.
1 - Merchant
Yesnumber21
2Merchant IdentifierIdentifier number of the merchant where the sale was made.YesGUID361B917293-8B8D-4180-B2D8-C514A1F8512D
3Merchant TypeIndicates the merchant type. See Table I.Yesnumber23

Record 2 - Transactional Events

Identifies transactional events:

PositionFieldDescriptionSeller ExtractTypeSizeExample
1Record TypeIndicates the record type.
2 - Transactional Events
Yesnumber22
2Transactional Event TypeType of transactional events. See Table IIYesnumber21
3Transactional Event IdentifierUnique identifier of the event recorded in the financial schedule.YesGUID36D6CDD768-CDFE-479A-B090-CD03253EEE2B
4Transactional Event DateDate when the operation occurred. For a transaction, represents the authorization date; for others, represents the date the operation occurred.Yesdatetime1720220119 09:43:10
5Confirmation DateDate when the operation was completed.
- Transaction: capture date;
- Other events: confirmation date.
Yesdate820220119
6Scheduling DateDate when the event was processed in the financial schedule.Yesdatetime1720220119 09:43:10
7Operation AmountOperation amount in cents. Can be positive or negative.Nonumber20R$100.01 = 10001 or -10001
8Administrative Fee (MDR)Percentage applied to the gross operation amount.Nonumber201.55% = 1.55
9Administrative Fee Amount (MDR)Calculated administrative fee amount in cents for the transactional event.Nonumber20R$100.01 = 10001
10Administrative Tariff (Fee)Fixed fee charged per transaction. Amount charged separately in the financial schedule.Nonumber20R$100.01 = 10001
11Receba Rápido Fee Value*Amount deducted for sellers' advance payment via Receba RápidoNonumber20R$100.01 = 10001
12Boleto Fee*Fee charged for boleto issued or paid for boleto transactions.Nonumber20R$100.01 = 10001
13Direct Sale Gross Value*Gross value of direct sale by the Master, if the Master is a participant in the transaction.Nonumber20R$100.01 = 10001
14Direct Sale Administrative Fee Value*Calculated administrative fee value, in cents, on the direct sale.Nonumber20R$100.01 = 10001
15Direct Sale Net Value*Net value of the direct sale.Nonumber20R$100.01 = 10001
16Commission Gross Value*Gross commission value received by the Master.Nonumber20R$100.01 = 10001
17Commission Administrative Fee Value*Calculated administrative fee value, in cents, on the commission, including the Receba Rápido fee.Nonumber20R$100.01 = 10001
18Commission Net Value*Net commission value received from sellers.Nonumber20R$100.01 = 10001
19Transaction IdentifierTransaction identifier.YesGUID36ED6C8828-F92B-42F4-B6B3-6CA276830733
20Authorization DateSale date.Yesdatetime1720220119 09:43:10
21Adjustment CodeCode identifying the financial adjustment posted in the schedule. See Table VIIYesalphanumeric4A001
22Capture DateTransaction confirmation date.Yesdate8
23Transaction ValueTransaction value in cents.Yesnumber20R$100.01 = 10001
24Product CodeCode identifying the product. See Table IIIYesnumber21
25Brand CodeCode identifying the brand or bank. See Table IVYesnumber22
26Authorization CodeTransaction authorization code. This number is not unique and may be repeated.Yesalphanumeric10251411
27NSU/DOCSequential transaction number, also known as DOC (document number), identifying the transaction on the day it was made. This number may be repeated.Yesalphanumeric8053181
28Total InstallmentsTotal installments of the transaction.Yesnumber210
29Order NumberOrder number provided by the merchant in the transaction.Yesnumber50Order123456
30Truncated Card NumberTruncated card number used for the purchase.Yesalphanumeric19111111*******1111
31Acquirer Transaction IdentifierTransaction identifier at the acquirer for e-commerce transactions (TID)Yesalphanumeric2099999999111Q1A2A3A4A
32Terminal Logical NumberLogical number of the terminal where the transaction occurred.Yesalphanumeric5099999999
33Capture MethodMethod by which the transaction was captured. See Table VYesnumber21
34EndToEndPix end-to-end codeYesstring36S3187249520241212151562W9Qb1L1us

*Not required.

Record 3 - Transactional Event Participants

Identifies the participants (Master and Sellers) of the Transactional Event:

PositionFieldDescriptionSeller ExtractTypeSizeExample
1Record TypeIndicates the record type.
3 - Transaction Participants
Yesnumber23
2Division IdentifierDivision identifier.YesGUID36CCC2E1DD-C47D-4722-A8A2-4DC51746CB0C
3Establishment IdentifierIdentifies the establishment participating in the split.YesGUID36AAA2E1DD-C47D-4722-A8A2-4DC51746CB0C
4Document NumberIdentifies the participant's CPF/CNPJ number.Yesalphanumeric1700000000000
5Establishment TypeIdentifies the participant type. See Table IYesnumber23
6Participant Gross ValueGross operation value allocated to the participant.Yesnumber2R$100.01 = 10001
7Discount PercentagePercentage discounted from the participant's gross value.Yesnumber2020% = 20
8Discount ValueCalculated discount value in cents applied to the gross value.Yesnumber20R$100.01 = 10001
9Fixed Discount FeeFixed value discounted from the participant's gross value.Yesnumber20R$100.01 = 10001
10Participant Net ValueNet operation value to be received by the participant.Yesnumber20R$100.01 = 10001
11Commission IndicatorIndicates if the division refers to the master's commission or not.
0 – No; 1 - Yes
Yesnumber10
12Receba Rápido Installment Percentage*Percentage per installment of Receba Rápido.Yesnumber2020% = 20
13Receba Rápido Total Percentage*Total percentage of Receba Rápido.Yesnumber2020% = 20
14Receba Rápido Calculated Value*Calculated value of Receba Rápido.Yesnumber20R$100.01 = 10001

*Not required.

Record 4 - Financial Schedule

PositionFieldDescriptionSeller ExtractTypeSizeExample
1Record TypeIndicates the record type.
4 - Financial Schedule
Yesnumber24
2Financial Event IdentifierOriginating identifier of the event posted in the financial schedule.YesGUID364717A632-D6C4-4B74-9422-235905D1857D
3Origin IdentifierFinancial schedule identifier. Transactional event identifier.YesGUID36D8D26880-7BBB-4761-A2A7-B4C835B4923C
4Establishment IdentifierIdentifies the establishment.YesGUID365CB61E99-1B4D-4E7A-886F-6BFB4FF71219
5Document NumberIdentifies the participant's CPF/CNPJ number.Yesalphanumeric1700000000000
6Installment NumberIdentifies the installment to be settled.Yesnumber210
7Event TypeIdentifies the type of event posted in the financial schedule. (link table)Yesnumber223
8Transactional Event TypeIdentifies the type of transactional event originating the schedule entry.Yesnumber21
9Expected Settlement DateExpected settlement date.Yesdate8YYYYMMDD
10Net ValueNet value to be settled.Yesnumber20R$100.01 = 10001
11Commission IndicatorIndicates if the schedule entry refers to the master's commission or not. 
 0 - No; 1 – Yes
Nonumber10

Record 9 - Footer

PositionFieldDescriptionSeller ExtractTypeSizeExample
1Record TypeIndicates the record type.
9- Footer (end of file)
Yesnumber29
2Record CountNumber of records in the file excluding the "header" and "footer".Yesnumber201000