Skip to main content

Create Pix Fund Recovery Request

POST 
/v1/pix/fund-recovery-requests

Create a pix fund recovery request. Sends a create pix fund recovery to DICT. Returns the pix fund recovery request with a state of CREATED.

Request​

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    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.

Body

required
    transaction_operation_id string

    Pix Fund Recovery Request transaction operation ID.

    transaction_id string

    Pix Fund Recovery Request transaction ID.

    reason stringrequired

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

    Pix Fund Recovery Request reason.

    fraud_reason string

    Possible values: [FRAUD, UNAUTHORIZED, COERSION_CRIME, FRAUDULENT_ACCESS, OTHER, UNKNOWN]

    Pix Fund Recovery Request fraud reason.

    description stringrequired

    Pix Fund Recovery Request description.

Responses​

The pix fund recovery request returned successfully.

Schema
    id stringrequired

    Pix Fund Recovery Request ID.

    created_at date-timerequired

    Pix Fund Recovery Request created at.

Loading...