Skip to main content

Delete Pix Key

DELETE 
/pix/keys/:id

Delete a pix key associated with the specified ID. After deletion, the pix key's state will be set to DELETING.

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