List All Payments

GET 
/payments

This endpoint lists all Successful payment-related operations and can be used in streaming mode. Streaming mode allows you to listen for new payments as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time. Operations that can be returned by this endpoint include: create_account, payment, path_payment_strict_recieve, path_payment_strict_send, and account_merge .

Request

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

oneOf

CreateAccount

_links

object

self

object

required

href linkrequired

templated boolean

transaction

object

required

href linkrequired

templated boolean

effects

object

required

href linkrequired

templated boolean

succeeds

object

required

href linkrequired

templated boolean

precedes

object

required

href linkrequired

templated boolean

id id (string)required

paging_token stringrequired

transaction_successful booleanrequired

source_account address (string)required

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

type stringrequired

type_i numberrequired

created_at stringrequired

transaction_hash stringrequired

starting_balance stringrequired

funder address (string)required

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

account address (string)required

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

Payment

_embedded

object

records

object[]

Array [

_links

object

self

object

required

href linkrequired

templated boolean

transaction

object

required

href linkrequired

templated boolean

effects

object

required

href linkrequired

templated boolean

succeeds

object

required

href linkrequired

templated boolean

precedes

object

required

href linkrequired

templated boolean

id id (string)required

paging_token stringrequired

transaction_successful booleanrequired

source_account address (string)required

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

type stringrequired

type_i stringrequired

created_at stringrequired

transaction_hash stringrequired

asset_type stringrequired

asset_code

Possible values: [native, credit_alphanum4, credit_alphanum12]

asset_issuer address (string)

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

from address (string)required

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

to address (string)required

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

amount stringrequired

]

PathPaymentStrictReceive

_links

object

self

object

required

href linkrequired

templated boolean

transaction

object

required

href linkrequired

templated boolean

effects

object

required

href linkrequired

templated boolean

succeeds

object

required

href linkrequired

templated boolean

precedes

object

required

href linkrequired

templated boolean

id id (string)required

paging_token stringrequired

transaction_successful booleanrequired

source_account address (string)required

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

type stringrequired

type_i numberrequired

created_at stringrequired

transaction_hash stringrequired

asset_type string

Possible values: [native, credit_alphanum4, credit_alphanum12]

asset_code string

asset_issuer address (string)

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

from address (string)required

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

to address (string)required

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

amount stringrequired

path

object[]

required

Array [

asset_type string

Possible values: [native, credit_alphanum4, credit_alphanum12]

asset_code string

asset_issuer address (string)

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

]

source_amount stringrequired

destination_min stringrequired

source_asset_type string

source_asset_code string

source_asset_issuer address (string)

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

PathPaymentStrictSend

_links

object

self

object

required

href linkrequired

templated boolean

transaction

object

required

href linkrequired

templated boolean

effects

object

required

href linkrequired

templated boolean

succeeds

object

required

href linkrequired

templated boolean

precedes

object

required

href linkrequired

templated boolean

id id (string)required

paging_token stringrequired

transaction_successful booleanrequired

source_account address (string)required

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

type stringrequired

type_i numberrequired

created_at stringrequired

transaction_hash stringrequired

asset_type string

Possible values: [native, credit_alphanum4, credit_alphanum12]

asset_code string

asset_issuer address (string)

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

from address (string)required

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

to address (string)required

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

amount stringrequired

path

object[]

required

Array [

asset_type string

Possible values: [native, credit_alphanum4, credit_alphanum12]

asset_code string

asset_issuer address (string)

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

]

source_amount stringrequired

source_max string

source_asset_type stringrequired

source_asset_code string

source_asset_issuer address (string)

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

AccountMerge

_links

object

self

object

required

href linkrequired

templated boolean

transaction

object

required

href linkrequired

templated boolean

effects

object

required

href linkrequired

templated boolean

succeeds

object

required

href linkrequired

templated boolean

precedes

object

required

href linkrequired

templated boolean

id id (string)required

paging_token stringrequired

transaction_successful booleanrequired

source_account address (string)required

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

type stringrequired

type_i numberrequired

created_at stringrequired

transaction_hash stringrequired

account address (string)required

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

into address (string)required

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

InvokeHostFunction

_links

object

self

object

required

href linkrequired

templated boolean

transaction

object

required

href linkrequired

templated boolean

effects

object

required

href linkrequired

templated boolean

succeeds

object

required

href linkrequired

templated boolean

precedes

object

required

href linkrequired

templated boolean

id id (string)required

paging_token stringrequired

transaction_successful booleanrequired

source_account address (string)required

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

type stringrequired

type_i numberrequired

created_at stringrequired

transaction_hash stringrequired

function string

parameters

object[]

Array [

value string

type string

]

address string

salt string

asset_balance_changes

object[]

Array [

asset_type string

asset_code

Possible values: [native, credit_alphanum4, credit_alphanum12]

asset_issuer address (string)

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

type string

Possible values: [transfer, mint, clawback, burn]

from string

to string

amount string

]

_links

object

self

object

href linkrequired

templated boolean

next

object

href linkrequired

templated boolean

prev

object

href linkrequired

templated boolean

Example (from schema)

{
  "_links": {
    "self": {
      "href": "string",
      "templated": true
    },
    "next": {
      "href": "string",
      "templated": true
    },
    "prev": {
      "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": "create_account",
  "type_i": 0,
  "created_at": "string",
  "transaction_hash": "string",
  "starting_balance": "string",
  "funder": "string",
  "account": "string"
}

ListAllPayments

{
  "_links": {
    "self": {
      "href": "https://horizon-testnet.stellar.org/payments?cursor=&limit=3&order=asc"
    },
    "next": {
      "href": "https://horizon-testnet.stellar.org/payments?cursor=33676838572033&limit=3&order=asc"
    },
    "prev": {
      "href": "https://horizon-testnet.stellar.org/payments?cursor=12884905985&limit=3&order=desc"
    }
  },
  "_embedded": {
    "records": [
      {
        "_links": {
          "self": {
            "href": "https://horizon-testnet.stellar.org/operations/12884905985"
          },
          "transaction": {
            "href": "https://horizon-testnet.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"
          },
          "effects": {
            "href": "https://horizon-testnet.stellar.org/operations/12884905985/effects"
          },
          "succeeds": {
            "href": "https://horizon-testnet.stellar.org/effects?order=desc&cursor=12884905985"
          },
          "precedes": {
            "href": "https://horizon-testnet.stellar.org/effects?order=asc&cursor=12884905985"
          }
        },
        "id": "12884905985",
        "paging_token": "12884905985",
        "transaction_successful": true,
        "source_account": "GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7",
        "type": "create_account",
        "type_i": 0,
        "created_at": "2015-09-30T17:15:54Z",
        "transaction_hash": "3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889",
        "starting_balance": "20.0000000",
        "funder": "GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7",
        "account": "GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"
      },
      {
        "_links": {
          "self": {
            "href": "https://horizon-testnet.stellar.org/operations/12884905986"
          },
          "transaction": {
            "href": "https://horizon-testnet.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"
          },
          "effects": {
            "href": "https://horizon-testnet.stellar.org/operations/12884905986/effects"
          },
          "succeeds": {
            "href": "https://horizon-testnet.stellar.org/effects?order=desc&cursor=12884905986"
          },
          "precedes": {
            "href": "https://horizon-testnet.stellar.org/effects?order=asc&cursor=12884905986"
          }
        },
        "id": "12884905986",
        "paging_token": "12884905986",
        "transaction_successful": true,
        "source_account": "GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7",
        "type": "payment",
        "type_i": 1,
        "created_at": "2015-09-30T17:15:54Z",
        "transaction_hash": "3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889",
        "asset_type": "native",
        "from": "GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7",
        "to": "GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB",
        "amount": "99999999959.9999700"
      },
      {
        "_links": {
          "self": {
            "href": "https://horizon-testnet.stellar.org/operations/33676838572033"
          },
          "transaction": {
            "href": "https://horizon-testnet.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a"
          },
          "effects": {
            "href": "https://horizon-testnet.stellar.org/operations/33676838572033/effects"
          },
          "succeeds": {
            "href": "https://horizon-testnet.stellar.org/effects?order=desc&cursor=33676838572033"
          },
          "precedes": {
            "href": "https://horizon-testnet.stellar.org/effects?order=asc&cursor=33676838572033"
          }
        },
        "id": "33676838572033",
        "paging_token": "33676838572033",
        "transaction_successful": true,
        "source_account": "GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB",
        "type": "create_account",
        "type_i": 0,
        "created_at": "2015-10-01T04:15:01Z",
        "transaction_hash": "2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a",
        "starting_balance": "20.0000000",
        "funder": "GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB",
        "account": "GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4"
      }
    ]
  }
}

Loading...