Skip to main content

Get Automatic Pix Recurrence by ID

GET 
/v1/pix/scheduled-payments/automatic-recurrences/:id
Tag: api-baas-get-by-id-pix-automatic-recurrenceDescription: Retrieve the details of a pix automatic 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

    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​

Recurrence found.

Schema
    id stringrequired

    Recurrence ID.

    status stringrequired

    Possible values: [PENDING, CREATED, FAILED, APPROVED, REJECTED, CANCELED, EXPIRED, FINISHED]

    Recurrence status

    state string

    Possible values: [PENDING_CONFIRMED, CREATED_CONFIRMED, CREATED_FAILED, APPROVED_CONFIRMED, REJECTED_CONFIRMED, CANCELED_CONFIRMED, CANCELED_FAILED, EXPIRED_CONFIRMED, FINISHED_CONFIRMED]

    Recurrence state

    journey stringrequired

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

    Recurrence journey

    frequency stringrequired

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

    Recurrence frequency

    start_date YYYY-MM-DDrequired

    Recurrence start date

    end_date YYYY-MM-DD

    Recurrence end date

    value number

    Recurrence value

    floor_max_value number

    Recurrence floor max value

    beneficiary_ispb stringrequired

    Recurrence beneficiary ISPB

    beneficiary_document stringrequired

    Recurrence beneficiary document

    beneficiary_name stringrequired

    Recurrence beneficiary name

    owner_ispb string

    Recurrence owner (payer) ISPB

    owner_name string

    Recurrence owner (payer) name

    owner_person_type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Recurrence owner (payer) person type

    owner_document string

    Recurrence owner (payer) document

    owner_bank_branch string

    Recurrence owner (payer) bank branch

    owner_bank_account string

    Recurrence owner (payer) bank account

    debtor_person_type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Recurrence debtor person type

    debtor_document string

    Recurrence debtor document

    debtor_name string

    Recurrence debtor name

    contract_number stringrequired

    Recurrence contract number

    contract_description string

    Recurrence contract description

    tags string[]

    Recurrence tags

    request_expiration_date date-time

    Recurrence request expiration date

    cancellation_reason string

    Possible values: [ACCOUNT_CANCELED, RECEIVER_COMPANY_CLOSURE, OWNER_DEATH, CONFIRMATION_ERROR, FRAUD_SUSPICION, RECURRENCE_ALREADY_CONFIRMED, RECEIVER_REQUEST, PAYER_REQUEST, RECEIVER_PSP_REQUEST]

    Recurrence cancellation reason

    next_charge_due_date date-time

    Recurrence next charge due date

    next_charge_value number

    Recurrence next charge value

    qr_code_emv string

    Recurrence QR Code EMV.

    created_at date-timerequired

    Recurrence creation date.

    updated_at date-timerequired

    Recurrence update date.

Loading...