Skip to main content

Change pix automatic recurrence status (test only)

POST 
/v1/pix/scheduled-payments/automatic-recurrences/:id/change-status
Tag: api-baas-change-status-pix-automatic-recurrenceDescription: TEST-ONLY endpoint, available only in non-production environments (development, staging, local, test). Directly sets the recurrence to one of 3 possible statuses (APPROVED, REJECTED, CANCELED), respecting the same business rules as the normal flow. Not present in production.

Request​

Path Parameters

    id stringrequired

    Recurrence unique id.

Header Parameters

    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
    status stringrequired

    Possible values: [APPROVED, REJECTED, CANCELED]

    New status to simulate.

    owner_ispb string

    Owner ISPB. Required when status is APPROVED and the recurrence journey is JOURNEY_2, JOURNEY_3, JOURNEY_4 or JOURNEY_4_STATIC.

    owner_document string

    Owner document. Required when status is APPROVED and the recurrence journey is JOURNEY_2, JOURNEY_3, JOURNEY_4 or JOURNEY_4_STATIC.

Responses​

Recurrence status successfully updated.

Schema
    id stringrequired

    Recurrence ID.

    status stringrequired

    Possible values: [PENDING, CREATED, FAILED, APPROVED, REJECTED, CANCELED, EXPIRED, FINISHED]

    Recurrence status.

    updated_at date-timerequired

    Recurrence update date.

Loading...