API Reference

Consultar lista de cobranças recorrentes.

get
https://api.pix-h.treeal.com/cobr

Endpoint para consultar cobranças recorrentes através de parâmetros como início, fim, idRec, cpf, cnpj, status e convênio.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date-time
required

Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.

date-time
required

Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.

string
length between 29 and 29

Filtro pelo Identificador da Recorrência.

string

Filtro pelo CPF do devedor. Não pode ser utilizado ao mesmo tempo que o CNPJ.

string

Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF.

string

Filtro pelo status da recorrência.

string
length ≤ 60

Filtro pelo convênio associado.

int32
≥ 0
Defaults to 0

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

int32
1 to 1000
Defaults to 100

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

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

Updated 5 months ago