Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Busca recorrências por status com paginação

get/automatic/recurrencies/authorization/status/{status}

Path parameters

status'PENDING_DEBIT_PARTY' | 'PENDING_CREDIT_PARTY' | 'CONFIRMED' | 'CANCELLATION_REQUEST' | 'CANCELLING' | 'CANCELLED' | 'EXPIRED' | 'ERROR' required

Status da recorrência.

Query parameters

page-sizeinteger

Tamanho da página (1-50)

pageinteger

Número da página (1+)

Response

200

statusinteger
versionstring

Example response

{
  "version": "string",
  "body": [
    {
      "id": "string",
      "deniedReason": "string",
      "cancellingReason": "string",
      "status": "string",
      "journeys": [
        {
          "status": "string",
          "type": "string",
          "accepetedDate": "2025-06-02T10:59:18.445Z",
          "denyDate": "2025-06-02T10:59:18.445Z"
        }
      ],
      "interval": {
        "start": "2025-06-02T10:59:18.445Z",
        "end": "2025-06-02T10:59:18.445Z",
        "frequencyType": "string"
      },
      "frequencyType": "string",
      "creditParty": {
        "taxId": "string",
        "name": "string"
      },
      "debitParty": {
        "personType": "string",
        "taxId": "string",
        "bank": "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-02T10:59:18.445Z"
      },
      "createDate": "2025-06-02T10:59:18.445Z",
      "updateDate": "2025-06-02T10:59:18.445Z",
      "deleteDate": "2025-06-02T10:59:18.445Z",
      "cancelledDate": "2025-06-02T10:59:18.445Z"
    }
  ]
}