Skip to main content

Create Pix Devolution

POST 
/v1/pix/devolutions

Initiate a new pix devolution by providing the required information in the request body and executing the request.

Request​

Header Parameters

    x-include-replay-protection-schema string

    The replay-protection-schema allows the user to choose between 3 options:

    • If there's no value: The default protection checks that the values in this request are equal: { method, params, path, query, body, userId }. This means that if a request repeats the same values, it will be blocked.
    • 'nonce': The nonce and { method, params, path, query, body, userId } value are checked. When the protection schema is this, requests will be OK if this nonce value is different in each request.
    • 'x-transaction-uuid': The transactionId and { method, params, path, query, body, userId } value are checked. Requests will be OK if this x-transaction-uuid value is different in each request.
    • 'x-transaction-uuid&nonce' or 'nonce&x-transaction-uuid': The nonce, transactionId value and { method, params, path, query, body, userId } are checked, i.e. if requests are repeated the same value in both fields, they will be blocked. But if any field has a different value, the request is OK.

    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-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.

Body

required
    operation_id stringrequired

    Charge back the operation ID listed on the credit statement.

    amount numberrequired

    Possible values: >= 1

    Value in R$ cents. Should be less or equal then credit transacation.

    description string

    User defined payment description.

    merchant_id string

    User defined payment merchant ID.

Responses​

The devolution returned successfully.

Schema
    id stringrequired

    Devolution ID.

    amount numberrequired

    Value in R$ cents.

    description string

    User defined devolution description.

    state stringrequired

    Possible values: [PENDING, WAITING, WAITING_DELAYED, CONFIRMED, ERROR, FAILED, CANCELED]

    Devolution state.

    created_at date-timerequired

    Devolution created at.

Loading...