Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Automatic Pix

Cancel recurrence

Cancel Pix Automatic recurrence

post/inst-pull-pay/v1/pix/automatic/cancel

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Idempotency-Keystring required

A unique ID to ensure the operation remains idempotent, allowing for operation repitition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

Request body

recurrence_idstring required

BACEN recurrence ID

reason_code'ACCL' | 'CPCL' | 'DCSD' | 'ERSL' | 'FRUD' | 'PCFD' | 'SLCR' | 'SLDB' | 'OTHS' | 'NRES' required

Cancellation reason code:

  • ACCL - Paying receiving user's account cancelled
  • CPCL - Receiving company closure
  • DCSD - Paying user death
  • ERSL - Receiving user, or their participant, request cancelled due to confirmation request error
  • FRUD - Fraud
  • PCFD - Receiving user participant request because the same recurrence was confirmed another way, for example, via QR code
  • SLCR - Receiving user request
  • SLDB - Paying user request
  • OTHS - Requested by either the payer's participant or the receiver's participant for other reasons not specified in the previous categories
  • NRES - Receiving PSP request due to lack of response to pain.009 within the regulatory period

Example request

{
  "recurrence_id": "RN000000012025050500012345678",
  "reason_code": "ACCL"
}

Response

OK