Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Cancelamento de agendamento

post/pix/v1/automatic/recurrencies/{recurrencyId}/payment-instruction/{endToEndId}/cancel

Path parameters

recurrencyIdstring required

Identificador único da recorrencia

endToEndIdstring required

identificador do agendamento

Request body

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

Motivo do 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 CONFIRMATION_ERROR = Solicitado pelo usuário recebedor ou pelo seu participante por erro na solicitação de confirmação FRAUD = Motivado por suspeita de fraude CONFIRMED_IN_OTHER_JOURNEY = Solicitado pelo participante do usuário recebedor porque a mesma recorrência foi confirmada por meio de outra jornada, por exemplo, via QR Code CREDIT_PARTY_REQUEST = Solicitado pelo participante do usuário recebedor DEBIT_PARTY_REQUEST = Solicitado pelo participante do usuário pagador TIMEOUT = Solicitado pelo PSP recebedor por ausência de resposta à pain.009 dentro do prazo/regulamentar

taxIdstring required

CPF/CNPJ

Response

versionstring
statusinteger

Example response

{
  "version": "1.0.0",
  "status": 200,
  "body": {
    "id": "dsdsadsad",
    "endToEndId": "E1393589320250607691358012592",
    "recurrencyId": "dsaasda",
    "amount": 100,
    "expirationDate": "2025-06-07",
    "status": "CANCELLATION_REQUEST",
    "creditParty": {
      "bank": "13935893",
      "branch": "10203040",
      "account": "98765-4",
      "taxId": "76008951000179",
      "name": "Empresa Fictícia"
    },
    "debtor": {
      "personType": "NATURAL_PERSON",
      "taxId": "00011122233",
      "name": "Pessoa Fictícia"
    },
    "debitParty": {
      "bank": "10203040",
      "personType": "NATURAL_PERSON",
      "taxId": "00011122233",
      "branch": "10203040",
      "accountType": "CACC",
      "account": "98765-4",
      "stateCode": "3505708"
    },
    "createDate": "2025-06-07T09:45:00-03:00",
    "clientRequestId": "7540a0ff-713f-4d49-a8db-b2b7d8d9859d",
    "cancellation": {
      "id": "IC13935893202506071632727519030",
      "cancelledBy": "CREDIT",
      "taxId": 19297016000136,
      "reason": "ACCOUNT_CANCELLATION",
      "date": "2025-06-07T09:45:00-03:00"
    }
  }
}