Please note that this method can be used in streaming mode. Streaming mode allows you to listen for new payments as they are added to the Stellar 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

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 payment

next

object

The next link object which contains the following field:

href

string

A link to the next page of payment, allowing for pagination

prev

object

The prev link object which contains the following field:

href

string

A link to the previous page of payment, enabling navigation backward

_embedded

object

Embedded operation object which contains the following fields:

records

array

An array containing individual payment records that match the query parameters

_links

object

Links to related resources associated with the specific payment

self

object

The self link object which contains the following field:

href

string

A link to the current payment, allowing navigation to the details of the operation

transaction

object

The transaction link object which contains the following field:

href

string

A link to the transaction containing the payment, enabling access to the details of the parent transaction

effects

object

The effects link object which contains the following field:

href

string

A link to the effects associated with the payment

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 payment'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 payment's order

id

string

The unique identifier of the payment

paging_token

string

A token used for pagination, providing a reference point for navigating between pages of payment records

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

amount

string

The amount associated with the payment

starting_balance

string

The starting balance of the account

funder

string

Specifies the account responsible for funding another account's initial balance

account

string

Account associated with the payment

from

string

The address which initiated the payment

to

string

The address which recieved the payment

asset_type

string

The type of asset involved in the operation

asset_code

string

The code of asset involved in the operation

asset_issuer

string

The issuer of asset involved in the operation

asset_balance_changes

array

(Optional) An array of asset balance changes associated with the operation

destination_muxed_id

string

(Optional) The muxed account ID of the destination when the destination is a muxed account

Request

1
curl -L -X GET 'https://docs-demo.stellar-mainnet.quiknode.pro/payments' \
2
    -H 'Accept: application/json'

1
curl -L -X GET 'https://docs-demo.stellar-mainnet.quiknode.pro/payments' \
2
    -H 'Accept: application/json'

1
var myHeaders = new Headers();
2
myHeaders.append("Accept", "application/json");
3

4
var requestOptions = {
5
  method: 'GET',
6
  headers: myHeaders,
7
  redirect: 'follow'
8
};
9

10
fetch("https://docs-demo.stellar-mainnet.quiknode.pro/payments", requestOptions)
11
  .then(response => response.text())
12
  .then(result => console.log(result))
13
  .catch(error => console.log('error', error));

1
var myHeaders = new Headers();
2
myHeaders.append("Accept", "application/json");
3

4
var requestOptions = {
5
  method: 'GET',
6
  headers: myHeaders,
7
  redirect: 'follow'
8
};
9

10
fetch("https://docs-demo.stellar-mainnet.quiknode.pro/payments", requestOptions)
11
  .then(response => response.text())
12
  .then(result => console.log(result))
13
  .catch(error => console.log('error', error));

1
import requests
2

3
url = "https://docs-demo.stellar-mainnet.quiknode.pro/payments"
4

5
payload = {}
6
headers = {
7
  'Accept': 'application/json'
8
}
9

10
response = requests.request("GET", url, headers=headers, data=payload)
11

12
print(response.text)
13

1
import requests
2

3
url = "https://docs-demo.stellar-mainnet.quiknode.pro/payments"
4

5
payload = {}
6
headers = {
7
  'Accept': 'application/json'
8
}
9

10
response = requests.request("GET", url, headers=headers, data=payload)
11

12
print(response.text)
13

1
require "uri"
2
require "net/http"
3

4
url = URI("https://docs-demo.stellar-mainnet.quiknode.pro/payments")
5

6
http = Net::HTTP.new(url.host, url.port);
7
request = Net::HTTP::Get.new(url)
8
request["Accept"] = "application/json"
9

10
response = http.request(request)
11
puts response.read_body
12

1
require "uri"
2
require "net/http"
3

4
url = URI("https://docs-demo.stellar-mainnet.quiknode.pro/payments")
5

6
http = Net::HTTP.new(url.host, url.port);
7
request = Net::HTTP::Get.new(url)
8
request["Accept"] = "application/json"
9

10
response = http.request(request)
11
puts response.read_body
12

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free