Skip to main content

List Pix Trusted Contact

GET 
/v1/pix/trusted-contacts

Retrieve a list of pix trusted contact for the user.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    document string

    Pix Trusted Contact document.

Header Parameters

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Responses​

The trusted contact returned successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    PixTrustedContact data.

  • Array [
    • id string

    Pix Trusted Contact ID.

    name string

    Pix Trusted Contact name.

    document string

    Pix Trusted Contact document.

    person_type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Pix Trusted Contact person type.

    account_number string

    Pix Trusted Contact account number.

    account_type string

    Possible values: [CACC, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS, CC, PG, CD, CG, CI, PP]

    Pix Trusted Contact account type.

    branch_number string

    Pix Trusted Contact branch number.

    bank_name string

    Pix Trusted Contact bank name.

    bank_ispb string

    Pix Trusted Contact bank ISPB.

    created_at date-time

    Pix Trusted Contact created at.

    updated_at date-time

    Pix Trusted Contact updated at.

  • ]
Loading...