Skip to main content

Update an Automatic Pix Recurrence

PUT 
/pix/scheduled-payments/automatic-recurrences/:id
Tag: api-paas-update-pix-automatic-recurrenceDescription: Updates an automatic pix recurrence by canceling the current one and creating a new one with updated data. Only recurrences with status CREATED (pending approval) can be updated.

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

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Body

required
    value number

    Value for the charges in Brazilian Real (R$) cents.

    floor_max_value number

    Floor max value for the charges in Brazilian Real (R$) cents.

    request_expiration_date date-time

    Request expiration date. Max 30 days from now.

    frequency string

    Possible values: [WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]

    Frequency.

    start_date date-time

    Date of the first payment of the automatic pix recurrence.

    end_date date-time

    Date for when the automatic pix recurrence will be ended.

    contract_number string

    Possible values: <= 35 characters

    Contract/reference number. Alphanumeric code to reference the recurrence.

    contract_description string

    Possible values: <= 35 characters

    Contract/recurrence description.

    tags string[]

    Possible values: <= 5

    Tags to help identify the recurrence.

Responses​

Recurrence successfully updated.

Schema
    old_id stringrequired

    Old recurrence ID (canceled).

    old_recurrence_status stringrequired

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

    Old recurrence status.

    id stringrequired

    New recurrence ID.

    status stringrequired

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

    New recurrence status.

    state stringrequired

    Possible values: [PENDING_CONFIRMED, CREATED_CONFIRMED, CREATED_FAILED, APPROVED_CONFIRMED, REJECTED_CONFIRMED, CANCELED_CONFIRMED, CANCELED_FAILED, EXPIRED_CONFIRMED, FINISHED_CONFIRMED]

    New recurrence state.

    updated_at date-timerequired

    Update timestamp.

Loading...