Consultas - Visão Pagador

A Celcoin disponibilizará uma funcionalidade de consulta para os clientes pagadores, onde será possível que o cliente consulte o status das recorrências pendentes de aceite, dos consentimentos ativos e também dos consentimentos cancelados.

Dessa forma, será possível acompanhar todos os eventos relacionados a uma recorrência, para auxiliar no processo de gestão dos pagamentos deste cliente pagador.


📘

Tipos de consulta

É possível consultar as recorrências de duas maneiras distintas:

Consulta por ID: Busque uma recorrência específica informando seu identificador único.

Listagem por Status com Paginação: Visualize recorrências filtradas por status, com os resultados apresentados em formato paginado.

Passos para Integrar

  1. Realizar autenticação na API - [API Reference]
  2. Realiza a consulta na API
    1. Consulta por ID - [Reference]
    2. Listagem por Status - [Reference]


Consultar recorrência por ID

Parâmetros:

CampoDescrição
{id}ID da recorrência no formato RRxxxxxxxxyyyyMMddkkkkkkkkkkk

cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v2/recurrencies/authorization/{id}' \
--header 'accept: application/json' \
--header 'authorization: Bearer {{token}}'

Exemplo de retorno

👍

Sucesso 200

{
  "status": 0,
  "version": "string",
  "body": {
    "id": "string",
    "deniedReason": "string",
    "cancellingReason": "string",
    "status": "string",
    "journeys": [
      {
        "status": "string",
        "type": 0,
        "accepetedDate": "2025-06-08T22:15:40.008Z",
        "denyDate": "2025-06-08T22:15:40.008Z"
      }
    ],
    "interval": {
      "start": "2025-06-08T22:15:40.008Z",
      "end": "2025-06-08T22:15:40.008Z",
      "frequencyType": "string"
    },
    "frequencyType": "string",
    "amount": 0,
    "creditParty": {
      "taxId": "string",
      "name": "string",
      "bank": "string"
    },
    "debitParty": {
      "personType": "string",
      "taxId": "string",
      "bank": "string",
      "branch": "string",
      "account": "string",
      "stateCode": "string"
    },
    "debtor": {
      "personType": "string",
      "taxId": "string",
      "name": "string"
    },
    "contract": {
      "number": "string",
      "description": "string"
    },
    "cancellation": {
      "id": "string",
      "cancelledBy": "string",
      "personType": "string",
      "taxId": "string",
      "reason": "string",
      "date": "2025-06-08T22:15:40.008Z"
    },
    "createDate": "2025-06-08T22:15:40.008Z",
    "updateDate": "2025-06-08T22:15:40.008Z",
    "deleteDate": "2025-06-08T22:15:40.008Z",
    "cancelledDate": "2025-06-08T22:15:40.008Z"
  }
}

Error 400

{
  "status": 100,
  "version": "string",
  "error": {
    "errorCode": "string",
    "message": "string"
  }
}



Consultar recorrências por status com paginação


Parâmetros:

CampoDescrição
statusStatus da recorrência. Valores válidos:

PENDING_DEBIT_PARTY
PENDING_CREDIT_PARTY
CONFIRMED
CANCELLATION_REQUEST
CANCELLING
CANCELLED
EXPIRED
ERROR
page-sizeTamanho da página (1-50) | Default value : 10
pageNúmero da página (1+) | Default value : 1


cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v2/recurrencies/authorization/status/{status}' \
--header 'accept: application/json' \
--header 'authorization: Bearer {{token}}'

Exemplo de retorno

👍

Sucesso 200

{
   "status":0,
   "version":"1.0",
   "body":{
      "totalItems":1,
      "currentPage":1,
      "totalPages":1,
      "recurrrences":[
         {
            "status":200,
            "version":"1.0",
            "body":{
               "id":"RR0435879820240920njua7shf40o",
               "deniedReason":"CREDIT_PARTY_IS_NOT_KNOWN",
               "cancellingReason":"ACCOUNT_CANCELLATION",
               "status":"PENDING_CREDIT_PARTY",
               "journeys":[
                  {
                     "status":"ACCEPTED",
                     "type":1,
                     "accepetedDate":"2025-05-10T10:15:00Z",
                     "denyDate":null
                  }
               ],
               "interval":{
                  "start":"2025-06-01T00:00:00Z",
                  "end":"2025-12-01T00:00:00Z",
                  "frequencyType":"MONTHLY"
               },
               "frequencyType":"MONTHLY",
               "amount":50,
               "creditParty":{
                  "taxId":"12345678000199",
                  "name":"Loja Virtual Ltda",
                  "bank":"13935893"
               },
               "debitParty":{
                  "personType":"NATURAL_PERSON",
                  "taxId":"98765432100",
                  "bank":"13935893",
                  "branch":"4444",
                  "branch":"0001",
                  "account":"12345-6",
                  "stateCode":"SP"
               },
               "debtor":{
                  "personType":"NATURAL_PERSON",
                  "taxId":"98765432100",
                  "name":"João da Silva"
               },
               "contract":{
                  "number":"CONTR-2025-PIX-001",
                  "description":"Assinatura mensal do plano premium"
               },
               "cancellation":null,
               "createDate":"2025-05-01T08:00:00Z",
               "updateDate":"2025-05-15T10:30:00Z",
               "deleteDate":"2025-05-20T00:00:00Z",
               "cancelledDate":"2025-05-16T15:03:07.709Z"
            }
         }
      ]
   }
}

Error 400

{
  "status": 100,
  "version": "string",
  "error": {
    "errorCode": "string",
    "message": "string"
  }
}

❗️

Esta documentação ainda está sujeita a atualizações. Quando tivermos a versão final publicada, este aviso será removido de todas as páginas.