Skip to main content

Retrieve an Account Payments REST API Endpoint

Retrieves payments associated with a specific account using its account ID.

Updated on
Oct 04, 2023
Please note that this method 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.

Path Parameters

account_id
string
REQUIRED

The account id to retrieve transaction records

Query Parameters

cursor
integer

The position of the data set to retrieve

order
string

The order in which transactions are retrieved. The possible values include ascending and descending order

limit
integer

The maximum number of transactions to retrieve in a single request

include_failed
boolean

A boolean value that determines whether to include failed transactions in the result or not

join
array

The set to transactions to include the transactions which created each of the operations in the response

Returns

_links
object

The links related to the account data

self
object

The self-reference link

href
string

The URL for self-reference

templated
boolean

The URL customization using placeholders and actual values

next
object

Link to the next set of data

href
string

The URL for next set of data

templated
boolean

The URL customization using placeholders and actual values

prev
object

Link to the previous set of data

href
string

The URL for previous set of data

templated
boolean

The URL customization using placeholders and actual values

_embedded
object

The embedded account records

records
array

An array of account records

_links
object

The links related to the account record

self
object

The self-reference link

href
string

The URL for self-reference

templated
boolean

A boolean value that indicates A boolean value that indicates whether the link is templated or not or not

transaction
object

Link to transactions related to the account

href
string

The URL for transactions related to the account

templated
boolean

A boolean value that indicates whether the link is templated or not

effects
object

Link to effects related to the account

href
string

The URL for effects related to the account

templated
boolean

A boolean value that indicates whether the link is templated or not

succeeds
object

Link to succeeds related to the account

href
string

The URL for succeeds related to the account

templated
boolean

A boolean value that indicates whether the link is templated or not

precedes
object

Link to precedes related to the account

href
string

The URL for precedes related to the account

templated
boolean

A boolean value that indicates whether the link is templated or not

id
string

The Account ID

paging_token
string

The paging token

transaction_successful
boolean

A boolean value that indicates whether the transaction was successful or not

source_account
string

The source account of the transaction

type
string

The type of payment

type_i
number | string

The type of payment as an integer

created_at
string

The timestamp when the payment was created

transaction_hash
string

The hash of the transaction associated with the payment

asset_type
string

The type of asset

asset_code
string

An asset code

asset_issuer
string

An asset issuer

from
string

The source account of the payment

to
string

The destination account of the payment

amount
string

The amount of the payment

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free