BluxBlux
JavascriptCore

Get Payments

Fetch a paginated list of Stellar payments using the Blux core SDK.

The getPayments function returns a paginated list of Stellar payments.

The return value contains two properties:

  • response — the records you can use directly
  • builder — exposes next() and prev() to paginate through results

Type

export type CallBuilderOptions = {
  cursor?: string;
  limit?: number;
  network?: string;
  order?: "asc" | "desc";
};

type GetPaymentsOptions = CallBuilderOptions & {
  forAccount?: string;
  forLedger?: string | number;
  forTransaction?: string;
  includeFailed?: boolean;
};

Usage

import { core } from "@bluxcc/core";

const result = await core.getPayments({});

Get Orderbook

Fetch orderbook data using the Blux core SDK.

Get Strict Receive Paths

Fetch strict receive payment paths using the Blux core SDK.

On this page

TypeUsage