Settlement file layout
Record 0 - Header
Identifies the header of the Settlement 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 | 2 | 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: Settlement File | Yes | number | 2 | 2 |
| 7 | Minimum Settlement Date* | Earliest settlement date of receivables. | Yes | date | 8 | 20220118 |
| 8 | Maximum Settlement Date* | Latest settlement date of receivables. | Yes | date | 8 | 20220118 |
| 9 | Minimum Expected Date* | Earliest expected date of receivables settled on the day. | Yes | date | 8 | 20220118 |
| 10 | Maximum Expected Date* | Latest expected date of receivables settled on the day. | Yes | date | 8 | 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 - Receivable
Identifies the receivable and its settlement:
| Position | Field | Description | Seller Extract | Type | Size | Example |
|---|---|---|---|---|---|---|
| 1 | Record Type | Indicates the record type. 1 - Receivable | Yes | number | 2 | 1 |
| 2 | Receivable Identifier | Unique identifier of the Receivable Unit (UR). | Yes | GUID | 36 | 1B917293-8B8D-4180-B2D8-C514A1F8512D |
| 3 | Expected Settlement Date | Expected settlement date. | Yes | date | 8 | 20220110 |
| 4 | Product Code | Identifier of the product type. See https://docs.cielo.com.br/split/docs/tabela-iii-produtos | Yes | number | 2 | 1 |
| 5 | Card Brand Code | Identifier of the card brand or bank. See https://docs.cielo.com.br/split/docs/tabela-iv-bandeiras | Yes | number | 2 | 1 |
| 6 | Total UR Amount | Accumulated amount of the Receivable Unit. | Yes | number | 20 | R$ 10,000.00 = 1000000 |
| 7 | Total Previously Settled Amount | Total amount already settled for the UR in previous files. | Yes | number | 20 | R$ 10,000.00 = 1000000 |
| 8 | Settled Amount | Amount settled for the UR in the current file. | Yes | number | 20 | R$ 10,000.00 = 1000000 |
Record 2 - Payment Groups
Identifies details of the receivable settlement:
| Position | Field | Description | Seller Extract | Type | Size | Example |
|---|---|---|---|---|---|---|
| 1 | Record Type | Identifies the record type. 2 - Payment Group | Yes | number | 1 | 2 |
| 2 | Settlement Type | Indicates the type of settlement. See Table VIII: https://docs.cielo.com.br/split/docs/tabela-viii-tipos-de-liquida%C3%A7%C3%A3o | Yes | number | 2 | 1 |
| 3 | Settlement Status* | Indicates the settlement status. See Table X: https://docs.cielo.com.br/split/docs/tabela-x-status-da-liquida%C3%A7%C3%A3o | Yes | number | 2 | 1 |
| 4 | Settled Amount* | Amount paid for the payment group | Yes | number | 2 | R$ 1,000.00 = 100000 |
| 5 | Settlement Date* | Date on which the payment occurred | Yes | date | 8 | 20220118 |
| 6 | ISPB* | ISPB code (Brazilian Payment System Identifier) of the bank | Yes | alphanumeric | 8 | 01027058 |
| 7 | CompeCode* | COMPE code of the bank | Yes | alphanumeric | 3 | 362 |
| 8 | Branch Number* | Bank branch number | Yes | alphanumeric | 15 | 3452 |
| 9 | Branch Digit* | Bank branch digit | Yes | alphanumeric | 1 | 1 |
| 10 | Account Number* | Bank account number | Yes | alphanumeric | 20 | 256545 |
| 11 | Account Digit* | Bank account digit | Yes | alphanumeric | 1 | 1 |
| 12 | Account Type* | Account type. See Table IX: https://docs.cielo.com.br/split/docs/tabela-ix-tipos-de-contas | Yes | alphanumeric | 2 | 3 |
| 13 | Account Holder Name* | Name of the account holder | Yes | alphanumeric | 200 | ACCOUNT HOLDER NAME |
| 14 | Account Holder Document Number* | Document number of the account holder (CPF or CNPJ) | Yes | alphanumeric | 14 | 234 |
| 15 | Beneficiary of Ownership Change** | Document number of the beneficiary in case of ownership change (CPF or CNPJ) | Yes | alphanumeric | 14 | 0000000000 |
| 16 | Contract Protocol Number*** | Identifier of the protocol effect received from the registrar that informed the ownership change | Yes | GUID | 36 | 485BDD77-BA55-4447-AC10-AA38F97CFC49 |
*Mandatory if the settlement type is different from ownership change.
**Mandatory if the settlement type is ownership change.
***Mandatory if the settlement type is different from Braspag.
Record 3 - Financial Schedule / Transactional Event
Identifies the entries in the financial schedule based on the transactional event:
| Position | Field | Description | Seller Extract | Type | Size | Example |
|---|---|---|---|---|---|---|
| 1 | Record Type | Indicates the record type. 3 - Financial Schedule | Yes | number | 2 | 3 |
| 2 | Event Identifier | Unique identifier of the event posted in the financial schedule. | Yes | GUID | 36 | 4717A632-D6C4-4B74-9422-235905D1857D |
| 3 | Origin Identifier | Originator identifier of the financial schedule, identifier of the transactional event. | Yes | GUID | 36 | D8D26880-7BBB-4761-A2A7-B4C835B4923C |
| 4 | Establishment Identifier | Establishment identifier. | Yes | GUID | 36 | 5CB61E99-1B4D-4E7A-886F-6BFB4FF71219 |
| 5 | Document Number | Identifies the CPF/CNPJ number of the participant. | 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. See Table VI | Yes | number | 2 | 23 |
| 8 | Transactional Event Type | Identifies the type of transactional event that originated the posting in the schedule. | Yes | number | 2 | 1 |
| 9 | Expected Settlement Date | Expected settlement date. | Yes | number | 8 | AAAAMMDD |
| 10 | Net Schedule Amount | Net amount to be settled. | Yes | number | 20 | R$100,01 = 10001 |
| 11 | Transactional Event Identifier | Transactional event identifier. When it is a transaction, this field is equal to the Transaction Identifier. | Yes | GUID | 36 | D6CDD768-CDFE-479A-B090-CD03253EEE2B |
| 12 | Transactional Event Date | Date when the operation occurred. For transactions, represents the authorization date. For others, represents the date of the operation. | Yes | datetime | 17 | 20220119 09:43:10 |
| 13 | Confirmation Date | Date when the operation was completed. Transaction - Capture Cancellation - Cancellation confirmation. | Yes | date | 17 | 20220119 |
| 14 | Schedule Date | Date when the event was processed in the financial schedule. | Yes | datetime | 17 | 20220119 09:43:10 |
| 15 | Operation Amount | Operation amount in cents. Can be positive or negative. | No | number | 20 | R$100,01 = 10001 |
| 16 | Administrative Fee (MDR) | Percentage applied to the gross operation amount. | No | number | 20 | R$100,01 = 10001 |
| 17 | Administrative Fee Amount | Calculated administrative fee amount in cents on the transactional event. | No | number | 20 | R$100,01 = 10001 |
| 18 | Administrative Tariff (Fee) | Fixed fee charged per transaction. Amount charged separately in the financial schedule. | No | number | 20 | R$100,01 = 10001 |
| 19 | Fast Receive Fee Amount | Amount deducted for sellers' advance payment by Fast Receive. | No | number | 20 | R$100,01 = 10001 |
| 20 | Boleto Tariff | Fee charged for boleto issued or paid for boleto transactions. | No | number | 20 | R$100,01 = 10001 |
| 21 | Gross Direct Sale Amount | Gross direct sale amount of the Master, if the Master is a participant selling a product. | No | number | 20 | R$100,01 = 10001 |
| 22 | Direct Sale Administrative Fee Amount** | Calculated administrative fee amount, in cents, on direct sale. | No | number | 20 | R$100,01 = 10001 |
| 23 | Net Direct Sale Amount | Net direct sale amount. | No | number | 20 | R$100,01 = 10001 |
| 24 | Gross Commission Amount | Gross commission amount received by the Master. | No | number | 20 | R$100,01 = 10001 |
| 25 | Commission Administrative Fee Amount | Calculated administrative fee amount, in cents, on commission, including Fast Receive fee. | No | number | 20 | R$100,01 = 10001 |
| 26 | Net Commission Amount | Net commission amount received from sellers. | No | number | 20 | R$100,01 = 10001 |
| 27 | Transaction Identifier | Transaction identifier. | Yes | GUID | 36 | D6CDD768-CDFE-479A-B090-CD03253EEE2B |
| 28 | Authorization Date | Sale date. | Yes | datetime | 17 | 20220119 09:43:10 |
| 29 | Adjustment Code | Code identifying the financial adjustment posted in the schedule. See Table VII | Yes | alphanumeric | 4 | A001 |
| 30 | Capture Date | Transaction confirmation date. | Yes | date | 8 | 20220119 |
| 31 | Transaction Amount | Transaction amount in cents. | Yes | number | 20 | R$100,01 = 10001 |
| 32 | Product Code | Code identifying the product. See Table III | Yes | number | 2 | 2 |
| 33 | Brand Code | Code identifying the brand or bank. See Table IV | Yes | number | 2 | 1 |
| 34 | Authorization Code | Transaction authorization code. This number is not unique and may repeat. | Yes | alphanumeric | 10 | 251411 |
| 35 | NSU/DOC | Sequential transaction number, also known as DOC (document number), identifying the transaction on the day it occurred. Not unique and may repeat. | Yes | alphanumeric | 8 | 053181 |
| 36 | Total Installments | Total transaction installments. | Yes | number | 2 | 10 |
| 37 | Order Number | Order number provided by the establishment in the transaction. | Yes | number | 50 | 1234567891011 |
| 38 | Truncated Card Number | Truncated card number used for the purchase. | Yes | alphanumeric | 19 | 111111*******1111 |
| 39 | Acquirer Transaction Identifier | Transaction identifier at the acquirer for e-commerce transactions (TID). | Yes | alphanumeric | 20 | 99999999111Q1A2A3A4A |
| 40 | Terminal Logical Number | Logical terminal number where the transaction occurred. | Yes | alphanumeric | 50 | 99999999 |
| 41 | Capture Method | Method by which the transaction was captured. See Table V | Yes | number | 2 | 1 |
| 42 | Commission Indicator | Indicates if the schedule entry refers to the Master's commission. 0 - No; 1 - Yes | No | number | 1 | 0 |
| 43 | EndToEnd | Pix end-to-end code | Yes | string | 36 | S3187249520241212151562W9Qb1L1us |
AttentionFields from position 11 to 41 will not be displayed if the Event Type is equal to 41, 42, or 43.
Record 4 - Balance Adjustment
| Position | Field | Description | Seller Extract | Type | Size | Example |
|---|---|---|---|---|---|---|
| 1 | Record Type | Indicates the record type. 4 - Balance Adjustment | Yes | number | 2 | 4 |
| 2 | Position Date | Date of the negative balance position. | Yes | date | 8 | 20220119 |
| 3 | Product Code | Code identifying the product. See Table III | Yes | number | 2 | 1 |
| 4 | Brand Code | Code identifying the brand or bank. See Table IV | Yes | number | 2 | 1 |
| 5 | Initial Value | Initial value of the negative balance. | Yes | number | 20 | R$100,01 = 10001 |
| 6 | Posted Value | Value posted in the balancing process. | Yes | number | 20 | R$100,01 = 10001 |
| 7 | Final Value | Final value of the negative balance after balancing. | Yes | number | 20 | R$100,01 = 10001 |
Record 5 - Balance Adjustment by Establishment
| Position | Field | Description | Seller Extract | Type | Size | Example |
|---|---|---|---|---|---|---|
| 1 | Record Type | Indicates the record type. 5 - Balance Adjustment by Establishment | Yes | number | 2 | 5 |
| 2 | Establishment Identifier | Identifies the establishment. | Yes | GUID | 36 | 5CB61E99-1B4D-4E7A-886F-6BFB4FF71219 |
| 3 | Initial Value | Initial value of the negative balance. | Yes | number | 20 | R$100,01 = 10001 |
| 4 | Posted Value | Value posted in the balancing process. | Yes | number | 20 | R$100,01 = 10001 |
| 5 | Final Value | Final value of the negative balance after balancing. | Yes | number | 20 | R$100,01 = 10001 |
Record 6 - Pix Transfer
| Position | Field | Description | Seller Extract | Type | Size | Example |
|---|---|---|---|---|---|---|
| 1 | Record Type | Identifies the record type. 6 – Pix Transfers | Yes | number | 2 | 6 |
| 2 | Transfer ID | Transaction identification | Yes | GUID | 36 | 1B9172938B8D-4180-B2D8C514A1F8512D |
| 3 | Expected Date | Expected settlement date | Yes | date | 8 | 20001121 |
| 4 | Product Code | Code identifying the product. See Table III | Yes | number | 2 | 4 |
| 5 | Brand Code | Code identifying the brand or bank. See Table IV | Yes | number | 2 | 27 |
| 6 | Total Value | Total transfer value | Yes | number | R$100,01 = 10001 | |
| 7 | Status | Transfer status. See Table XI | Yes | number | 1 | |
| 8 | Settlement Date | Settlement date | Yes | number | 8 | 20001121 |
| 9 | ISPB | ISPB code (Brazilian Payment System Identifier) of the bank | Yes | alphanumeric | 8 | 01027058 |
| 10 | Bank Name | Bank name | Yes | alphanumeric | 200 | ITAU |
| 11 | CompeCode | COMPE code of the bank. | Yes | alphanumeric | 3 | 362 |
| 12 | Branch Number | Bank branch number. | Yes | alphanumeric | 15 | 3452 |
| 13 | Branch Digit | Bank branch digit. | Yes | alphanumeric | 1 | 1 |
| 14 | Account Number | Bank account number. | Yes | alphanumeric | 20 | 256545 |
| 15 | Account Digit | Account digit. | Yes | alphanumeric | 1 | 1 |
| 16 | Account Type | Account type. See Table IX | Yes | alphanumeric | 2 | 3 |
| 17 | Merchant ID | Merchant ID | Yes | GUID | 36 | 1B9172938B8D-4180-B2D8C514A1F8512D |
| 18 | Trade Name | Trade name of the account holder | Yes | alphanumeric | 50 | |
| 19 | Account Holder Document Number | Document number of the account holder (CPF or CNPJ). | Yes | alphanumeric | 14 | 234 |
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 about 1 month ago