Skip to main content

Cancels an Automatic Pix Recurrence

POST 
/v1/pix/scheduled-payments/automatic-recurrences/:id/cancel
Tag: api-baas-cancel-pix-automatic-recurrenceDescription: Cancels an automatic pix recurrence and its scheduled payments. Only recurrences with status APPROVED can be canceled.

Request​

Path Parameters

    id stringrequired

    Recurrence unique 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​

Recurrence successfully canceled.

Loading...