Retrieve a Ledger's Payments

GET 
https://horizon-testnet.stellar.org/ledgers/:sequence/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.

Request

Path Parameters

sequence integerrequired

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

200

Success

application/json

Schema

Schema

_links object
self object
hreflinkrequired
templatedboolean
next object
hreflinkrequired
templatedboolean
prev object
hreflinkrequired
templatedboolean
_embedded object
records object[]
Array [
_links object
self objectrequired
hreflinkrequired
templatedboolean
transaction objectrequired
hreflinkrequired
templatedboolean
effects objectrequired
hreflinkrequired
templatedboolean
succeeds objectrequired
hreflinkrequired
templatedboolean
precedes objectrequired
hreflinkrequired
templatedboolean
idid (string)required
paging_tokenstringrequired
transaction_successfulbooleanrequired
source_accountaddress (string)required
Possible values: Value must match regular expression G[A-Z0-9]{55}
typestringrequired
Example: payment
type_istringrequired
created_atstringrequired
transaction_hashstringrequired
asset_typestringrequired
asset_code
Possible values: [native, credit_alphanum4, credit_alphanum12]
asset_issueraddress (string)
Possible values: Value must match regular expression G[A-Z0-9]{55}
fromaddress (string)required
Possible values: Value must match regular expression G[A-Z0-9]{55}
toaddress (string)required
Possible values: Value must match regular expression G[A-Z0-9]{55}
amountstringrequired
]

Example (auto)

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

RetrieveALedgersPayments

{
  "_links": {
    "self": {
      "href": "https://horizon-testnet.stellar.org/ledgers/27521176/payments?cursor=&limit=1&order=asc"
    },
    "next": {
      "href": "https://horizon-testnet.stellar.org/ledgers/27521176/payments?cursor=118202550867476481&limit=1&order=asc"
    },
    "prev": {
      "href": "https://horizon-testnet.stellar.org/ledgers/27521176/payments?cursor=118202550867476481&limit=1&order=desc"
    }
  },
  "_embedded": {
    "records": [
      {
        "_links": {
          "self": {
            "href": "https://horizon-testnet.stellar.org/operations/118202550867476481"
          },
          "transaction": {
            "href": "https://horizon-testnet.stellar.org/transactions/971454b84a82baa38afa975e9eb4ff2632821b5a3e7f7993a7e20bbd9d7633ea"
          },
          "effects": {
            "href": "https://horizon-testnet.stellar.org/operations/118202550867476481/effects"
          },
          "succeeds": {
            "href": "https://horizon-testnet.stellar.org/effects?order=desc&cursor=118202550867476481"
          },
          "precedes": {
            "href": "https://horizon-testnet.stellar.org/effects?order=asc&cursor=118202550867476481"
          }
        },
        "id": "118202550867476481",
        "paging_token": "118202550867476481",
        "transaction_successful": true,
        "source_account": "GDQWI6FKB72DPOJE4CGYCFQZKRPQQIOYXRMZ5KEVGXMG6UUTGJMBCASH",
        "type": "payment",
        "type_i": 1,
        "created_at": "2019-12-30T22:35:49Z",
        "transaction_hash": "971454b84a82baa38afa975e9eb4ff2632821b5a3e7f7993a7e20bbd9d7633ea",
        "asset_type": "credit_alphanum4",
        "asset_code": "NODL",
        "asset_issuer": "GB2Y3AWXVROM2BHFQKQPTWKIOI3TZEBBD3LTKTVQTKEPXGOBE742NODL",
        "from": "GDQWI6FKB72DPOJE4CGYCFQZKRPQQIOYXRMZ5KEVGXMG6UUTGJMBCASH",
        "to": "GDGJS7AXAUFDZARIRDVZ5V7CFW6XY47WSBE2OVLCCGCDWOE7INKYN3PS",
        "amount": "0.0000017"
      }
    ]
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://horizon-testnet.stellar.org/ledgers/:sequence/payments");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://horizon-testnet.stellar.org

Parameters

sequence — pathrequired

cursor — query

order — query

---ascdesc

limit — query

include_failed — query

---

join — query

ResponseClear

Click the Send API Request button above and see the response here!