Skip to main content

Dismiss Pix Key

POST 
/v2/pix/keys/:id/dismiss
Tag: api-paas-post-pix-keys-dismiss-by-idDescription: Set a key to not be shown anymore. The key state will change to CLAIM_PENDING, CANCELED or READY. If the key state is:
  • CLAIM_NOT_CONFIRMED: The key state will change to CLAIM_PENDING.
  • PORTABILITY_REQUEST_AUTO_CONFIRMED: The key state will change to CANCELED.
  • PORTABILITY_CANCELED: The key state will change to CANCELED.
  • OWNERSHIP_CANCELED: The key state will change to CANCELED.
  • OWNERSHIP_CONFLICT: The key state will change to CANCELED.
  • CLAIM_CLOSED: The key state will change to CANCELED.
  • PORTABILITY_READY: The key state will change to READY.
  • OWNERSHIP_READY: The key state will change to READY.
  • ADD_KEY_READY: The key state will change to READY.
  • DELETED: The key state will change to CANCELED.
  • NOT_CONFIRMED: The key state will change to CANCELED.
Returns the key with a state of CLAIM_PENDING, CANCELED or READY.

Request​

Path Parameters

    id stringrequired

    Pix Key ID.

Header Parameters

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    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...