Skip to main content

Get Pix Fund Recovery Request by ID

GET 
/v1/pix/fund-recovery-requests/:id

Retrieves a company's pix fund recovery request by ID.

Request​

Path Parameters

    id stringrequired

    Pix Fund Recovery Request 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-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.

    x-lang string

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

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

Responses​

The pix fund recovery request returned successfully. Returns null if fund recovery request id is not found.

Schema
    id stringrequired

    Pix Fund Recovery Request ID.

    status stringrequired

    Possible values: [CREATED, ANALYSED, WAITING_DEVOLUTION, COMPLETED_REJECTED, COMPLETED_APPROVED, CANCELED, FAILED]

    Pix Fund Recovery Request status.

    reason stringrequired

    Possible values: [FRAUD, CANCEL_DEVOLUTION, PIX_AUTOMATIC_FRAUD, PIX_AUTOMATIC_PSP_ERROR]

    Pix Fund Recovery Request reason.

    transaction_third_part_name string

    Pix Fund Recovery Request transaction third part name.

    transaction_amount number

    Pix Fund Recovery Request transaction amount.

    transaction_id string

    Pix Fund Recovery Request transaction ID.

    transaction_type stringrequired

    Possible values: [PAYMENT, DEVOLUTION, REFUND_PAYMENT]

    Pix Fund Recovery Request transaction type.

    description string

    Pix Fund Recovery Request description.

    refund_total_amount number

    Pix Fund Recovery Request refund total amount.

    analysis_limit_date date-time

    Pix Fund Recovery Request analysis limit date.

    files object
    pix_fund_recovery_request_id stringrequired

    Pix fund recovery request UUID.

    file_id stringrequired

    File ID.

    name stringrequired

    File name.

    created_at date-timerequired

    Pix Fund Recovery Request created at.

    updated_at date-timerequired

    Pix Fund Recovery Request updated at.

Loading...