1 of 1

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.

This method will use 20 Compute Units.

Reference: Here

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.

This method will use 20 Compute Units.

Reference: Here

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.

GEThttps://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ledgers/{sequence}/payments

Path parameters

sequence*integer

The sequence number of a specific ledger.

Example: 0

Query parameters

cursorinteger

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

Example: 6606617478959105

orderenum

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.

ascdesc

limitinteger

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.

Example: 10

include_failedenum

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

truefalse

joinany

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

Response

Success

Body

_linksobject

selflink (object)

href*string (link)

templatedboolean

nextlink (object)

href*string (link)

templatedboolean

prevlink (object)

href*string (link)

templatedboolean

_embeddedobject

recordsarray of object

_linksobject

self*link (object)

href*string (link)

templatedboolean

transaction*link (object)

href*string (link)

templatedboolean

effects*link (object)

href*string (link)

templatedboolean

succeeds*link (object)

href*string (link)

templatedboolean

precedes*link (object)

href*string (link)

templatedboolean

id*id (string)

paging_token*string

transaction_successful*boolean

source_account*address (string)

Pattern: G[A-Z0-9]{55}

type*string

Example: "payment"

type_i*string

created_at*string

transaction_hash*string

asset_type*string

asset_codeenum

nativecredit_alphanum4credit_alphanum12

asset_issueraddress (string)

Pattern: G[A-Z0-9]{55}

from*address (string)

Pattern: G[A-Z0-9]{55}

to*address (string)

Pattern: G[A-Z0-9]{55}

amount*string

Request

Response

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.

GEThttps://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ledgers/{sequence}/payments

Path parameters

sequence*integer

The sequence number of a specific ledger.

Example: 0

Query parameters

cursorinteger

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

Example: 6606617478959105

orderenum

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.

ascdesc

limitinteger

Example: 10

include_failedenum

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

truefalse

joinany

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

Response

Success

Body

_linksobject

selflink (object)

href*string (link)

templatedboolean

nextlink (object)

href*string (link)

templatedboolean

prevlink (object)

href*string (link)

templatedboolean

_embeddedobject

recordsarray of object

_linksobject

self*link (object)

href*string (link)

templatedboolean

transaction*link (object)

href*string (link)

templatedboolean

effects*link (object)

href*string (link)

templatedboolean

succeeds*link (object)

href*string (link)

templatedboolean

precedes*link (object)

href*string (link)

templatedboolean

id*id (string)

paging_token*string

transaction_successful*boolean

source_account*address (string)

Pattern: G[A-Z0-9]{55}

type*string

Example: "payment"

type_i*string

created_at*string

transaction_hash*string

asset_type*string

asset_codeenum

nativecredit_alphanum4credit_alphanum12

asset_issueraddress (string)

Pattern: G[A-Z0-9]{55}

from*address (string)

Pattern: G[A-Z0-9]{55}

to*address (string)

Pattern: G[A-Z0-9]{55}

amount*string

Request

Response

const response = await fetch('https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ledgers/{sequence}/payments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "_links": {
    "self": {
      "href": "text",
      "templated": false
    },
    "next": {
      "href": "text",
      "templated": false
    },
    "prev": {
      "href": "text",
      "templated": false
    }
  },
  "_embedded": {
    "records": [
      {
        "_links": {
          "self": {
            "href": "text",
            "templated": false
          },
          "transaction": {
            "href": "text",
            "templated": false
          },
          "effects": {
            "href": "text",
            "templated": false
          },
          "succeeds": {
            "href": "text",
            "templated": false
          },
          "precedes": {
            "href": "text",
            "templated": false
          }
        },
        "id": "text",
        "paging_token": "text",
        "transaction_successful": false,
        "source_account": "text",
        "type": "payment",
        "type_i": "text",
        "created_at": "text",
        "transaction_hash": "text",
        "asset_type": "text",
        "asset_code": "native",
        "asset_issuer": "text",
        "from": "text",
        "to": "text",
        "amount": "text"
      }
    ]
  }
}