Skip to main content
GET
Listar recebíveis

Authorizations

Authorization
string
header
required

Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.

Query Parameters

status
enum<string>

Filtrar por status

Available options:
pending,
scheduled,
settled,
anticipated,
canceled,
failed
payment_method
enum<string>

Filtrar por método de pagamento

Available options:
credit_card,
debit_card,
pix,
boleto
settlement_date_from
string<date-time>

Data de liquidação inicial

settlement_date_to
string<date-time>

Data de liquidação final

charge_id
string<uuid>

ID da cobrança associada

page
integer
default:1

Número da página (mínimo: 1, padrão: 1)

Required range: x >= 1
limit
integer
default:20

Itens por página (1-100, padrão: 20)

Required range: 1 <= x <= 100

Response

Recebíveis listados com sucesso

success
boolean
Example:

true

message
string
data
object[]
pagination
object