Rec
Consultar lista de recorrências.
Consultar lista de recorrências.
get/rec
Query parameters
iniciostring date-time required
Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.
fimstring date-time required
Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.
cpfstring
Filtro pelo CPF do devedor. Não pode ser utilizado ao mesmo tempo que o CNPJ.
cnpjstring
Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF.
locationPresenteboolean
statusstring
Filtro pelo status da recorrência.
conveniostring
Filtro pelo convênio associado.
paginacao.paginaAtualinteger
Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.
paginacao.itensPorPaginainteger
Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.
Response
OK
Example response
{
"parametros": {
"inicio": "2020-04-01T00:00:00Z",
"fim": "2020-04-01T17:00:00Z"
},
"recs": [
{
"idRec": "RR1234567820240115abcdefghijk",
"calendario": {
"dataInicial": "2023-04-01",
"dataFinal": "2023-04-01"
},
"loc": {
"location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
"idRec": "RR1234567820240115abcdefghijk"
},
"solicitacao": [
{
"idSolicRec": "SC1234567820240115abcdefghijk",
"idRec": "RR1234567820240115abcdefghijk",
"recPayload": {
"idRec": "RR1234567820240115abcdefghijk",
"calendario": {
"dataInicial": "2023-04-01",
"dataFinal": "2023-04-01"
}
}
}
]
}
]
}