CEcelcoin

Consulta lista de recorrências

get/automatic/recurrencies/list

Request

  • Base URL
    https://sandbox.openfinance.celcoin.dev/baas/v2
  • URL
    https://sandbox.openfinance.celcoin.dev/baas/v2/automatic/recurrencies/list
  • Auth
    OAuth 2

Query parameters

dateFromstring

a partir da data (em formato datetime)

dateTostring

Até a data (em formato de datetime)

statusstring
accountstring
pageinteger
page-sizeinteger
clientIdstring

Identificador único do cliente

Response

200

statusinteger
versionstring

Example response

{
  "version": "string",
  "body": {
    "hasMore": true,
    "recurrencies": [
      {
        "recurrencyId": "RR1393589320250712ObmNYRB9dYH",
        "clientRequestId": "70db791c-f460-4656-8593-975d8cf9d055",
        "interval": {
          "start": "string",
          "end": "string",
          "frequencyType": "MONTHLY"
        },
        "status": "CREATED",
        "journeys": [
          {
            "status": "string",
            "createDate": "2026-09-08T17:26:43.628Z"
          }
        ],
        "amount": 10,
        "recurrencyMinAmount": 10,
        "creditParty": {
          "bank": "string",
          "taxId": "string",
          "name": "string",
          "branch": "string",
          "account": "string"
        },
        "debitParty": {
          "personType": "string",
          "taxId": "string",
          "bank": "string",
          "account": "string",
          "branch": "string"
        },
        "debtor": {
          "personType": "string",
          "taxId": "string",
          "name": "string"
        },
        "contract": {
          "number": "string",
          "description": "string"
        },
        "cancellation": {
          "id": "string",
          "personType": "string",
          "taxId": "string",
          "reason": "string",
          "date": "2026-09-08T17:26:43.628Z"
        },
        "createDate": "2025-07-11T22:43:39.821Z",
        "acceptanceDate": "2025-07-11T22:43:39.821Z",
        "denyDate": "2026-09-08T17:26:43.628Z",
        "updateDate": "2026-09-08T17:26:43.628Z",
        "expirationDate": "2025-07-08T23:59:59"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.