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 pagador, 1 recebedor.
string
PROCESSING, SUCCESS, CANCELLED ou PROCESSING_ERROR. Diferencia maiúsculas de minúsculas.
string
Resultado da autorização, como PENDING_USER ou ACCEPTED.
string
CNPJ do recebedor.
string
Conta do recebedor.
string
CPF ou CNPJ do pagador.
number
0 pessoa física, 1 pessoa jurídica.
string
Agência do pagador, até 4 caracteres.
string
Conta do pagador, até 20 caracteres.
string
Data inicial da recorrência, a partir de (YYYY-MM-DD). Use com recurrenceStartDateTo.
string
Criação a partir de. Use com recurrenceCreatedDateTimeTo.
string
Última atualização a partir de. Use com recurrenceUpdatedDateTimeTo.
number
default:"1"
Página, a partir de 1.
number
default:"50"
Itens por página, de 1 a 100.

Response

Array de autorizações, ordenado pela última atualização. A paginação vem no header Pagination (CurrentPage, PageCount, PageSize, RowCount). Campos sem valor são omitidos.
string
Identificador interno (GUID). Use em Consultar autorização.
string
PAYER ou BENEFICIARY.
string
Identificador da recorrência.
number
Jornada de autorização: 1, 2, 3 ou 4.
string
Periodicidade.
string
PROCESSING, AWAITING_VALIDATION, PENDING_USER, ACCEPTED, REJECTED ou CANCELLED.
string
PROCESSING, SUCCESS, CANCELLED ou PROCESSING_ERROR.
object
Recebedor: ispb, document e name.
object
Pagador: ispb, type, document, name, agencyNumber, accountType, accountNumber e municipalityIbgeCode.
object
Devedor: type, document e name.
string
Identificador do contrato.
string
Descrição do contrato.
string
Data inicial, yyyy-MM-dd.
string
Data final, yyyy-MM-dd.
string
Criação da recorrência, yyyy-MM-ddTHH:mm:ss.
string
Envio da solicitação (jornada 1).
string
Expiração da solicitação (jornada 1).
string
Data da autorização.
string
Vencimento da última cobrança enviada.
number
Valor fixo.
number
Piso do valor máximo.
number
Valor máximo definido pelo pagador. Só aparece no lado pagador.
string
Motivo da recusa.