List PIX keys

GET

/order/v1/banking/accounts/{accountId}/keys

Production
Sandbox

Retrieve all PIX keys for the given account.

Authorizations

Bearer

Parameters

Path Parameters

accountId

required

string format: uuid

Identifier of the account

Responses

200

The resource was returned successfully

object

data

required

List of PIX keys linked to the account

Array<object>

object

required

Identifier of the PIX key

string

Example

a8f2b9c4-1e6a-4c3f-9d7b-2a1e8f9c5d10

type

required

Type of the PIX key

string

Allowed values: CPF CNPJ EMAIL PHONE RANDOM

Example

CPF

key

required

PIX key value

string

Example

122345678900

createdAt

required

Creation date of the PIX key

string

Example

2025-12-18T10:15:30Z

possedAt

required

Date when the key was associated to the account

string

Example

2025-12-18T10:15:30Z

400

object

error

string

Example

INVALID_REQUEST

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[
  {
    "field": "field_name",
    "issue": "INVALID",
    "description": "Field is invalid"
  }
]

401

Unauthorized Request

object

error

string

Example

UNAUTHORIZED

message

string

Example

Unauthorized Request

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

500

object

error

string

Example

INTERNAL_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]