Skip to main content

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​

Success

Schema
    _links object
    self object
    href linkrequired
    templated boolean
    next object
    href linkrequired
    templated boolean
    prev object
    href linkrequired
    templated boolean
Loading...
Last updated on by Elliot Voris