Skip to main content
GET
SPI rejected-payments report

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

fromDate
string
obrigatório

Inclusive start of the report window (YYYY-MM-DD UTC). Required.

Exemplo:

"2026-06-01"

toDate
string
obrigatório

Inclusive end of the report window (YYYY-MM-DD UTC). Required. The window may not exceed 92 days.

Exemplo:

"2026-06-30"

limit
integer<int64>
padrão:50

Page size (default 50, max 200).

Intervalo obrigatório: 1 <= x <= 200
cursor
string

Opaque pagination cursor.

Resposta

OK

items
object[]
obrigatório

One page of rejected payments, newest first.

reasonRetained
boolean
obrigatório

Always false — the detailed reject reason is not retained; the report carries status + business key only.

Exemplo:

false

totalCount
integer<int64>
obrigatório

Total rejected payments in the window (COUNT).

Exemplo:

7

window
object
obrigatório

Echo of the resolved report window.

nextCursor
string

Opaque cursor for the next page; absent when exhausted (its absence signals end-of-list).