Skip to main content

List Automatic Pix Payments

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

Request​

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

    status string[]

    Possible values: [CREATED, WAITING_CANCELLATION, CANCELLATION_FAILED, CANCELED]

    Payment status attribute.

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​

Retrieved automatic pix payments successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Automatic pix payment data

  • Array [
    • id stringrequired

    Payment ID

    pix_automatic_authorization objectrequired
    id stringrequired

    Authorization ID.

    journey stringrequired

    Possible values: [JOURNEY_1, JOURNEY_2, JOURNEY_3, JOURNEY_4]

    Authorization journey.

    frequency stringrequired

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

    Authorization frequency.

    start_date YYYY-MM-DDrequired

    Authorization start date

    end_date YYYY-MM-DD

    Authorization end date

    value number

    Authorization value

    floor_max_value number

    Authorization floor max value

    beneficiary_ispb stringrequired

    Authorization beneficiary ISPB

    beneficiary_document stringrequired

    Authorization beneficiary document

    beneficiary_name stringrequired

    Authorization beneficiary name

    owner_document stringrequired

    Authorization owner (payer) document

    debtor_document string

    Authorization debtor document

    debtor_name string

    Authorization debtor name

    contract_number stringrequired

    Authorization contract number

    contract_description stringrequired

    Authorization contract description

    request_expiration_date date-timerequired

    Authorization request expiration date

    status stringrequired

    Possible values: [PENDING, WAITING_APPROVAL, WAITING_REJECTION, APPROVED, REJECTED, WAITING_CANCELLATION, CANCELED, EXPIRED]

    Authorization status

    payment_max_value number

    Authorization payment max value (defined by payer)

    created_at date-time

    Authorization creation date.

    updated_at date-time

    Authorization update date.

    due_date YYYY-MM-DDrequired

    Payment due date

    value numberrequired

    Payment value

    scheduling_purpose stringrequired

    Possible values: [SCHEDULING, NEW_ATTEMPT, RESEND]

    Payment scheduling purpose

    status stringrequired

    Possible values: [CREATED, WAITING_CANCELLATION, CANCELLATION_FAILED, CANCELED]

    Payment status

    created_at date-time

    Payment creation date.

    updated_at date-time

    Payment update date.

  • ]
Loading...