Listar recorrências

Lista, de forma paginada, as recorrências de transferências Pix configuradas na conta.

Use esta operação para localizar Pix Recorrentes quando o ID da recorrência não for conhecido ou para consultar recorrências conforme os filtros disponíveis. Para consultar uma recorrência específica pelo ID, utilize Recuperar uma única recorrência.

Este recurso pertence ao fluxo de Pix Recorrente, em que são programadas transferências Pix periódicas, e não ao fluxo de Pix Automático, baseado em cobranças recorrentes com autorização prévia do pagador.

Conteúdos relacionados

Guides

Biblioteca de Erros

Query Params
integer

Elemento inicial da lista

integer
≤ 100

Número de elementos da lista (max: 100)

string
enum

Filtrar pelo status da recorrência

Allowed:
number

Filtrar pelo valor da recorrência

string

Filtrar pelo nome do recebedor

Responses

403

Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json