Skip to main content

Change pix automatic authorization status to CANCELED (test only)

POST 
/v1/pix/scheduled-payments/automatic-authorizations/:id/change-status
Tag: api-baas-change-status-pix-automatic-authorizationDescription: TEST-ONLY endpoint, available only in non-production environments (development, staging, local, test). Directly sets the authorization status to CANCELED. Not present in production.

Request​

Path Parameters

    id stringrequired

    Authorization 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: [CANCELED]

    New status to simulate.

Responses​

Authorization status successfully updated.

Schema
    id stringrequired

    Authorization ID.

    status stringrequired

    Possible values: [PENDING, WAITING_APPROVAL, WAITING_REJECTION, APPROVED, REJECTED, WAITING_CANCELLATION, CANCELED, FINISHED]

    Authorization status.

    updated_at date-timerequired

    Authorization update date.

Loading...