Skip to main content

Retrieve a Ledger Payments REST API Endpoint

Returns all payment-related operations in a specific ledger

Updated on
Oct 4, 2023

Retrieve a Ledger Payments REST API Endpoint

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 which is pulled from the paging_token value of a record
order
string
The designation of the order of the records. It can be ascending or descending. By default it is set to ascending
limit
integer
The maximum number of records returned
include_failed
boolean
If true, it includes failed operations in results
join
string
It includes the transactions which created each of the operations in the response

Returns

_links
object
The link object which provides links to various related resources
self
object
The self link object which contains the following field:
href
string
A link that points to the current page of liquidity_pools
templated
boolean
A boolean value that indicates whether the link is templated or not
next
object
The next link object which contains the following field:
href
string
A link to the next page of liquidity_pools, allowing for pagination
templated
boolean
A boolean value that indicates whether the link is templated or not
prev
object
The prev link object which contains the following field:
href
string
A link to the previous page of liquidity_pools, enabling navigation backward
templated
boolean
A boolean value that indicates whether the link is templated or not
_embedded
object
Embedded object which contains the following fields:
records
array
An array of transaction records, each representing a specific transaction
_links
object
Links to related resources associated with the specific operation
self
object
The self link object which contains the following field:
href
string
A link to the current operation, allowing navigation to the details of the operation
effects
object
The effects link object which contains the following field:
href
string
A link to the effects associated with the operation
succeeds
object
The succeeds link object which contains the following field:
href
string
A link to effects with an order in descending order relative to this operation's order
precedes
object
The precedes link object which contains the following field:
href
string
A link to effects with an order in ascending order relative to this operation's order
transaction
object
The transaction link object which contains the following field:
href
string
A link to the transaction containing the operation, enabling access to the details of the parent transaction
id
string
The unique identifier for the payment record
paging_token
string
The paging token for the payment record
transaction_successful
boolean
A boolean indicating whether the transaction associated with this payment was successful
source_account
string
The source account that initiated the payment
type
string
The type of payment
type_i
integer
The numeric code representing the payment type
created_at
string
The timestamp indicating when the payment was created
transaction_hash
string
The hash of the transaction containing the payment
asset_type
string
The type of asset
asset_code
string
An asset code
asset_issuer
string
An asset issuer
from
string
The address which initiated the payment
to
string
The address which recieved the payment
amount
string
The amount of the asset retrieved in the ledger
Request
1
curl -L -X GET 'https://docs-demo.stellar-mainnet.quiknode.pro/ledgers/20270/payments' \
2
-H 'Accept: application/json'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free