Consultar Status de uma pagamento de Boleto
Essa funcionalidade permite que os clientes BaaS da Celcoin consigam consultar pagamentos de boletos a partir das contas de seus cliente.
Pré requisitos para implementação:
-
Possuir uma chave api da Celcoin, para mais informações acessar esse link
-
Ter familiaridade com o padrão REST usando o protocolo OAuth 2.0.
-
Ter o produto/solução contratado e habilitado em produção.
- Caso queira usar a funcionalidade em ambiente produtivo, por favor entre em contato com a nossa equipe comercial através do e-mail [email protected]. Para dúvidas técnicas, basta entrar em contato com o suporte através do link.
-
Possuir uma conta no BaaS da Celcoin (Conta essa responsável por receber o valor da cobrança)
-
Possuir um identificador de uma pagamento de boleto.
Passos para Integrar
- Realizar autenticação na API - [API Reference]
- Consultar Pagamento do Boleto - [API Reference]
Consultar pagamento do Boleto
cURL da chamada
curl -X GET "https://sandbox.openfinance.celcoin.dev/baas/v2/billpayment/status?ClientRequestId=5555&Id=ce9b8d9b-0617-42e1-b500-80bf9d8154cf" -H "accept: application/json" -H "Authorization: {token}"
Exemplo de retorno
Sucesso 200
{
"body": {
"id": "10a806a1-267g-5803-93e3-fc215a8b156f",
"clientRequestId": "clientRequest01",
"account": 321,
"amount": 5,
"transactionIdAuthorize": 123,
"hasOccurrence": false,
"tags": [
{
"key": "PaymentType",
"value": "Contas Internas"
}
],
"barCodeInfo": {
"digitable": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"paymentDate": "2023-09-01T00:00:00Z"
},
"status": "CONFIRMED",
"version": "1.1.0"
}
Campo | Descrição | Tipo Campo |
---|---|---|
id | Identificador interno gerado pela Celcoin.. | string |
clientRequestId | Identificador do cliente.. | string |
account | Numero da conta onde ocorreu o débito. | number |
amount | Valor pago. | number |
transactionIdAuthorize | ProtocoloId retornado no endpoint Authorize. | integer($int32) |
hasOccurrence | Caso exista uma ocorrencia no pagamento esta campo virá como true. | boolean |
paymentDate | Data e hora do pagamento. | string($date-time) example: 2022-08-31T17:19:55.0000000 |
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CBE001",
"message": "Ocorreu um erro interno durante a chamada da api."
}
}
Tabela de errorCode
Code | Message |
---|---|
PCE001 | É obirgatório informar o campo clientRequestId. |
PCE002 | O campo account ultrapassou os 20 caracteres permitidos. |
PCE003 | É obrigatório informar o campo account. |
PCE004 | É necessário informar o campo barcodeInfo.digitable ou barcodeInfo.barcode. |
PCE005 | Apenas um dos campos devem estar preenchido, barcodeInfo.digitable ou barcodeInfo.barcode. |
PCE006 | Conta informada esta encerrada. |
PCE007 | Conta informada esta bloqueada. |
PCE008 | Conta informada esta com pendências no KYC. |
PCE009 | O campo transactionIdAuthorize é obrigatório. |
PCE010 | Conta não encontrada. |
PCE011 | O campo clientRequestId não pode conter mais de 20 caracteres. |
PCE012 | O campo amount esta inválido. |
PCE013 | É obirgatório informar o campo amount. |
PCE014 | O campo amount de ser a partir de 0.01. |
PCE015 | Cliente não esta ativo para utilizar a Api. |
PCE016 | É obirgatório informar o clientRequestId ou id. |
PCE018 | Não foi encontrada nenhuma transação com os parâmetros informados. |
PCE019 | Operação não realizada. Cliente não esta autorizado para esse produto. |
PCE024 | Request fora do padrão. Favor verificar a documentação. |
PCE025 | Já existe um pagamento com o mesmo clientRequestId. |
PCE026 | Já existe um pagamento com o mesmo transactionIdAuthorize |
Updated 3 months ago