API BaaSPix

List Pix keys for an account

Lists the PIX keys registered on the account, or checks a single key when pixKey is given.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.

Query parameters

pixKeystringOptional

PIX key value (CPF, CNPJ, e-mail, phone with country code, or EVP).

Response

Pix keys retrieved.
bankobject
keyslist of objects

Errors

400
Bad Request Error
422
Unprocessable Entity Error
500
Internal Server Error
503
Service Unavailable Error
504
Gateway Timeout Error