Skip to main content

listPixKey

GET 
/api/pix/keys

Shows all Pix keys informations

Responses​

Ok

Schema
    data object[]

    Array of transactions data)

  • Array [
    • anyOf
    id id (string)

    Pix Key id

    type type (string)

    Possible values: [CPF, CNPJ, EMAIL, PHONE, EVP]

    Pix Key type

    key key (string)

    Pix Key

    emv emv (string)

    EMV related to the key

    created_at created_at (string)

    Date when the key was created

  • ]
    • links object

    Links

    first first (string)

    Show first page link

    last last (string)

    Show last page link

    prev prev (string)

    Show previous page link

    next next (string)

    Show next page link

    meta object

    Links

    current_page current_page (integer)

    Current page number

    from from (integer)

    From page number

    last_page last_page (integer)

    Last page number

    links object[]

    Array of links to navigate the pages

  • Array [
    • anyOf
    url url (string)required

    url

    label label (string)required

    label

    active active (boolean)required

    active

  • ]
    • path path (string)

    Pagination path

    per_page per_page (integer)

    Pagination per_page number os itens

    to to (integer)

    Pagination to page

    total total (integer)

    Total number of itens per page

Loading...