Skip to main content

GetPixAutomaticChargeByIdRestResponse

    id stringrequired

    Charge ID.

    status stringrequired

    Possible values: [PENDING_WAITING, PENDING_CONFIRMED, CREATED, CREATED_FAILED, PAID, NOT_PAID, WAITING_CANCELLATION, CANCELED, CANCELED_FAILED]

    Charge status

    pix_automatic_recurrence_id stringrequired

    Pix Automatic Recurrence ID

    scheduling_purpose stringrequired

    Possible values: [SCHEDULING, NEW_ATTEMPT, RESEND]

    Scheduling purpose

    due_date YYYY-MM-DDrequired

    Due date

    value numberrequired

    Value

    cancellation_reason string

    Possible values: [ACCOUNT_CLOSED, ACCOUNT_BLOCKED, RECURRENCE_CANCELED, SETTLEMENT_FAILURE, OTHER_REASON_BY_PARTICIPANT, REQUESTED_BY_PAYER, REQUESTED_BY_RECEIVER]

    Cancellation reason

    created_at date-timerequired

    Charge creation date.

    updated_at date-timerequired

    Charge update date.