Skip to main content

Retrieve an Account's Payments

This endpoint represents successful payments for a given account and can be used in streaming mode. Streaming mode allows you to listen for new payments for this account 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.

Path Parameters
  • account_id string required

    This account’s public key encoded in a base32 string representation.

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 link required
  • templated boolean
  • next object
  • href link required
  • templated boolean
  • prev object
  • href link required
  • templated boolean
  • _embedded object
  • records object[]
  • Array [
  • _links object
  • self object required
  • href link required
  • templated boolean
  • transaction object required
  • href link required
  • templated boolean
  • effects object required
  • href link required
  • templated boolean
  • succeeds object required
  • href link required
  • templated boolean
  • precedes object required
  • href link required
  • templated boolean
  • id id required
  • paging_token string required
  • transaction_successful boolean required
  • source_account address required

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

  • type string required
  • type_i string required
  • created_at string required
  • transaction_hash string required
  • asset_type string required
  • asset_code

    Possible values: [native, credit_alphanum4, credit_alphanum12]

  • asset_issuer address

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

  • from address required

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

  • to address required

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

  • amount string required
  • ]
Loading...