Skip to main content
GET
Para o passo a passo completo, veja o guia Consultar autorizações e agendamentos.

Headers

string
required
Sua API key, sem o prefixo Bearer.

Query params

number
required
Lado da consulta: 0 recebedor, 1 pagador. É o inverso da listagem de autorizações.
string
required
Início do período de vencimento, YYYY-MM-DD.
string
required
Fim do período de vencimento, YYYY-MM-DD.
string
PROCESSING, SUCCESS, CANCELLED ou PROCESSING_ERROR.
string
CNPJ do recebedor.
string
CPF ou CNPJ do pagador.
number
0 pessoa física, 1 pessoa jurídica.
number
default:"1"
Página, a partir de 1.
number
default:"50"
Itens por página, de 1 a 100.

Response

Array de agendamentos, ordenado pela última atualização. A paginação vem no header Pagination (CurrentPage, PageCount, PageSize, RowCount).
string
Identificador do débito. Use para cancelar o agendamento.
string
Identificador da recorrência.
string
Vencimento, yyyy-MM-dd.
number
Valor da cobrança.
string
PROCESSING, SUCCESS, CANCELLED ou PROCESSING_ERROR.
string
PROCESSING, SUCCESS ou CANCELLED.
string
FIRST_ATTEMPT, RETRY_AFTER_EXPIRATION ou RESEND_DUE_TO_SETTLEMENT_ERROR.
string
Referência de conciliação do recebedor.
object
Recebedor: ispb, document, name, branchNumber, accountType e accountNumber.
object
Pagador: ispb, type e document.
string
Informação do recebedor para o pagador.