Skip to main content
GET
List contract effects on your merchants' receivables

Authorizations

x-api-key
string
header
required

Company API key for authentication

Query Parameters

merchant_document
string

Filter by the merchant's CNPJ or CPF; formatting is stripped

external_contract_id
string

Filter by the contract's key

status
enum<string>[]

Comma-separated statuses. Defaults to ACTIVE.

Available options:
ACTIVE,
CANCELLED
effect_type
enum<string>[]

Comma-separated effect types

Available options:
OWNERSHIP_TRANSFER,
GUARANTEE,
GUARANTEE_PLEDGE,
GUARANTEE_FIDUCIARY_ASSIGNMENT,
JUDICIAL_SEIZURE,
FINANCIAL_RESERVE,
CESSION_PROMISE
expected_settlement_date_from
string<date>

Settlement date from (inclusive), YYYY-MM-DD

expected_settlement_date_to
string<date>

Settlement date until (inclusive), YYYY-MM-DD

sort
string

expected_settlement_date or created_at, - prefix for descending

page
integer
default:1

Page number

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

Number of items per page

Required range: 1 <= x <= 100

Response

Contract effects

data
object[]
required
pagination
object
required
latest_snapshot_date
string<date> | null
required

The date of the latest snapshot Rinne received; null before the first one. When it is older than you expect, the effects are older too.

Example:

"2026-10-14"