> ## Documentation Index
> Fetch the complete documentation index at: https://docs.validationcloud.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List All 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 .

This method will use `20` [Compute Units](/nodeapi/about/billing).

***


## OpenAPI

````yaml nodeapi/openapi/bundled-stellar-horizon-vc-urls.json GET /payments
openapi: 3.1.0
info:
  title: Horizon
  version: 0.0.1
  summary: >-
    Horizon provides an HTTP API to data in the Stellar network. It ingests and
    re-serves the data produced by the Stellar network in a form that is easier
    to consume by the average application relative to the performance-oriented
    data representations used by Stellar Core. This API serves the bridge
    between apps and Stellar Core. Projects like wallets, decentralized
    exchanges, and asset issuers use Horizon to submit transactions, query an
    account balance, or stream events like transactions to an account.
servers:
  - url: https://{network}.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>
    variables:
      network:
        default: mainnet
        enum:
          - mainnet
          - testnet
          - archive
    description: Validation Cloud Stellar Horizon RPC
security: []
tags:
  - name: Accounts
    description: >-
      Users interact with the Stellar network through accounts. Everything else
      in the ledger—assets, offers, trustlines, etc. are owned by accounts, and
      accounts must authorize all changes to the ledger through signed
      transactions.
  - name: Assets
    description: >-
      Assets are representations of value issued on the Stellar network. An
      asset consists of a type, code, and issuer.
  - name: Claimable Balances
    description: >-
      A Claimable Balance represents the transfer of ownership of some amount of
      an asset. Claimable balances provide a mechanism for setting up a payment
      which can be claimed in the future. This allows you to make payments to
      accounts which are currently not able to accept them.
  - name: Effects
    description: >-
      Effects represent specific changes that occur in the ledger as a result of
      successful operations, but are not necessarily directly reflected in the
      ledger or history, as transactions and operations are.
  - name: Fee Stats
    description: >-
      Fee stats are used to predict what fee to set for a transaction before
      submitting it to the network.
  - name: Liquidity Pools
    description: >-
      Liquidity Pools provide a simple, non-interactive way to trade large
      amounts of capital and enable high volumes of trading.
  - name: Ledgers
    description: >-
      Each ledger stores the state of the network at a point in time and
      contains all the changes - transactions, operations, effects, etc. - to
      that state.
  - name: Offers
    description: >-
      Offers are statements about how much of an asset an account wants to buy
      or sell.
  - name: Operations
    description: >-
      Operations are objects that represent a desired change to the ledger:
      payments, offers to exchange currency, changes made to account options,
      etc. Operations are submitted to the Stellar network grouped in a
      Transaction.
  - name: Order Books
    description: An order book is a collections of offers for a specific pair of assets.
  - name: Paths
    description: >-
      Paths provide information about potential path payments. A path can be
      used to populate the necessary fields for a path payment operation.
  - name: Payments
    description: >-
      Payments are objects that represent balance transfer from one address to
      another. Payments are submitted to the Stellar network grouped in a
      Transaction.
  - name: Trade Aggregations
    description: >-
      A trade aggregation represents aggregated statistics on an asset pair
      (base and counter) for a specific time period. Trade aggregations are
      useful to developers of trading clients and provide historical trade data.
  - name: Trades
    description: >-
      When an offer is fully or partially fulfilled, a trade happens. Trades can
      also be caused by successful path payments, because path payments involve
      fulfilling offers. A trade occurs between two parties—base and counter.
      Which is which is either arbitrary or determined by the calling query.
  - name: Transactions
    description: >-
      Transactions are commands that modify the ledger state and consist of one
      or more operations.
paths:
  /payments:
    get:
      tags:
        - Payments
      summary: List All Payments
      description: >-
        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 .
      operationId: ListAllPayments
      parameters:
        - $ref: '#/components/parameters/CursorParam'
        - $ref: '#/components/parameters/OrderParam'
        - $ref: '#/components/parameters/LimitParam'
        - $ref: '#/components/parameters/IncludeFailedParam'
        - $ref: '#/components/parameters/JoinParam'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Links'
                  - oneOf:
                      - $ref: '#/components/schemas/CreateAccount'
                      - $ref: '#/components/schemas/Payment'
                      - $ref: '#/components/schemas/PathPaymentStrictReceive'
                      - $ref: '#/components/schemas/PathPaymentStrictSend'
                      - $ref: '#/components/schemas/AccountMerge'
                      - $ref: '#/components/schemas/InvokeHostFunction'
              examples:
                ListAllPayments:
                  $ref: '#/components/examples/ListAllPayments'
components:
  parameters:
    CursorParam:
      name: cursor
      in: query
      required: false
      description: >-
        A number that points to a specific location in a collection of responses
        and is pulled from the paging_token value of a record.
      schema:
        type: integer
        example: 6606617478959105
    OrderParam:
      name: order
      in: query
      required: false
      description: >-
        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`.
      schema:
        type: string
        enum:
          - asc
          - desc
    LimitParam:
      name: limit
      in: query
      required: false
      description: >-
        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.
      schema:
        type: integer
        example: 10
    IncludeFailedParam:
      name: include_failed
      in: query
      required: false
      description: >-
        Set to true to include failed operations in results. Options include
        true and false.
      schema:
        type: boolean
        enum:
          - true
          - false
    JoinParam:
      name: join
      in: query
      required: false
      description: >-
        Set to transactions to include the transactions which created each of
        the operations in the response.
      schema:
        type: string
  schemas:
    Links:
      type: object
      properties:
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/link'
            next:
              $ref: '#/components/schemas/link'
            prev:
              $ref: '#/components/schemas/link'
    CreateAccount:
      type: object
      properties:
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/link'
            transaction:
              $ref: '#/components/schemas/link'
            effects:
              $ref: '#/components/schemas/link'
            succeeds:
              $ref: '#/components/schemas/link'
            precedes:
              $ref: '#/components/schemas/link'
          required:
            - self
            - transaction
            - effects
            - succeeds
            - precedes
        id:
          $ref: '#/components/schemas/id'
        paging_token:
          type: string
        transaction_successful:
          type: boolean
        source_account:
          $ref: '#/components/schemas/address'
        type:
          type: string
          example: create_account
        type_i:
          type: number
          example: 0
        created_at:
          type: string
        transaction_hash:
          type: string
        starting_balance:
          type: string
        funder:
          $ref: '#/components/schemas/address'
        account:
          $ref: '#/components/schemas/address'
      required:
        - id
        - paging_token
        - transaction_successful
        - source_account
        - type
        - type_i
        - created_at
        - transaction_hash
        - starting_balance
        - funder
        - account
    Payment:
      type: object
      properties:
        _embedded:
          type: object
          properties:
            records:
              type: array
              items:
                type: object
                properties:
                  _links:
                    type: object
                    properties:
                      self:
                        $ref: '#/components/schemas/link'
                      transaction:
                        $ref: '#/components/schemas/link'
                      effects:
                        $ref: '#/components/schemas/link'
                      succeeds:
                        $ref: '#/components/schemas/link'
                      precedes:
                        $ref: '#/components/schemas/link'
                    required:
                      - self
                      - transaction
                      - effects
                      - succeeds
                      - precedes
                  id:
                    $ref: '#/components/schemas/id'
                  paging_token:
                    type: string
                  transaction_successful:
                    type: boolean
                  source_account:
                    $ref: '#/components/schemas/address'
                  type:
                    type: string
                    example: payment
                  type_i:
                    type: string
                  created_at:
                    type: string
                  transaction_hash:
                    type: string
                  asset_type:
                    type: string
                  asset_code:
                    enum:
                      - native
                      - credit_alphanum4
                      - credit_alphanum12
                  asset_issuer:
                    $ref: '#/components/schemas/address'
                  from:
                    $ref: '#/components/schemas/address'
                  to:
                    $ref: '#/components/schemas/address'
                  amount:
                    type: string
                required:
                  - id
                  - paging_token
                  - transaction_successful
                  - source_account
                  - type
                  - type_i
                  - created_at
                  - transaction_hash
                  - asset_type
                  - from
                  - to
                  - amount
    PathPaymentStrictReceive:
      type: object
      properties:
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/link'
            transaction:
              $ref: '#/components/schemas/link'
            effects:
              $ref: '#/components/schemas/link'
            succeeds:
              $ref: '#/components/schemas/link'
            precedes:
              $ref: '#/components/schemas/link'
          required:
            - self
            - transaction
            - effects
            - succeeds
            - precedes
        id:
          $ref: '#/components/schemas/id'
        paging_token:
          type: string
        transaction_successful:
          type: boolean
        source_account:
          $ref: '#/components/schemas/address'
        type:
          type: string
          example: path_payment_strict_receive
        type_i:
          type: number
          example: 2
        created_at:
          type: string
        transaction_hash:
          type: string
        asset_type:
          type: string
          enum:
            - native
            - credit_alphanum4
            - credit_alphanum12
        asset_code:
          type: string
        asset_issuer:
          $ref: '#/components/schemas/address'
        from:
          $ref: '#/components/schemas/address'
        to:
          $ref: '#/components/schemas/address'
        amount:
          type: string
        path:
          type: array
          items:
            type: object
            properties:
              asset_type:
                type: string
                enum:
                  - native
                  - credit_alphanum4
                  - credit_alphanum12
              asset_code:
                type: string
              asset_issuer:
                $ref: '#/components/schemas/address'
        source_amount:
          type: string
        destination_min:
          type: string
        source_asset_type:
          type: string
        source_asset_code:
          type: string
        source_asset_issuer:
          $ref: '#/components/schemas/address'
      required:
        - id
        - paging_token
        - transaction_successful
        - source_account
        - type
        - type_i
        - created_at
        - transaction_hash
        - from
        - to
        - amount
        - path
        - source_amount
        - destination_min
    PathPaymentStrictSend:
      type: object
      properties:
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/link'
            transaction:
              $ref: '#/components/schemas/link'
            effects:
              $ref: '#/components/schemas/link'
            succeeds:
              $ref: '#/components/schemas/link'
            precedes:
              $ref: '#/components/schemas/link'
          required:
            - self
            - transaction
            - effects
            - succeeds
            - precedes
        id:
          $ref: '#/components/schemas/id'
        paging_token:
          type: string
        transaction_successful:
          type: boolean
        source_account:
          $ref: '#/components/schemas/address'
        type:
          type: string
          example: path_payment_strict_send
        type_i:
          type: number
          example: 13
        created_at:
          type: string
        transaction_hash:
          type: string
        asset_type:
          type: string
          enum:
            - native
            - credit_alphanum4
            - credit_alphanum12
        asset_code:
          type: string
        asset_issuer:
          $ref: '#/components/schemas/address'
        from:
          $ref: '#/components/schemas/address'
        to:
          $ref: '#/components/schemas/address'
        amount:
          type: string
        path:
          type: array
          items:
            type: object
            properties:
              asset_type:
                type: string
                enum:
                  - native
                  - credit_alphanum4
                  - credit_alphanum12
              asset_code:
                type: string
              asset_issuer:
                $ref: '#/components/schemas/address'
        source_amount:
          type: string
        source_max:
          type: string
        source_asset_type:
          type: string
        source_asset_code:
          type: string
        source_asset_issuer:
          $ref: '#/components/schemas/address'
      required:
        - id
        - paging_token
        - transaction_successful
        - source_account
        - type
        - type_i
        - created_at
        - transaction_hash
        - from
        - to
        - amount
        - path
        - source_amount
        - source_asset_type
    AccountMerge:
      type: object
      properties:
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/link'
            transaction:
              $ref: '#/components/schemas/link'
            effects:
              $ref: '#/components/schemas/link'
            succeeds:
              $ref: '#/components/schemas/link'
            precedes:
              $ref: '#/components/schemas/link'
          required:
            - self
            - transaction
            - effects
            - succeeds
            - precedes
        id:
          $ref: '#/components/schemas/id'
        paging_token:
          type: string
        transaction_successful:
          type: boolean
        source_account:
          $ref: '#/components/schemas/address'
        type:
          type: string
          example: account_merge
        type_i:
          type: number
          example: 8
        created_at:
          type: string
        transaction_hash:
          type: string
        account:
          $ref: '#/components/schemas/address'
        into:
          $ref: '#/components/schemas/address'
      required:
        - id
        - paging_token
        - transaction_successful
        - source_account
        - type
        - type_i
        - created_at
        - transaction_hash
        - account
        - into
    InvokeHostFunction:
      type: object
      properties:
        _links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/link'
            transaction:
              $ref: '#/components/schemas/link'
            effects:
              $ref: '#/components/schemas/link'
            succeeds:
              $ref: '#/components/schemas/link'
            precedes:
              $ref: '#/components/schemas/link'
          required:
            - self
            - transaction
            - effects
            - succeeds
            - precedes
        id:
          $ref: '#/components/schemas/id'
        paging_token:
          type: string
        transaction_successful:
          type: boolean
        source_account:
          $ref: '#/components/schemas/address'
        type:
          type: string
          example: invoke_host_function
        type_i:
          type: number
          example: 0
        created_at:
          type: string
        transaction_hash:
          type: string
        function:
          type: string
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/host_function_parameter'
        address:
          type: string
        salt:
          type: string
        asset_balance_changes:
          type: array
          items:
            $ref: '#/components/schemas/asset_balance_change'
      required:
        - id
        - paging_token
        - transaction_successful
        - source_account
        - type
        - type_i
        - created_at
        - transaction_hash
        - function
    link:
      type: object
      properties:
        href:
          type: string
          format: link
        templated:
          type: boolean
      required:
        - href
    id:
      type: string
    address:
      type: string
      pattern: G[A-Z0-9]{55}
    host_function_parameter:
      type: object
      properties:
        value:
          type: string
        type:
          type: string
      required:
        - value
        - type
    asset_balance_change:
      type: object
      properties:
        asset_type:
          type: string
        asset_code:
          enum:
            - native
            - credit_alphanum4
            - credit_alphanum12
        asset_issuer:
          $ref: '#/components/schemas/address'
        type:
          type: string
          enum:
            - transfer
            - mint
            - clawback
            - burn
        from:
          type: string
        to:
          type: string
        amount:
          type: string
      required:
        - asset_type
        - type
        - amount
  examples:
    ListAllPayments:
      value:
        _links:
          self:
            href: >-
              https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//payments?cursor=&limit=3&order=asc
          next:
            href: >-
              https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//payments?cursor=33676838572033&limit=3&order=asc
          prev:
            href: >-
              https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//payments?cursor=12884905985&limit=3&order=desc
        _embedded:
          records:
            - _links:
                self:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//operations/12884905985
                transaction:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889
                effects:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//operations/12884905985/effects
                succeeds:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//effects?order=desc&cursor=12884905985
                precedes:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//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://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//operations/12884905986
                transaction:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889
                effects:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//operations/12884905986/effects
                succeeds:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//effects?order=desc&cursor=12884905986
                precedes:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//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://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//operations/33676838572033
                transaction:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a
                effects:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//operations/33676838572033/effects
                succeeds:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//effects?order=desc&cursor=33676838572033
                precedes:
                  href: >-
                    https://mainnet.stellar.validationcloud.io/v1/<YOUR_API_KEY_HERE>//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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.