Passer au contenu principal
GET
/
balances
/
ledger
JavaScript
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const balanceLedgerEntry of client.balances.retrieveLedger()) {
  console.log(balanceLedgerEntry.id);
}
import os
from dodopayments import DodoPayments

client = DodoPayments(
bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"), # This is the default and can be omitted
)
page = client.balances.retrieve_ledger()
page = page.items[0]
print(page.id)
package main

import (
"context"
"fmt"

"github.com/dodopayments/dodopayments-go"
"github.com/dodopayments/dodopayments-go/option"
)

func main() {
client := dodopayments.NewClient(
option.WithBearerToken("My Bearer Token"),
)
page, err := client.Balances.GetLedger(context.TODO(), dodopayments.BalanceGetLedgerParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.balances.BalanceRetrieveLedgerPage;
import com.dodopayments.api.models.balances.BalanceRetrieveLedgerParams;

public final class Main {
private Main() {}

public static void main(String[] args) {
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

BalanceRetrieveLedgerPage page = client.balances().retrieveLedger();
}
}
package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.balances.BalanceRetrieveLedgerPage
import com.dodopayments.api.models.balances.BalanceRetrieveLedgerParams

fun main() {
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

val page: BalanceRetrieveLedgerPage = client.balances().retrieveLedger()
}
require "dodopayments"

dodo_payments = Dodopayments::Client.new(
bearer_token: "My Bearer Token",
environment: "test_mode" # defaults to "live_mode"
)

page = dodo_payments.balances.retrieve_ledger

puts(page)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;

$client = new Client(
bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
environment: 'test_mode',
);

try {
$page = $client->balances->retrieveLedger(
createdAtGte: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
createdAtLte: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
currency: 'AED',
eventType: 'payment',
limit: 0,
pageNumber: 0,
pageSize: 0,
referenceObjectID: 'reference_object_id',
);

var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}
using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Balances;

DodoPaymentsClient client = new();

BalanceRetrieveLedgerParams parameters = new();

var page = await client.Balances.RetrieveLedger(parameters);
await foreach (var item in page.Paginate())
{
Console.WriteLine(item);
}
use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
let client = Client::from_env()?;
let result = client
.balances()
.retrieve_ledger()
.query(serde_json::json!({}))
.await?;
println!("{result:?}");
Ok(())
}
curl --request GET \
--url https://test.dodopayments.com/balances/ledger \
--header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "amount": 123,
      "business_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "is_credit": true,
      "usd_equivalent_amount": 123,
      "after_balance": 123,
      "before_balance": 123,
      "description": "<string>",
      "reference_object_id": "<string>"
    }
  ]
}

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de requête

created_at_gte
string<date-time>

Get events after this created time

created_at_lte
string<date-time>

Get events created before this time

reference_object_id
string

Get events history of a specific object like payment/subscription/refund/dispute

event_type
enum<string>

Filter by Ledger Event Type

Options disponibles:
payment,
refund,
refund_reversal,
dispute,
dispute_reversal,
tax,
tax_reversal,
payment_fees,
refund_fees,
refund_fees_reversal,
dispute_fees,
payout,
payout_fees,
payout_reversal,
payout_fees_reversal,
dodo_credits,
adjustment,
currency_conversion,
abandoned_cart_recovery_fee,
dunning_fees,
payment_retry_fee,
byop_fee
currency
enum<string>

Filter by currency

Options disponibles:
AED,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BYN,
BZD,
CAD,
CHF,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SLL,
SOS,
SRD,
SSP,
STN,
SVC,
SZL,
THB,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
limit
integer<int64>

Min : 1, Max : 100, default 10

page_size
integer<int32>

Page size default is 10 max is 100

Plage requise: x >= 0
page_number
integer<int32>

Page number default is 0

Plage requise: x >= 0

Réponse

200 - application/json

Balance ledger entries

items
object[]
requis
Dernière modification le 1 avril 2026