GetAllPixAutomaticChargeRestResponse

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
Automatic pix charge data
Array [
id stringrequired
Charge ID
pix_automatic_recurrence objectrequired
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
created_at date-timerequired
Recurrence creation date.
updated_at date-timerequired
Recurrence update date.
status stringrequired
Possible values: [PENDING_WAITING, PENDING_CONFIRMED, CREATED, CREATED_FAILED, PAID, NOT_PAID, WAITING_CANCELLATION, CANCELED, CANCELED_FAILED]
Charge status
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.
]