Skip to main content

Get Pix Trusted Contact by ID

GET 
/v1/pix/trusted-contacts/:id

Retrieve a pix trusted contact by id for the user.

Request​

Path Parameters

    id stringrequired

    Pix Trusted Contact ID.

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
    name stringrequired

    Pix Trusted Contact name.

    document stringrequired

    Pix Trusted Contact document.

    person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Pix Trusted Contact person type.

    account_number stringrequired

    Pix Trusted Contact account number.

    account_type stringrequired

    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 stringrequired

    Pix Trusted Contact branch number.

    bank_name stringrequired

    Pix Trusted Contact bank name.

    bank_ispb stringrequired

    Pix Trusted Contact bank ISPB.

    created_at date-timerequired

    Pix Trusted Contact created at.

    updated_at date-timerequired

    Pix Trusted Contact updated at.

Loading...