Pix agendado

Consulta de recorrência de agendamentos

Utilize este endpoint para consultar agendamentos recorrentes a partir dos campos informados na requisição.

get/pix/scheduling-payments/recurrences

Query parameters

debtorAccountIdentificationstring

Conta transacional do usuário pagador

debtorAccountIssuerstring

Agência do usuário pagador sem dígito verificador

status'PROCESSING' | 'CANCELED' | 'COMPLETED' | 'AWAITING_ENRICHMENT'

Status da recorrência

initialDatestring

Data de início do período para a busca das regras de recorrência

endDatestring

Data fim do período para a busca das regras de recorrência

pageinteger

Número da página para paginação

pageSizeinteger

Número de registros desejados (caso não seja informado vamos trazer todos os registros com base nos parâmetros fornecidos acima)

Parameters

#/paths/~1pix~1claims/get/parameters/0 — unresolved $ref
#/paths/~1pix~1claims/get/parameters/2 — unresolved $ref
#/paths/~1pix~1claims/get/parameters/3 — unresolved $ref
#/paths/~1pix~1claims/get/parameters/1 — unresolved $ref

Response

Consulta realizada com sucesso.

totalItemsinteger

Número total de itens.

totalPagesinteger

Número total de páginas.

currentPageinteger

Página atual.