Skip to main content

GetAllPixRecurrenceRestResponse

    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Pix recurrence data

  • Array [
  • 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.

  • ]