Pular para o conteúdo principal
GET
List the credits this tenant bid on and where each bid stands

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

originador_id
string<uuid>
obrigatório

The originador's register id, as returned in the id field of GET /v1/consignado/originadores. It must be in the partner credential's scope.

Exemplo:

"6f1c2a3b-4d5e-4f60-8a7b-9c0d1e2f3a4b"

Parâmetros de consulta

situacao
enum<string>[]

Narrows the page to the named situations. Repeat the parameter for several. Omitted means all five.

Opções disponíveis:
claimed,
accepted,
refused,
unknown,
retry_in_flight
Exemplo:
cedido
enum<string>

Narrows the page to credits with a cessão registered (true) or to the ones without one (false). Omitted means the whole book, which is never the same as either half.

Opções disponíveis:
true,
false
Exemplo:

"true"

after
string

The previous page's page.next_after. Omitted starts at the newest claim. A cursor this service did not mint is refused, never restarted from the top.

Exemplo:

"eyJ2IjoxLCJyIjoiYm9hcmQiLCJ0IjoiMjAyNi0wOC0xNFQwOToxMjozM1oiLCJrIjpbImMwMDEyIl19"

limit
integer<int64>

Maximum number of submissions to return. Omitted means the ceiling of 200.

Intervalo obrigatório: 1 <= x <= 200
Exemplo:

50

originadorRef
string

Narrows the page to the bids ONE originador placed, matched byte for byte. A bancarizador may name any originador of its register; an originador authenticating with its own credential does not need to send it, and if it does it must be its own. Omitted is the whole book for a bancarizador, and the caller's own bids for an originador.

Required string length: 1 - 128
Exemplo:

"originador-a"

Resposta

OK

items
object[]
obrigatório
page
object
obrigatório