Sobre API de Conciliação
O que é Conciliação?
Do ponto de vista financeiro, conciliação é o ato de fazer o levantamento de todas as contas e recebimentos da empresa e comparar com os valores que entraram e saíram da sua conta bancária, essencial para a saúde financeira de qualquer negócio.
Por que fazer a conciliação na Celcoin?
A conciliação é necessária para conferir os extratos de operações realizadas pelas APIs da Celcoin com o seu fluxo de caixa, garantindo transparência e permitindo identificar possíveis divergências.
Pré requisitos para implementação:
- Possuir uma chave API da Celcoin, para mais informações acessar esse link.
- Ter familiaridade com APIs Rest usando o protocolo OAuth 2.0.
Esta funcionalidade tem o objetivo de facilitar a conciliação de transações entre o cliente e a Celcoin, possibilitando uma manipulação mais eficiente dos dados e uma estabilidade de retorno constante e mais seguro.
Caso de uso:
Como fintech, quero consultar, via API, os tipos de transações contidos nos arquivos de movimentação contábil gerados anteriormente para poder realizar minha conciliação com a Celcoin.
Buscar tipos de arquivo
A API Buscar tipos de arquivos de conciliação mostra todos os tipos de arquivos disponíveis para conciliação.
Modelo de request:
curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/tools-conciliation/v1/exportfile/types' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {access_token}'
Modelo de response:
[
{
"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": 43,
"description": "Pagamento DA"
},
{
"fileType": 46,
"description": "Consulta Debito Veicular"
},
{
"fileType": 47,
"description": "Liquidacao Debito Veicular"
}
]
Extrair arquivos
A API Extrair arquivo de conciliação permite buscar em D+1 os arquivos de conciliação de determinado produto através do tipo de arquivo (retornado anteriormente) e data contábil.
Nesta consulta é possível passar os seguintes parâmetros de busca:
- fileType - Identificador do tipo de arquivo buscado.
- accountDate – Data contábil do arquivo buscado, seguindo formato AAAA-MM-DD.
- page - Identificador da página da listagem retornada.
- quantity - Identificador da quantidade por página retornada. Por default o tamanho é 10.000.
️ Atenção!
É necessário informar pelo menos fileType e accountDate para realizar a consulta.
A pesquisa dos arquivos de conciliação do dia anterior estarão disponíveis a partir das 6h00 do dia corrente.
OBS: O parâmetro accountDate (data contábil) se refere à data de liquidação da operação, sendo diferente da data de transação, que é a data em que a operação foi realizada.
Modelo de request:
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}'
Modelo de response:
{
"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
}
}
No resultado de “movement”, serão apresentados até 15 tipos de movimentos diferentes, dependendo do tipo arquivo buscado:
Movimentação
Arquivo de retorno de movimentação para as transações com sucesso de pagamento de contas e recarga realizadas no sistema;
{
"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
},
Recusa Movimentação
Arquivo de retorno de recusa de movimentação para as transações de pagamento de contas devolvidas por compensação realizadas no sistema;
{
"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ência Movimentação
Arquivo de retorno de movimentação para as transações com sucesso de transferências realizadas no sistema;
{
"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ência Recusa
Arquivo de retorno de recusa de movimentação para as transações de transferências realizadas no sistema;
{
"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
},
Recebimento Eletrônico
Arquivo de retorno de movimentação para as transações com sucesso de recebimento eletrônico realizados no sistema;
{
"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
},
Pagamento Eletrônico
Arquivo de retorno de movimentação para as transações com sucesso de pagamento eletrônico realizados no sistema;
{
"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 Pagamento
Arquivo de retorno de movimentação para as transações com sucesso de pix pagamento realizados no sistema;
{
"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 Recebimento
Arquivo de retorno de movimentação para as transações com sucesso de pix recebimento realizados no sistema;
{
"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 Devolução de Recebimento
Arquivo de retorno de movimentação para devolução de transações de pix recebimento realizados no sistema;
{
"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 Devolução de Pagamento
Arquivo de retorno de movimentação para devolução de transações de pix pagamento realizados no sistema;
{
"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 Aporte
Arquivo de retorno de movimentação para as transações com sucesso de pix aporte realizados no sistema;
{
"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
},
Recarga Internacional
Arquivo de retorno de movimentação para as transações com sucesso de recarga internacional realizados no sistema;
{
"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
},
Pagamento DA
Arquivo de retorno de movimentação para as transações com sucesso de pagamento débito automático realizados no sistema;
{
"AccountDate": "2022-06-01T00:00:00",
"Value": 1596.5,
"TransactionType": 62,
"TransactionDateTime": "2022-06-01T09:00:00",
"TransactionCode": "RECEBERCONTADA",
"TransactionId": 815977547,
"NSU": 49380,
"ExternalTerminal": "TesteMockado-05F0968F-571D-4769-B610-48276A99F754",
"PaymentMethod": 2
},
Consulta Débito Veicular
Arquivo de retorno de movimentação para as consultas com sucesso de débitos veiculares realizados no sistema;
{
"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"
},
Liquidação Débito Veicular
Arquivo de retorno de movimentação para as transações com sucesso de débitos veiculares realizados no sistema;
{
"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"
},
Descrição dos campos
A seguir, a lista com a descrição dos campos retornados nas requisições:
| Campo | Tipo | Descrição |
|---|---|---|
| DigitableLine | String | Linha digitável para pagamento |
| AccountDate | DateTime | Data liquidação da transação |
| Value | float | Valor pago |
| TransactionType | Int16 | Código do tipe de transação |
| TransactionDateTime | Datetime | Data e Hora da transação |
| TransactionCode | String | Código da transação |
| TransactionId | BigInt | O protocolo gerado pelo TodaConta |
| NSU | Int32 | Identificador da transação do usuário |
| ExternalTerminal | String | Identificador do terminal do sistema cliente |
| ExternalNSU | Int64 | Identificador da transação do sistema cliente |
| PaymentMethod | Int32 | Código da Forma de Pagamento |
| CpfCnpj | String | CPF ou CNPJ do cliente que está realizando o pagamento |
| FullName | String | Nome completo da conta bancária |
| Bank | Int32 | Número do Banco da conta bancária |
| AccountType | Int32 | Tipo da conta bancária |
| Agency | Int32 | Agência sem dígito verificador da conta bancária |
| Account | Int32 | Número da conta bancária sem dígito verificador |
| VerifyingDigit | Int32 | Dígito verificador da conta bancária |
| RefusalMotive | String | Motivo de devolução |
| DevolutionDate | String | Data de devolução |
| TransactionIdentification | String | Identificador único da transação proveniente de um QR Code |
| EndToEnd | String | Identificador dos participantes da transação |
| Branch | Int32 | No caso de transação pix, Número da agência |
| PayerKey | String | Número chave pix que receberá o pagamento |
| PayerAccount | String | Número da conta que receberá o pagamento |
| PayerCpfCnpj | String | Documento da pessoa que receberá o pagamento |
| PayerAccountType | String | Tipo de conta que receberá o pagamento |
| PayerBranch | String | Identificador do banco que receberá o pagamento |
| PayerBank | String | Número identificador do participant que receberá o pagamento |
| ReceiverCpfCnpj | String | Documento da pessoa que realizará o pagamento |
| ReceiverAccount | String | Número da conta que realizará o pagamento |
| ReceiverAccountType | String | Tipo de conta que realizará o pagamento |
| ReceiverBranch | String | Identificador do banco no qual realizará o pagamento |
| ReceiverBank | String | Número identificador do participant que realizará o pagamento |
| ReceiverName | String | Nome completo da pessoa que realizará o pagamento |
| ReceiverKey | String | Número chave pix que realizará o pagamento |
| ReturnIdentification | String | Número identificador de retorno do pagamento pix |
| CountryCode | String | Código do país |
| Phone | String | Número de telefone |
| ValueDollar | Decimal | Valor da transação em dólar |
| RemittanceInformation | String | Texto a ser apresentado ao pagador para que possa introduzir uma informação correlacionada |
| ClientRequestId | String | Identificador do terminal do sistema cliente |
| PaymentId | String | O protocolo gerado pela instituição |
| PartnerId | String | Identificador da transação |
️ Atenção!
Para testar essa API é necessario realizar uma ou mais transações (Pix, Boleto, Debito automático e etc.) para que haja retorno.
É importante ressaltar que as consultas neste endpoint só serão apresentadas no dia posterior ao processamento da transação, pois nosso ambiente de Sandbox tem o mesmo comportamento que o de Produção.
Atenção!
Essa API somente retornará arquivos gerados a partir de Julho/2022, ficando restrito aos últimos 6 meses para conciliação.
Updated 2 months ago