Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Keys

Delete key

Deletes a user DICT key entry.

On PSP timeout, a 202 Accepted response is returned and the process continues asynchronously, eventually emitting a success or error event.

This endpoint generates a <a href="https://developers.pismo.io/events/docs/pix-dict-key-status-change-1" >Pix key status changed</a> event.

post/v2/pix/keys/delete

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

keystring required

Pix key value.

key_type'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'EVP' required

User information that can be used to create a Pix key:

  • CPF - Cadastro de Pessoas Fisicas (Indiviual Taxpayer Registry) number. Similar to a Social Security number in the US.
  • CNPJ - Cadastro Nacional de Pessoa Juridica (National Registry of Legal Entities) number. Unique ID for legal entities, such as companies and organizations, in Brazil
  • EMAIL - Email
  • PHONE - Phone number
  • EVP - Endereco de pagamento virtual (virtual payment address). A randomly-generated UUID number.
reason'USER_REQUESTED' | 'ACCOUNT_CLOSURE' | 'RECONCILIATION' | 'FRAUD' | 'RFB_VALIDATION' required

Delete key reason for request.

Example request

{
  "key": "email@email.com",
  "key_type": "EMAIL",
  "reason": "USER_REQUESTED"
}

Response

Accepted

codestring

Error code

messagestring

Error message

Example response

{
  "code": "EPDA0001",
  "details": {
    "external": [
      {
        "code": "PBE315",
        "message": "Generic error"
      }
    ],
    "parameters": [
      {
        "field": "query parameter",
        "message": "Generic error"
      }
    ],
    "payload": [
      {
        "field": "Entity.field",
        "message": "Generic error"
      }
    ]
  },
  "message": "User not found"
}