Skip to main content

List Pix recurrences

GET 
/pix/scheduled-payments/recurrence
Tag: api-paas-get-all-pix-recurrenceDescription: Retrieve a list of the user's pix recurrences. Use optional filter parameters to refine your search.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

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.

Responses​

The recurrences returned successfully.

Schema
    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.

  • ]
Loading...