Skip to main content
GET
/
v1
/
ledger-entries
Get ledger entries
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/ledger-entries \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "le_123456789",
      "posting_set_id": "ps_123456789",
      "pair_token": "pair_123456789",
      "event_id": "evt_123456789",
      "owner_type": "COMPANY",
      "owner_id": "comp_123456789",
      "amount": 10050,
      "operation": "CREDIT",
      "type": "TRANSACTION",
      "currency": "BRL",
      "payment_date": "2023-12-01",
      "installment": 1,
      "total_installments": 1,
      "outstanding_amount": 0,
      "settled": true,
      "created_at": "2023-12-01T10:00:00.000Z",
      "updated_at": "2023-12-01T10:00:00.000Z",
      "settlement_items": [
        {
          "id": "si_123456789",
          "ledger_entry_id": "le_123456789",
          "settled_amount": 10050,
          "settlement_date": "2023-12-01",
          "method": "PIX",
          "status": "PAID",
          "operation_id": "op_123456789",
          "created_at": "2023-12-01T10:00:00.000Z",
          "updated_at": "2023-12-01T10:00:00.000Z",
          "affiliation_bank_account_id": "ba_123456789",
          "settlement_bank_account_id": "sba_123456789"
        }
      ],
      "company_id": "comp_123456789",
      "organization_id": "org_123456789",
      "affiliation_id": "aff_123456789",
      "transaction_id": "tx_123456789",
      "refund_id": "ref_123456789",
      "dispute_id": "dis_123456789",
      "cashout_id": "co_123456789",
      "fully_settled_at": "2023-12-01T10:00:00.000Z",
      "last_clearing_at": "2023-12-01T10:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3,
    "hasNext": true,
    "hasPrev": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.rinne.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

Query Parameters

​
page
integer
default:1

Page number for pagination

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

Number of entries per page

Required range: 1 <= x <= 100
​
owner_id
string

Filter by owner ID

​
posting_set_id
string

Filter by posting set ID

​
event_id
string

Filter by event ID

​
type
enum<string>[]

Comma-separated list of entry types to filter by.

Available options:
TRANSACTION,
ORGANIZATION_FEE,
PLATFORM_COST,
PROVIDER_COST,
ORGANIZATION_ANTICIPATION_FEE,
PLATFORM_ANTICIPATION_COST,
PLATFORM_REFUND_COST,
PROVIDER_REFUND_COST,
TRANSACTION_REFUND,
TRANSACTION_REFUND_REVERSAL,
ORGANIZATION_FEE_REFUND,
PLATFORM_COST_REFUND,
PROVIDER_COST_REFUND,
TRANSACTION_DISPUTE,
TRANSACTION_DISPUTE_REVERSAL
​
operation
enum<string>

Filter by operation type

Available options:
CREDIT,
DEBIT
​
payment_date_from
string<date>

Start payment date (inclusive)

​
payment_date_to
string<date>

End payment date (inclusive)

​
transaction_id
string

Filter by transaction ID

​
refund_id
string

Filter by refund ID

​
cashout_id
string

Filter by cashout ID

​
settled
boolean

Filter by settled status

​
sort
enum<string>[]

Multi-field sort string (e.g., -created_at,amount). Allowed fields: created_at, payment_date, amount

Available options:
created_at,
payment_date,
amount,
-created_at,
-payment_date,
-amount

Response

Paginated list of ledger entries

Paginated list of ledger entries

​
data
object[]
required

Array of ledger entries

​
pagination
object
required