Skip to main content

List of scheduled transactions

Request

ENDPOINT
/account/ACCOUNT_KEY/scheduled_transactions
METHOD
GET

QUERY PARAMS

FieldDescription
statusStatus of a boleto
dateDate of the scheduling.
page_numberCurrent page being consulted
page_sizeNumber of results per page

PATH PARAMS

FieldDescription
ACCOUNT_KEYaccount_key of the source account of the transactions

Response

STATUS
200
Response Body
{
"data": [{
"outgoing_pix_key": "chave da schedule",
"outgoing_ted_key": "chave da schedule",
"schedule_date": "iso date string",
"source_account_key": "chave da conta de origem da transação",
"target_account_bank_code": "banco destino (opcional)",
"target_account_bank_ispb": "ispb destino (opcional)",
"target_account_branch": "agencia destino",
"target_account_number": "conta de destino",
"target_account_digit": "digito conta destino",
"target_account_type": "tipo de conta destino (opcional)",
"beneficiary_name": "nomoe do beneficiario",
"beneficiary_document_number": "documento do beneficiario (cpf/cnpj)",
"scheduled_amount": "valor agendadp",
"beneficiary_person_type": "tipo de beneficiario",
"target_account_key": "chave da conta destino (opcional)",
"source_subtype": "tipo de transação (enum)",
"created_at": "data em que o agendamento foi feito",
"status": "status do agendamento",
"pix_key": "chave pix destino (opcional)",
"cancellation_requester": "identificação do requisitor do cancelamento",
"cancellation_reason": "origem do cancelamento (enum)",
"updated_at": "data de atualização"
}],
"pagination": {
"current_page": 1,
"next_page": null,
"rows_per_page": 10
}
}
General Observations:

Only approved schedules will be listed when approval is applicable!