Skip to main content

Retrieve a Ledger's Payments​

This endpoint returns all payment-related operations in a specific ledger. Operation types that can be returned by this endpoint include: create_account, payment, path_payment, and account_merge.

Path Parameters
  • sequence integer required

    The sequence number of a specific ledger.

Query Parameters
  • cursor integer

    A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.

  • order string

    Possible values: [asc, desc]

    A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.

  • limit integer

    The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.

  • include_failed boolean

    Possible values: [true, false]

    Set to true to include failed operations in results. Options include true and false.

  • join any

    Set to transactions to include the transactions which created each of the operations in the response.

Responses

Success

Schema
  • _links object
  • self object
  • href link required
  • templated boolean
  • next object
  • href link required
  • templated boolean
  • prev object
  • href link required
  • templated boolean
  • _embedded object
  • records object[]
  • Array [
  • _links object
  • self object required
  • href link required
  • templated boolean
  • transaction object required
  • href link required
  • templated boolean
  • effects object required
  • href link required
  • templated boolean
  • succeeds object required
  • href link required
  • templated boolean
  • precedes object required
  • href link required
  • templated boolean
  • id id required
  • paging_token string required
  • transaction_successful boolean required
  • source_account address required

    Possible values: Value must match regular expression G[A-Z0-9]{55}

  • type string required
  • type_i string required
  • created_at string required
  • transaction_hash string required
  • asset_type string required
  • asset_code

    Possible values: [native, credit_alphanum4, credit_alphanum12]

  • asset_issuer address

    Possible values: Value must match regular expression G[A-Z0-9]{55}

  • from address required

    Possible values: Value must match regular expression G[A-Z0-9]{55}

  • to address required

    Possible values: Value must match regular expression G[A-Z0-9]{55}

  • amount string required
  • ]
Loading...
Last updated on