Skip to main content
GET
Listar solicitações de devolução

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

limit
integer
padrão:10

Número máximo de itens por página.

Intervalo obrigatório: 1 <= x <= 100
page
integer
padrão:1

Número da página para paginação.

Intervalo obrigatório: x >= 1
sort_order
enum<string>
padrão:asc

Direção da ordenação: asc ou desc.

Opções disponíveis:
asc,
desc
transaction_id
string

Filtrar pelo ID da transação Pix original (32 caracteres).

status
enum<string>

Filtrar pelo status da devolução.

Opções disponíveis:
OPEN,
CLOSED,
CANCELLED
requesting_participant
string

Filtrar pelo ISPB do participante solicitante (8 dígitos).

contested_participant
string

Filtrar pelo ISPB do participante contestado (8 dígitos).

infraction_id
string

Filtrar pelo ID do relato de infração relacionado (UUID).

analysis_result
enum<string>

Filtrar pelo resultado da análise da devolução.

Opções disponíveis:
TOTALLY_ACCEPTED,
PARTIALLY_ACCEPTED,
REJECTED
refund_transaction_id
string

Filtrar pelo ID da transação de devolução (32 caracteres).

modified_after
string

Filtrar por registros modificados após este timestamp (formato RFC3339: 2024-01-15T10:30:00Z).

modified_before
string

Filtrar por registros modificados antes deste timestamp (formato RFC3339: 2024-01-15T10:30:00Z).

Resposta

Lista de solicitações de devolução recuperada com sucesso.

items
object[]
page
integer
Exemplo:

1

limit
integer
Exemplo:

10