Skip to main content

Cancel Payment by Operation ID

DELETE 
/v1/pix/payments/by-operation/:id

Cancel a payment by its operation ID. This route works for payments in the SCHEDULED state. If the payment state is:

<ul>
  <li>SCHEDULED: The payment state will change to CANCELED.
</ul>
Returns the payment with a state of CANCELED.

Request​

Path Parameters

    id stringrequired

    Payment operation 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​

Payment canceled.

Schema
    id stringrequired

    Payment ID.

    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]

    Payment account type.

    state stringrequired

    Possible values: [PENDING, PENDING_GATEWAY, SCHEDULED, WAITING, WAITING_INTERNAL, WAITING_DELAYED, CONFIRMED, FAILED, CANCELED, ANTIFRAUD_ANALYSIS, ANTIFRAUD_ANALYSIS_REVIEW]

    Payment state.

    created_at date-timerequired

    Payment created at.

    canceled_at date-timerequired

    Payment canceled at.

    payment_date date-timerequired

    Payment date.

Loading...