Skip to main content
GET

Parâmetros de query

number
Número da página (padrão 1).
number
Itens por página (padrão 50, máximo 100).
string
ISO 8601 — início do período (createdAt).
string
ISO 8601 — fim do período (createdAt).
string
PENDING, PROCESSING, COMPLETED, FAILED, CANCELED ou REVERSED.
string
Filtro exato pela referência externa.
Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.

Authorizations

X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Query Parameters

page
integer
default:1
Required range: x >= 1
pageSize
integer
default:50
Required range: 1 <= x <= 100
dateFrom
string<date-time>
dateTo
string<date-time>
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELED,
REVERSED
externalReference
string

Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.

Response

Lista paginada de reembolsos PIX.

success
boolean
required
message
string
required
data
object
required
requestId
string