Saltar al contenido principal
DELETE
Delete a PIX key entry

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

entryId
string
requerido

The PIX key value (URL-encoded).

Ejemplo:

"11122233300"

Cuerpo

application/json
accountId
string
requerido

The Midaz ledger account id of the key owner.

Ejemplo:

"019a1b2c-3d4e-7f60-8a9b-0c1d2e3f4a5b"

ispb
string

The ISPB of the direct participant this operation acts as. This deployment may act as SEVERAL direct SPI participants - one ISPB each, each with its own customers and its own DICT credential - and this field is the only thing on the request that says which of them writes to the national directory. OPTIONAL while it acts as a single participant: omit it and that one acts. REQUIRED once it acts as several - omitted is 422 PIX-0127, and an ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply and guarantee, exactly like payerIspb on a transaction: never a credential, never read from a header or a path, and it never widens what your token can reach. It also selects the DICT credential the call goes out on, so a key registered under the wrong one is declared to Bacen by the wrong institution. Send it as an absent key, not an empty string; an empty value is refused 400 PIX-0061.

Pattern: ^[0-9A-Z]{8}$
Ejemplo:

"12345678"

Respuesta

OK

key
string
requerido

The PIX key that was deleted.

Ejemplo:

"11122233300"