Skip to main content

List pix scheduled payments

GET 
/v1/pix/scheduled-payments
Tag: api-baas-get-all-pix-scheduled-paymentsDescription: Retrieve a list of the user's pix scheduled payments. 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.

    states string[]

    Possible values: [PENDING, READY, CANCELED, FAILED]

    Pix scheduled payment State.

    type string

    Possible values: [PIX_RECURRING_PAYMENT, PIX_AUTOMATIC_PAYMENT, OTHER]

    Pix scheduled payment type

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​

The scheduled payments 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 scheduled payment data

  • Array [
    • id stringrequired

    Pix scheduled payment ID.

    value numberrequired

    Pix scheduled payment value.

    beneficiary_name stringrequired

    Pix scheduled payment beneficiary name.

    state stringrequired

    Possible values: [PENDING, READY, CANCELED, FAILED]

    Pix scheduled payment state.

    type stringrequired

    Possible values: [PIX_RECURRING_PAYMENT, PIX_AUTOMATIC_PAYMENT, OTHER]

    Pix scheduled payment state.

    pix_payment_id stringrequired

    Pix payment id.

    operation_id stringrequired

    Operation id.

    payment_date date-time

    Pix scheduled payment payment date.

    created_at date-time

    Pix scheduled payment creation date.

    updated_at date-time

    Pix scheduled payment update date.

  • ]
Loading...