Pix receipts query
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.
-
If you have purchased the product/solution, and wish to use the functionality in a production environment, please contact our sales team via email at [email protected]. For technical questions, simply contact support via the link .
Criamos esta API para cenários em que não é possível garantir a disponibilidade total do seu ambiente para receber todos os gatilhos de transferências ou pagamentos da API Pix Celcoin, bem como para tratamento de erros inesperados, como respostas 5xx.
Seu uso é recomendado apenas para fluxos de exceção ou conferência de recebimentos, pois, nos demais casos, todas as informações já são disponibilizadas via webhook. Em caso de não recebimento do evento, utilize primeiro o serviço de Reenvio de Webhook e, se necessário, realize a consulta.
So a use case would be:
As a fintech, I want to build a predictive search measure on my application side, with the aim of validating information or the existence of a Pix receipt, so that my end user does not have problems with their receipts and reconciliation problems are avoided.
Search for data from a receipt
This endpoint is intended for querying any Pix receipt. To perform this search, we provide the API Query the status of a Pix Receipt . In this query, you can pass the following search parameters:
endtoEnd- EndtoEnd do recebimento (webhook)
transactionId- Receipt identifier (webhook)
transactionIdBrCode - TransactionID returned when creating the QRCode.
É necessário informar pelo menos um dos campos para realizar a consulta.
Request model:
cURL
curl --request GET \ --url 'https://sandbox.openfinance.celcoin.dev/pix/v1/receivement/status?endtoEnd=0&transactionId=0&transactionIdBrCode=0' \ --header 'accept: application/json' \ --header 'authorization: Bearer {access_token}'
Return model:
JSON
{ "requestBody": { "transactionType": "RECEIVEPIX", "transactionId": 761679887, "amount": 118, "debitParty": { "account": "1234567", "bank": "12345678", "branch": "30", "personType": "NATURAL_PERSON", "taxId": "12345678901", "accountType": "CACC", "name": "Celcoin TESTE Ltda" }, "creditParty": { "bank": "12345677", "branch": "30", "account": "1234567", "personType": "LEGAL_PERSON", "taxId": "12345678000123", "accountType": "CACC", "name": "CELCOIN TESTE INTERNO LTDA", "key": "f3197f49-2615-41eb-9df2-e6224ebb4470" }, "endToEndId": "E18236120202001199999s0149012FPC", "transactionIdentification": "kk6g232xel65a0daee4dd13kk761678748", "transactionIdBRCode": "761678748", "initiationType": "MANUAL", "transactionTypePix": "TRANSFER", "paymentType": "IMMEDIATE", "urgency": "HIGH" } }
The query on this endpoint will only return data if the identifiers provided are related to a received Pix, that is, after receiving the trigger via webhook .
Search for data from a receipt (Enriched Version (V2))
This endpoint is also intended for querying any Pix receipt, but it accepts the identifier used to create the QRCode ("clientRequestId"). To perform this search, we provide the API Query the status of a Pix Receipt - Enriched Version (V2) . In this query, you can pass the following search parameters:
endtoEnd- EndtoEnd do recebimento (webhook).
transactionId- Receipt identifier (webhook).
transactionIdBrCode- TransactionID returned when creating the QRCode.
clientRequestId- Unique identifier provided by the customer when creating a QRCode.
É necessário informar pelo menos um dos campos para realizar a consulta.
The clientRequestId field is a unique identifier that must be generated by the client when creating the QR Code. If there is more than one QR Code generated with the same identifier, the query will return only the first QR Code generated. It will not be possible to search for other QR Codes using this search parameter.
Request model:
cURL
curl --request GET \ --url 'https://sandbox.openfinance.celcoin.dev/pix/v2/receivement/v2/status?endtoEnd=0&transactionId=0&transactionIdBrCode=0&clientRequestId=0' \ --header 'accept: application/json' \ --header 'authorization: Bearer {access_token}'
Modelo de retorno: com status = CONFIRMED
JSON
{ "requestBody": { "status": "CONFIRMED", "transactionType": "RECEIVEPIX", "transactionId": 202603110000000531, "amount": 0.66, "endToEndId": "E30944783202603111754035824df3da", "createTimestamp": "03/11/2026 17:54:08", "transactionIdentification": "kk6g232xel65a0daee4dd13kk4000550509", "transactionIdBRCode": "4000550509", "initiationType": "DYNAMIC_QRCODE", "transactionTypePix": "TRANSFER", "paymentType": "IMMEDIATE", "urgency": "HIGH", "debitParty": { "account": "50024", "bank": "30944783", "branch": "0001", "personType": "LEGAL_PERSON", "taxId": "11935552000108", "accountType": "CACC", "name": "INVIZZA" }, "creditParty": { "bank": "13935893", "branch": "0001", "account": "30054126591", "personType": "LEGAL_PERSON", "taxId": "18700590000120", "accountType": "TRAN", "name": null, "key": "888e7c1a-00b9-4205-bae1-576ee2c7ffe1" }, "clientRequestId": null } }
Modelo de retorno com status = PENDING Caso onde a transação ainda está em análise pelo bloqueio cautelar.
JSON
{ "requestBody": { "status": "PENDING", "transactionType": "RECEIVEPIX", "transactionId": 202603110000000531, "amount": 0.66, "endToEndId": "E30944783202603111754035824df3da", "createTimestamp": "03/11/2026 17:54:08", "transactionIdentification": "kk6g232xel65a0daee4dd13kk4000550509", "transactionIdBRCode": "4000550509", "initiationType": "DYNAMIC_QRCODE", "transactionTypePix": "TRANSFER", "paymentType": "IMMEDIATE", "urgency": "HIGH", "debitParty": { "account": "50024", "bank": "30944783", "branch": "0001", "personType": "LEGAL_PERSON", "taxId": "12345678910", "accountType": "CACC", "name": "Beltrano" }, "creditParty": { "bank": "13935893", "branch": "0001", "account": "30054126591", "personType": "LEGAL_PERSON", "taxId": "12345678910", "accountType": "TRAN", "name": "Fulano", "key": "888e7c1a-00b9-4205-bae1-576ee2c7ffe1" }, "clientRequestId": null } }
The query on this endpoint will only return data if the identifiers provided are related to a received Pix, that is, after receiving the trigger via webhook .