Skip to main content

Get Pix Recurrence by ID

GET 
/pix/scheduled-payments/recurrence/:id
Tag: api-paas-get-pix-recurrence-by-idDescription: Retrieve the state and details of a pix recurrence by providing its ID.

Request​

Path Parameters

    id stringrequired

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

Pix recurrence found.

Schema
    id stringrequired

    Recurrence ID.

    value numberrequired

    Recurrence value.

    beneficiary_name stringrequired

    Recurrence beneficiary name.

    state stringrequired

    Possible values: [ACTIVE, DEACTIVATED]

    Recurrence state.

    frequency stringrequired

    Possible values: [WEEKLY, MONTHLY]

    Recurrence frequency.

    day_of_the_week string

    Possible values: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

    Recurrence day of the week.

    day_of_the_month number

    Recurrence day of the month.

    end_date date-time

    Recurrence end date.

    first_payment_date date-time

    Recurrence first payment date.

    last_payment_date date-time

    Recurrence last payment date.

    created_at date-time

    Recurrence creation date.

    updated_at date-time

    Recurrence update date.

Loading...