v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Cancelamento da recorrência

post/automatic/recurrencies/{recurrencyId}/cancel

Path parameters

recurrencyIdstring required

identificador único

Request body

cancellingReasonstring required

Motivo do cancelamento

Response

200

versionstring
statusinteger

Example response

{
  "version": "1.0.0",
  "status": 200,
  "body": {
    "recurrencyId": "RC139358932025060749927585294",
    "clientRequestId": "idasasdddas-dasdasdasd-dadadasdas-ddasdasdassd",
    "interval": {
      "start": "2025-06-07T09:45:00-03:00",
      "frequencyType": "MONTHLY"
    },
    "status": "CANCELLATION_REQUEST",
    "journeys": [
      {
        "status": "CANCELLATION_REQUEST",
        "type": 2,
        "createDate": "2025-06-07T09:45:00-03:00"
      }
    ],
    "amount": 100,
    "creditParty": {
      "bank": "13935893",
      "branch": "10203040",
      "account": "98765-4",
      "taxId": "19297016000136",
      "name": "Empresa Fictícia"
    },
    "debitParty": {
      "bank": "10203040",
      "personType": "NATURAL_PERSON",
      "taxId": "00011122233",
      "accountType": "CACC",
      "branch": "10203040",
      "account": "98765-4",
      "stateCode": "3505708"
    },
    "debtor": {
      "personType": "NATURAL_PERSON",
      "taxId": "67167948080",
      "name": "Pessoa Fictícia"
    },
    "contract": {
      "number": "Contrato-12345",
      "description": "Contrato de teste "
    },
    "allowsNewAttemptsAfterExpiration": true,
    "createDate": "2025-06-07T09:45:00-03:00",
    "cancellation": {
      "id": "IC139358932025060792624279100",
      "cancelledBy": "CREDIT",
      "taxId": 19297016000136,
      "reason": "ACCOUNT_CANCELLATION",
      "date": "2025-06-07T09:45:00-03:00"
    }
  }
}