Skip to main content

Change pix automatic charge status (test only)

POST 
/v1/pix/scheduled-payments/automatic-charges/:id/change-status
Tag: api-baas-change-status-pix-automatic-chargeDescription: TEST-ONLY endpoint, available only in non-production environments (development, staging, local, test). Directly sets the charge to one of 3 possible statuses (PAID, NOT_PAID, CANCELED). Not present in production.

Request​

Path Parameters

    id stringrequired

    Charge 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: [PAID, NOT_PAID, CANCELED]

    New status to simulate.

Responses​

Charge status successfully updated.

Schema
    id stringrequired

    Charge ID.

    status stringrequired

    Possible values: [PENDING_WAITING, PENDING_CONFIRMED, CREATED, CREATED_FAILED, PAID, NOT_PAID, WAITING_CANCELLATION, CANCELED, CANCELED_FAILED]

    Charge status.

    updated_at date-timerequired

    Charge update date.

Loading...