v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Cancelamento de agendamento

post/pix-indirect/v1/automatic/scheduling/{endToEndId}/cancel

Path parameters

endToEndIdstring required

EndToEndId do agendamento

Request body

reason'ACCOUNT_CANCELLATION' | 'PAYER_DEAD' | 'FRAUD' | 'DEBIT_PARTY_REQUEST'

Motivos de cancelamento:

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

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

taxIdstring

Documento de identificação do titular da conta: CPF para pessoas físicas ou CNPJ para pessoas jurídicas.

Response

200

statusinteger

versionstring

Example response

{
  "version": "string",
  "body": {
    "endToEndId": "string",
    "recurrencyId": "string",
    "paymentId": "string",
    "type": "string",
    "status": "string",
    "createDate": "2026-03-30T18:09:11.814Z",
    "expirationDate": "2026-03-30T18:09:11.814Z",
    "cancelledDate": "2026-03-30T18:09:11.814Z",
    "creditParty": {
      "bank": "string",
      "personType": "string",
      "taxId": "string",
      "name": "string",
      "branch": "string",
      "account": "string",
      "accountType": "string"
    },
    "debitParty": {
      "bank": "string",
      "personType": "string",
      "taxId": "string",
      "name": "string",
      "branch": "string",
      "account": "string",
      "accountType": "string",
      "stateCode": "string"
    },
    "debtor": {
      "personType": "string",
      "taxId": "string",
      "name": "string"
    }
  }
}