About Reconciliation API
What is Conciliation?
From a financial point of view, reconciliation is the act of raising all the company's accounts and receipts and comparing them with the amounts that entered and left your bank account, essential for the financial health of any business.
Why do reconciliation at Celcoin?
Reconciliation is necessary to check the statements of operations carried out by Celcoin APIs with your cash flow, ensuring transparency and allowing the identification of possible discrepancies.
Prerequisites for implementation:
- Have a Celcoin API key, for more information access this link .
- Have familiarity with Rest APIs using the OAuth 2.0 protocol.
This functionality aims to facilitate the reconciliation of transactions between the customer and Celcoin, enabling more efficient data handling and constant and safer return stability.
Use case:
As a fintech, I want to consult, via API, the types of transactions contained in the accounting movement files previously generated so that I can carry out my reconciliation with Celcoin.
Search for file types
The Search Reconciliation File Types API shows all file types available for reconciliation.
Request model:
cURL
curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/tools-conciliation/v1/exportfile/types' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {access_token}'
Response model:
JSON
[ { "fileType": 1, "description": "Movimentacao" }, { "fileType": 2, "description": "Recusa Movimentacao" }, { "fileType": 22, "description": "Transferencia Movimentacao" }, { "fileType": 23, "description": "Transferencia Recusa" }, { "fileType": 24, "description": "Recebimento Eletronico" }, { "fileType": 25, "description": "Pagamento Eletronico" }, { "fileType": 36, "description": "PIX Pagamento" }, { "fileType": 37, "description": "PIX Recebimento" }, { "fileType": 38, "description": "PIX Devolução de Recebimento" }, { "fileType": 39, "description": "PIX Devolução de Pagamento" }, { "fileType": 40, "description": "Recarga Internacional" }, { "fileType": 41, "description": "PIX Aporte" }, { "fileType": 46, "description": "Consulta Debito Veicular" }, { "fileType": 47, "description": "Liquidacao Debito Veicular" }, { "fileType": 57, "description": "TED - Cashin" }, { "fileType": 58, "description": "TED - Cashout" } ]
Description of fields (Response):
| Field | Description |
|---|---|
| fileType | File code |
| description | File name |
Available files:
| File | Product | Description |
|---|---|---|
| Movement | Bill Payment and Top-ups | Transaction file for successful bill payments and top-ups. |
| Refusal to move | Bill payment | Transaction file for bill payments returned by clearing. |
| Transfer Movement | Bank Transfer | Transaction file for bank transfers (TED) successfully completed. |
| Transfer Refusal | Bank Transfer | Transaction file for bank transfers (TED) returned by the beneficiary. |
| Electronic Receipt | Physical withdrawals | Transaction file for successful withdrawals. |
| Electronic Payment | Physical deposits | Movement file for physical deposits made successfully. |
| PIX Payment | Pix | Transaction file for Pix payments (cash-out) made successfully. |
| PIX Receipt | Pix | Transaction file for Pix receipts (cash-in) successfully completed. |
| PIX Return of Receipt | Pix | Movement file for Pix receipt returns. |
| PIX Payment Refund | Pix | Transaction file for Pix payments returned by the recipient. |
| International Recharge | International Recharge | Movement file for successful international top-ups. |
| PIX Contribution | Pix Contribution | Arquivo de movimentação para o registro de aportes realizados na conta proprietária.. |
| Vehicle Debt Query | Vehicle Debts | Movement file for vehicle debt queries made. |
| Vehicle Debt Settlement | Vehicle Debts | Transaction file for successfully completed vehicle debt payments. |
| TED Cashin | TED | Movement file for TED receipts. |
| TED Cashout | TED | Motion file for TEDs performed. |
Extracting files
The Extract reconciliation file API allows you to search on D+1 for reconciliation files for a given product using the file type (previously returned) and accounting date .
In this query, you can pass the following search parameters:
- fileType - Identificador do tipo de arquivo buscado.
- accountDate – Data contábil do arquivo buscado, seguindo formato AAAA-MM-DD.
- page - Identifier of the page of the returned listing.
- quantity - Identifier of the quantity per page returned. By default the size is 10,000.
️ Attention!
You must provide at least fileType and accountDate to perform the query.
The search for reconciliation files from the previous day will be available from 6 am on the current day.
NOTE: The accountDate parameter (accounting date) refers to the settlement date of the operation, being different from the transaction date, which is the date on which the operation was carried out .
Request model:
cURL
curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/tools-conciliation/v1/exportfile?filetype=1&accountdate=2022-06-07&Page=1' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {access_token}'
Response model:
JSON
{ "movement": [ { "DigitableLine": "03399492813698211200901537301028400000000000000 ", "AccountDate": "2022-06-01T00:00:00", "Value": 304.1, "TransactionType": 1, "TransactionDateTime": "2022-06-01T20:00:00", "TransactionCode": "RECEBERCONTA", "TransactionId": 815977512, "NSU": 97102, "ExternalTerminal": "TesteMockado-6C59770F-4A0A-4429-9C39-0ADBFFCDB525", "ExternalNSU": 2105324538, "PaymentMethod": 2 }, { "DigitableLine": "03399492813698211200901537301028400000000000000 ", "AccountDate": "2022-06-01T00:00:00", "Value": 354.7, "TransactionType": 1, "TransactionDateTime": "2022-06-01T15:00:00", "TransactionCode": "RECEBERCONTA", "TransactionId": 815977513, "NSU": 2107, "ExternalTerminal": "TesteMockado-3A977B5E-631D-4D59-8265-F780FDD3E373", "ExternalNSU": 966441828, "PaymentMethod": 2 } ], "pagination": { "page": 1, "totalCount": 10, "totalPages": 5, "hasPrevious": false, "hasNext": true } }
Tipos de movimentos (movement)
In the “movement” result, up to 15 different types of movements will be displayed, depending on the type of file searched for:
Movement
TransactionCode: RECEIVEBILL and RECHARGE
JSON
{ "DigitableLine": "03399492813698211200901537301028400000000000000 ", "AccountDate": "2022-06-01T00:00:00", "Value": 304.1, "TransactionType": 1, "TransactionDateTime": "2022-06-01T20:00:00", "TransactionCode": "RECEBERCONTA", "TransactionId": 815977512, "NSU": 97102, "ExternalTerminal": "TesteMockado-6C59770F-4A0A-4429-9C39-0ADBFFCDB525", "ExternalNSU": 2105324538, "PaymentMethod": 2 }, { "AccountDate": "2022-06-01T00:00:00", "Value": 440.47, "TransactionType": 10, "TransactionDateTime": "2022-06-01T09:00:00", "TransactionCode": "RECARGA", "TransactionId": 815977522, "NSU": 98992, "ExternalTerminal": "TesteMockado-673B5CCB-47B9-4722-ABDA-C430D2059053", "ExternalNSU": 1924016170, "PaymentMethod": 2 },
Refusal to move
TransactionCode: RECEIVEBILL
JSON
{ "DigitableLine": "03399492813698211200901537301028400000000000000 ", "AccountDate": "2022-06-01T00:00:00", "Value": 1439.98, "TransactionType": 1, "TransactionDateTime": "2022-05-31T02:00:00", "TransactionCode": "RECEBERCONTA", "TransactionId": 815977492, "NSU": 14481, "ExternalTerminal": "TesteMockado-719097FD-0256-46A5-83AA-24083AF95203", "ExternalNSU": 1145554405, "PaymentMethod": 2 },
Transfer Movement
TransactionCode: TRANSFERENCE
JSON
{ "CpfCnpj": "21174145080", "FullName": "Fulano de tal", "Bank": 341, "AccountType": 1, "Agency": 371, "Account": 9794865500, "VerifyingDigit": 2, "AccountDate": "2022-06-01T00:00:00", "Value": 2, "TransactionType": 33, "TransactionDateTime": "2022-05-31T11:55:20.393", "TransactionCode": "TRANSFERENCIA", "TransactionId": 815977375, "NSU": 0, "ExternalTerminal": "11122233344", "ExternalNSU": 19729, "PaymentMethod": 2 },
Transfer Refusal
TransactionCode: TRANSFERENCE
JSON
{ "RefusalMotive": "", "DevolutionDate": "02/06/2022 00:00", "CpfCnpj": "1825714699", "FullName": "Fulano de tal", "Bank": 212, "AccountType": 1, "Agency": 1, "Account": 485835, "VerifyingDigit": 2, "AccountDate": "2022-06-01T00:00:00", "Value": 1010.66, "TransactionType": 33, "TransactionDateTime": "2022-06-01T20:00:00", "TransactionCode": "TRANSFERENCIA", "TransactionId": 815977532, "NSU": 1269, "ExternalTerminal": "TesteMockado-2886A7CA-3A69-4A7D-A0C1-078A3394DB63", "ExternalNSU": 915547103, "PaymentMethod": 2 },
Electronic Receipt
TransactionCode: ELECTRONIC RECEIPT
JSON
{ "CpfCnpj": "833904217", "AccountDate": "2022-06-01T00:00:00", "Value": 599.15, "TransactionType": 32, "TransactionDateTime": "2022-06-01T08:00:00", "TransactionCode": "RECEBIMENTOELETRONICO", "TransactionId": 815977537, "NSU": 59340, "ExternalTerminal": "TesteMockado-80A5CADC-F080-4229-A1B5-3BF36B0BA4D3", "ExternalNSU": 1619674788, "PaymentMethod": 2 },
Electronic Payment
TransactionCode: ELECTRONIC PAYMENT
JSON
{ "CpfCnpj": "675801019", "AccountDate": "2022-06-01T00:00:00", "Value": 1385.34, "TransactionType": 36, "TransactionDateTime": "2022-06-01T02:00:00", "TransactionCode": "PAGAMENTOELETRONICO", "TransactionId": 815977542, "NSU": 25009, "ExternalTerminal": "TesteMockado-65EB1908-509E-4913-8390-A60DD7B40582", "ExternalNSU": 1652009408, "PaymentMethod": 2 },
Pix Payment
TransactionCode: PAYMENT
JSON
{ "ReceiverCpfCnpj": "12345678909", "TransactionIdentification": "8B94ACD6-AE05-43CB-9862-4595AE2D6C33", "EndToEnd": "E339655166", "ReceiverAccount": "1", "ReceiverAccountType": "CACC", "ReceiverBranch": 1, "ReceiverBank": 1, "ReceiverName": "Fulano de Tal", "PartnerId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ReceiverKey": "[email protected]", "ConfirmationDate": "2022-06-01T00:00:00.000", "AccountDate": "2022-06-01T00:00:00", "Value": 279.5, "TransactionType": 57, "TransactionDateTime": "2022-06-01T20:00:00", "TransactionCode": "PAYMENT", "TransactionId": 815977557, "NSU": 95338, "ExternalTerminal": "D63330B8-97EC-4BEF-9B25-5BDA2418EA8E", "ExternalNSU": 645017136, "PaymentMethod": 2 },
Pix Receipt
TransactionCode: RECIVEMENTPAYMENT
JSON
{ "TransactionIdentification": "DF0DA8D7-120E-4083-BCB4-3BE96E7E1127", "EndToEnd": "E716846145", "PayerCpfCnpj": "12345678909", "PayerKey": "TesteMockado", "PayerAccount": "1", "PayerAccountType": "TRAN", "PayerBranch": "1", "PayerBank": "1", "PartnerId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "AccountDate": "2022-06-01T00:00:00", "Value": 1906.82, "TransactionType": 58, "TransactionDateTime": "2022-06-01T10:00:00", "TransactionCode": "RECIVEMENTPAYMENT", "TransactionId": 815977577, "NSU": 2989, "PaymentMethod": 2 },
Pix Return of Receipt
TransactionCode: RECIVEMENTREVERSEPAYMENT
JSON
{ "AccountDate": "2022-06-01T00:00:00", "Value": 743.81, "TransactionType": 60, "TransactionDateTime": "2022-06-01T01:00:00", "TransactionCode": "RECIVEMENTREVERSEPAYMENT", "TransactionId": 815977572, "NSU": 96331, "ExternalNSU": 98563707, "PaymentMethod": 2 },
Pix Payment Refund
TransactionCode: REVERSEPAYMENT
JSON
{ "ReturnIdentification": "D1057929537", "AccountDate": "2022-06-01T00:00:00", "Value": 818.28, "TransactionType": 59, "TransactionDateTime": "2022-06-01T09:00:00", "TransactionCode": "REVERSEPAYMENT", "TransactionId": 815977567, "NSU": 55965, "ExternalTerminal": "433327", "ExternalNSU": 967313962, "PaymentMethod": 2 },
Pix Contribution
TransactionCode: RECIVEMENTPAYMENT
JSON
{ "TransactionIdentification": "TesteMockado-0819EF38-2DFB-4D57-B8A5-A00FB030E333", "EndToEnd": "E864280851", "CreditKey": "TesteMockado", "CreditAccount": "2097", "CreditAccountType": "TRAN", "CreditBranch": "1", "CreditBank": "13935893", "AccountDate": "2022-06-01T00:00:00", "Value": 346.64, "TransactionType": 58, "TransactionDateTime": "2022-06-01T06:00:00", "TransactionCode": "RECIVEMENTPAYMENT", "TransactionId": 815977562, "NSU": 57332, "PaymentMethod": 2 },
International Recharge
TransactionCode: INTERNATIONAL RECHARGE
JSON
{ "CountryCode": "8", "Phone": "99999-9999", "ValueDollar": 8.5200, "AccountDate": "2022-06-01T00:00:00", "Value": 142.26, "TransactionType": 45, "TransactionDateTime": "2022-06-01T15:00:00", "TransactionCode": "RECARGAINTERNACIONAL", "TransactionId": 815977552, "NSU": 19690, "ExternalTerminal": "TesteMockado-378B1D09-B755-47AE-AFB8-3632AA83F57F", "ExternalNSU": 533476834, "PaymentMethod": 2 },
Vehicle Debt Query
TransactionCode: VEHICLEDEBTCHECK
JSON
{ "AccountDate": "2022-06-01T00:00:00", "Value": 1596.5, "TransactionType": 67, "TransactionDateTime": "2022-06-01T09:00:00", "TransactionCode": "VEHICLEDEBTCHECK", "TransactionId": 815977512, "PaymentMethod": 2, "ClientRequestId": "lorem ipsum" },
Vehicle Debt Settlement
TransactionCode: DEBITVEICULAR
JSON
{ "AccountDate": "2022-06-01T00:00:00", "Value": 1596.5, "TransactionType": 68, "TransactionDateTime": "2022-06-01T09:00:00", "TransactionCode": "DEBITOVEICULAR", "TransactionId": 815988324, "PaymentMethod": 2, "ClientRequestId": "lorem ipsum", "PaymentId": "015CA139-56E5-4D12-94FC-DCCD9CE0CB26" },
TED - Cashin
TransactionCode: TEDCASHIN
JSON
{ "AccountDate": "2025-02-01T00:00:00", "Value": 4741.03, "TransactionType": 82, "TransactionDateTime": "2025-02-01T09:00:00", "TransactionCode": "TEDCASHIN", "TransactionId": 815988324, "PaymentMethod": 2, "ClientRequestId": "lorem ipsum", "PaymentId": "015CA139-56E5-4D12-94FC-DCCD9CE0CB26", "ExportFileId": 3865218 },
TED - Cashout
TransactionCode: TEDCASHOUT
JSON
{ "AccountDate": "2025-02-01T00:00:00", "Value": 193.33, "TransactionType": 81, "TransactionDateTime": "2023-02-01T09:00:00", "TransactionCode": "TEDCASHOUT", "TransactionId": 815988324, "PaymentMethod": 2, "ClientRequestId": "lorem ipsum", "PaymentId": "015CA139-56E5-4D12-94FC-DCCD9CE0CB26", "ExportFileId": 3849455 },
Field description
Below is a list with a description of the fields returned in the requests:
| Field | Type | Description |
|---|---|---|
| DigitableLine | String | Digital line for payment |
| AccountDate | DateTime | Transaction settlement date |
| Value | float | Amount paid |
| TransactionType | Int16 | Transaction type code |
| TransactionDateTime | Datetime | Transaction Date and Time |
| TransactionCode | String | Transaction code |
| TransactionId | BigInt | The protocol generated by TodaConta |
| NSU | Int32 | User transaction identifier |
| ExternalTerminal | String | Client system terminal identifier |
| ExternalNSU | Int64 | Client system transaction identifier |
| PaymentMethod | Int32 | Payment Method Code |
| CpfCnpj | String | CPF or CNPJ of the customer making the payment |
| FullName | String | Full name of bank account |
| bank | Int32 | Bank Account Number |
| AccountType | Int32 | Bank account type |
| Agency | Int32 | Agency without bank account verification digit |
| Account | Int32 | Bank account number without check digit |
| VerifyingDigit | Int32 | Bank account verification digit |
| RefusalMotive | String | Reason for return |
| DevolutionDate | String | Return date |
| TransactionIdentification | String | Unique transaction identifier from a QR Code |
| EndToEnd | String | Transaction participant identifier |
| Branch | Int32 | In the case of a Pix transaction, Branch number |
| PayerKey | String | Pix key number that will receive the payment |
| Payer Account | String | Account number that will receive the payment |
| PayerCpfCnpj | String | Document of the person who will receive the payment |
| PayerAccountType | String | Type of account that will receive the payment |
| PayerBranch | String | Identifier of the bank that will receive the payment |
| PayerBank | String | Identification number of the participant who will receive the payment |
| ReceiverCpfCnpj | String | Document of the person who will make the payment |
| ReceiverAccount | String | Account number that will make the payment |
| ReceiverAccountType | String | Type of account that will make the payment |
| ReceiverBranch | String | Bank identifier where you will make the payment |
| ReceiverBank | String | Identification number of the participant who will make the payment |
| ReceiverName | String | Full name of the person making the payment |
| ReceiverKey | String | Pix key number that will make the payment |
| ReturnIdentification | String | Pix payment return identifier number |
| CountryCode | String | Country code |
| Phone | String | Phone number |
| ValueDollar | Decimal | Transaction value in dollars |
| RemittanceInformation | String | Text to be presented to the payer so that he can enter related information |
| ClientRequestId | String | Client system terminal identifier |
| PaymentId | String | The protocol generated by the institution |
| PartnerId | String | Transaction identifier |
️ Attention!
To test this API, it is necessary to carry out one or more transactions (Pix, Boleto, Automatic Debit, etc.) for there to be a return.
It is important to note that queries on this endpoint will only be presented the day after the transaction is processed, as our Sandbox environment has the same behavior as the Production environment.
Attention!
This API will only return files generated from July/2022 onwards, being restricted to the last 6 months for reconciliation.