Sign in

v1

latestOpenAPI 3.1.02026-07-247328324.6 KB
Sales

Get ledger transactions

get/programs/{id}/transactions/{period}

Path parameters

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

periodstring required

period of data to be retrieved

Example:2024-01

period of data to be retrieved

Query parameters

currencystring

currency of the transaction

Example:USD

currency of the transaction

ledger'payout' | 'payin' | 'reserve'

filter by type of ledger: payout is the ledger that tracks funds from sivo to the seller. payin is the ledger that tracks funds from the seller to sivo. reserve is the ledger that tracks deposit used for daily and minimum fees

filter by type of ledger: payout is the ledger that tracks funds from sivo to the seller. payin is the ledger that tracks funds from the seller to sivo. reserve is the ledger that tracks deposit used for daily and minimum fees

Response

Successful operation

Example response

{
  "data": [
    {
      "date": "2024-01-15",
      "settled_at": "2024-01-15T10:30:00Z",
      "created_at": "2024-01-15T10:30:00Z",
      "id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "currency": "USD",
      "amount": 10000,
      "amount_usd": 10000,
      "transaction_id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "account_id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "seller_id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "program_id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "terms_id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "invoice_id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "fiscal_invoice_id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "balance": 10000,
      "balance_usd": 10000
    }
  ]
}