Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Listing payments API docs

To view your payment history, you can list all the payments that have been sent and received.

Rust
let response = sdk
    .list_payments(ListPaymentsRequest {
        offset: None,
        limit: None,
    })
    .await?;
let payments = response.payments;
Swift
let response = try await sdk.listPayments(
    request: ListPaymentsRequest(
        offset: nil,
        limit: nil
    ))
let payments = response.payments
Kotlin
try {
    val response = sdk.listPayments(ListPaymentsRequest(null, null))
    val payments = response.payments
} catch (e: Exception) {
    // handle error
}
Javascript
const response = await sdk.listPayments({})
const payments = response.payments
React Native
const response = await sdk.listPayments({
  offset: undefined,
  limit: undefined
})
const payments = response.payments
Flutter
ListPaymentsRequest request = ListPaymentsRequest();
ListPaymentsResponse response = await sdk.listPayments(request: request);
List<Payment> payments = response.payments;
Python
response = await sdk.list_payments(request=ListPaymentsRequest())
payments = response.payments
Go
response, err := sdk.ListPayments(breez_sdk_spark.ListPaymentsRequest{})

if sdkErr := err.(*breez_sdk_spark.SdkError); sdkErr != nil {
    return nil, err
}

payments := response.Payments

Filtering Payments

When listing payment you can also page the list results:

Rust
let response = sdk
    .list_payments(ListPaymentsRequest {
        offset: Some(0),
        limit: Some(50),
    })
    .await?;
let payments = response.payments;
Swift
let response = try await sdk.listPayments(
    request: ListPaymentsRequest(
        offset: 0,
        limit: 50
    ))
let payments = response.payments
Kotlin
try {
    val response = sdk.listPayments(
        ListPaymentsRequest(
            offset = 0u,
            limit = 50u
        ))
    val payments = response.payments
} catch (e: Exception) {
    // handle error
}
Javascript
const response = await sdk.listPayments({
  offset: 0,
  limit: 50
})
const payments = response.payments
React Native
const response = await sdk.listPayments({
  offset: 0,
  limit: 50
})
const payments = response.payments
Flutter
ListPaymentsRequest request = ListPaymentsRequest(
  offset: 0,
  limit: 50,
);
ListPaymentsResponse response = await sdk.listPayments(request: request);
List<Payment> payments = response.payments;
Python
request = ListPaymentsRequest(offset=0, limit=50)
response = await sdk.list_payments(request=request)
payments = response.payments
Go
limit := uint32(50)
offset := uint32(0)
request := breez_sdk_spark.ListPaymentsRequest{
    Offset: &offset,
    Limit:  &limit,
}
response, err := sdk.ListPayments(request)

if sdkErr := err.(*breez_sdk_spark.SdkError); sdkErr != nil {
    return nil, err
}

payments := response.Payments

Get Payment API docs

You can also retrieve a single payment using the payment id:

Rust
let payment_id = "<payment id>".to_string();
let response = sdk.get_payment(GetPaymentRequest { payment_id }).await?;
let payment = response.payment;
Swift
let paymentId = "<payment id>"
let response = try await sdk.getPayment(
    request: GetPaymentRequest(paymentId: paymentId)
)
let payment = response.payment
Kotlin
try {
    val paymentId = "<payment id>";
    val response = sdk.getPayment(GetPaymentRequest(paymentId))
    val payment = response.payment
} catch (e: Exception) {
    // handle error
}
Javascript
const paymentId = '<payment id>'
const response = await sdk.getPayment({
  paymentId
})
const payment = response.payment
React Native
const paymentId = '<payment id>'
const response = await sdk.getPayment({
  paymentId
})
const payment = response.payment
Flutter
String paymentId = "<payment id>";
GetPaymentRequest request = GetPaymentRequest(paymentId: paymentId);
GetPaymentResponse response = await sdk.getPayment(request: request);
Payment payment = response.payment;
Python
payment_id = "<payment id>"
response = await sdk.get_payment(
    request=GetPaymentRequest(payment_id=payment_id)
)
payment = response.payment
Go
paymentId := "<payment id>"
request := breez_sdk_spark.GetPaymentRequest{
    PaymentId: paymentId,
}
response, err := sdk.GetPayment(request)

if sdkErr := err.(*breez_sdk_spark.SdkError); sdkErr != nil {
    return nil, err
}

payment := response.Payment