List Pix keys

GET {{baseInfraUrl}}/{{version}}/pix-key

Here you can list and filter all Pix Keys you have. We return it paged.

Request Params

KeyDatatypeRequiredDescription
cursornullString used to get the next batch of results.
limitnullMaximum number of Pix Claims to be retrieved.
fieldsnullList of strings to filter response JSON keys.
afternullFilter entities created after this date.
beforenullFilter entities created before this date.
statusnullFilter Pix Keys by the specified status.
tagsnullFilter entities that contain the specified tags.
idsnullList of strings to get specific Pix Keys by their ids.
typenullFilter Pix Keys by their type.

RESPONSES

status: OK

{"cursor":"CkUKFAoHY3JlYXRlZBIJCMbA3o385PcCEilqEWl-YXBpLW1zLWRpY3QtZGV2chQLEgdEaWN0S2V5GICAgITe4YkKDBgAIAE=","keys":[{"accountCreated":"2022-02-02T02:59:59.999999+00:00","accountNumber":"0000","accountType":"savings","bankCode":"35547753","bankName":"","branchCode":"0000","created":"2022-05-17T19:19:46.274234+00:00","id":"exemplopostman@hotmail.com","name":"Jamie Lannister","owned":"2022-05-17T19:19:46.274234+00:00","ownerType":"individual","status":"registered","tags":[],"taxId":"012.345.678-90","type":"email"},{"accountCreated":"2022-01-02T02:59:59.999999+00:00","accountNumber":"76543","accountType":"salary","bankCode":"35547753","bankName":"","branchCode":"1234","created":"2022-05-16T21:32:10.415213+00:00","id":"bdb5b5b8-f963-4834-93e5-9078dc946704","name":"Jamie Lannister","owned":"2022-05-16T21:32:10.415213+00:00","ownerType":"individual","status":"registered","tags":[],"taxId":"012.345.678-90","type":"evp"}]}