Skip to main content

Dismiss Pix Key by ID

POST 
/v1/pix/keys/:id/dismiss

Set a pix key to not be shown anymore. The key's state will be changed to CLAIM_PENDING, CANCELED or READY based on the current state:

<ul>
  <li>If the key state is CLAIM_NOT_CONFIRMED, it will change to CLAIM_PENDING.
  <li>If the key state is PORTABILITY_REQUEST_AUTO_CONFIRMED, it will change to CANCELED.
  <li>If the key state is PORTABILITY_CANCELED, it will change to CANCELED.
  <li>If the key state is OWNERSHIP_CANCELED, it will change to CANCELED.
  <li>If the key state is OWNERSHIP_CONFLICT, it will change to CANCELED.
  <li>If the key state is CLAIM_CLOSED, it will change to CANCELED.
  <li>If the key state is PORTABILITY_READY, it will change to READY.
  <li>If the key state is OWNERSHIP_READY, it will change to READY.
  <li>If the key state is ADD_KEY_READY, it will change to READY.
  <li>If the key state is DELETED, it will change to CANCELED.
  <li>If the key state is NOT_CONFIRMED, it will change to CANCELED.
</ul>
Returns the user's pix key with the state set to CLAIM_PENDING, CANCELED or READY.

Request​

Path Parameters

    id stringrequired

    Pix Key ID.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

The pix key returned successfully.

Schema
    id stringrequired

    Pix Key ID.

    key stringrequired

    Pix key.

    type objectrequired

    Pix Key Type.

    state objectrequired

    Pix Key State.

    created_at date-timerequired

    Pix Key created at.

Loading...