Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Cancelamento de Autorização

post/pix-indirect/v1/automatic/recurrencies/authorization/{id}/cancel

Path parameters

idstring required

id da autorização

Request body

cancellingReason'ACCOUNT_CANCELLATION' | 'CREDIT_PARTY_END_OF_ACTIVITIES' | 'PAYER_DEAD' | 'CONFIRMATION_ERROR' | 'FRAUD' | 'CONFIRMED_IN_OTHER_JOURNEY' | 'CREDIT_PARTY_REQUEST' | 'DEBIT_PARTY_REQUEST' | 'TIMEOUT' required

Motivos de cancelamento:

ACCOUNT_CANCELLATION = Motivado por cancelamento da conta do usuário pagador ou do usuário recebedor

CREDIT_PARTY_END_OF_ACTIVITIES = Motivado por encerramento da empresa recebedora

PAYER_DEAD = Motivado por falecimento do usuário pagador

FRAUD = Motivado por suspeita de fraude

DEBIT_PARTY_REQUEST = Solicitado pelo participante do usuário pagador

Response

200

statusinteger
versionstring

Example response

{
  "version": "string",
  "body": {
    "id": "string",
    "deniedReason": "string",
    "cancellingReason": "string",
    "status": "string",
    "journeys": [
      {
        "status": "string",
        "accepetedDate": "2026-03-30T17:54:36.517Z",
        "denyDate": "2026-03-30T17:54:36.517Z"
      }
    ],
    "interval": {
      "start": "2026-03-30T17:54:36.517Z",
      "end": "2026-03-30T17:54:36.517Z",
      "frequencyType": "string"
    },
    "frequencyType": "string",
    "creditParty": {
      "taxId": "string",
      "name": "string",
      "bank": "string"
    },
    "debitParty": {
      "personType": "string",
      "taxId": "string",
      "bank": "string",
      "branch": "string",
      "account": "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": "2026-03-30T17:54:36.517Z"
    },
    "createDate": "2026-03-30T17:54:36.517Z",
    "updateDate": "2026-03-30T17:54:36.517Z",
    "deleteDate": "2026-03-30T17:54:36.517Z"
  }
}