Package org.stellar.sdk.requests

Class PaymentsRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.PaymentsRequestBuilder

public class PaymentsRequestBuilder
extends RequestBuilder

Builds requests to the Horizon /payments endpoint.

Retrieves payment-type operations (payments, path payments, account merges), with optional filters by account, ledger, or transaction.

See Also:

• Horizon API reference

Nested Class Summary

Nested classes/interfaces inherited from class org.stellar.sdk.requests.RequestBuilder

RequestBuilder.Order

Constructor Summary

Constructors

Constructor	Description
PaymentsRequestBuilder(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl serverURI)

Method Summary

Modifier and Type	Method	Description
PaymentsRequestBuilder	cursor(String token)	Sets cursor parameter on the request.
Page<OperationResponse>	execute()	Build and execute request.
static Page<OperationResponse>	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri)	Requests specific uri and returns Page of OperationResponse.
PaymentsRequestBuilder	forAccount(@NonNull String account)	Builds request to GET /accounts/{account}/payments
PaymentsRequestBuilder	forLedger(long ledgerSeq)	Builds request to GET /ledgers/{ledgerSeq}/payments
PaymentsRequestBuilder	forTransaction(@NonNull String transactionId)	Builds request to GET /transactions/{transactionId}/payments
PaymentsRequestBuilder	includeTransactions(boolean include)	Adds a parameter defining whether to include transactions in the response.
PaymentsRequestBuilder	limit(int number)	Sets limit parameter on the request.
PaymentsRequestBuilder	order(RequestBuilder.Order direction)	Sets order parameter on the request.
SSEStream<OperationResponse>	stream(EventListener<OperationResponse> listener)	An overloaded version of stream(EventListener, long) with default reconnect timeout.
SSEStream<OperationResponse>	stream(EventListener<OperationResponse> listener, long reconnectTimeout)	Allows to stream SSE events from horizon.

Methods inherited from class org.stellar.sdk.requests.RequestBuilder

setAssetParameter, setAssetsParameter

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PaymentsRequestBuilder

public PaymentsRequestBuilder(okhttp3.OkHttpClient httpClient,
 okhttp3.HttpUrl serverURI)

Method Details

forAccount

public PaymentsRequestBuilder forAccount(@NonNull
 @NonNull String account)

Builds request to GET /accounts/{account}/payments

Parameters:

account - Account for which to get payments

Returns:

this builder instance for chaining

See Also:

• Payments for Account

forLedger

public PaymentsRequestBuilder forLedger(long ledgerSeq)

Builds request to GET /ledgers/{ledgerSeq}/payments

Parameters:

ledgerSeq - Ledger for which to get payments

Returns:

this builder instance for chaining

See Also:

• Payments for Ledger

forTransaction

public PaymentsRequestBuilder forTransaction(@NonNull
 @NonNull String transactionId)

Builds request to GET /transactions/{transactionId}/payments

Parameters:

transactionId - Transaction ID for which to get payments

Returns:

this builder instance for chaining

See Also:

• Payments for Transaction

includeTransactions

public PaymentsRequestBuilder includeTransactions(boolean include)

Adds a parameter defining whether to include transactions in the response. By default transaction data is not included.

Parameters:

include - Set to true to include transaction data in the operations response.

Returns:

this builder instance for chaining

execute

public static Page<OperationResponse> execute(okhttp3.OkHttpClient httpClient,
 okhttp3.HttpUrl uri)

Requests specific uri and returns Page of OperationResponse. This method is helpful for getting the next set of results.

Parameters:

httpClient - OkHttpClient to use to send the request.

uri - HttpUrl URI to send the request to.

Returns:

Page of OperationResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkException

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

stream

public SSEStream<OperationResponse> stream(EventListener<OperationResponse> listener,
 long reconnectTimeout)

Allows to stream SSE events from horizon. Certain endpoints in Horizon can be called in streaming mode using Server-Sent Events. This mode will keep the connection to horizon open and horizon will continue to return responses as ledgers close.

Parameters:

listener - EventListener implementation with OperationResponse type

reconnectTimeout - Custom stream connection timeout in ms

Returns:

EventSource object, so you can close() connection when not needed anymore

See Also:

• Server-Sent Events
• Response Format documentation

stream

public SSEStream<OperationResponse> stream(EventListener<OperationResponse> listener)

An overloaded version of stream(EventListener, long) with default reconnect timeout.

Parameters:

listener - the event listener to receive events

Returns:

an SSEStream for real-time event streaming

execute

public Page<OperationResponse> execute()

Build and execute request.

Returns:

Page of OperationResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkException

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

cursor

public PaymentsRequestBuilder cursor(String token)

Description copied from class: RequestBuilder

Sets cursor parameter on the request. A cursor is a value that points to a specific location in a collection of resources. The cursor attribute itself is an opaque value meaning that users should not try to parse it.

Overrides:

cursor in class RequestBuilder

Parameters:

token - A cursor is a value that points to a specific location in a collection of resources.

Returns:

this builder instance for chaining

See Also:

• Page documentation

limit

public PaymentsRequestBuilder limit(int number)

Description copied from class: RequestBuilder

Sets limit parameter on the request. It defines maximum number of records to return. For range and default values check documentation of the endpoint requested.

Overrides:

limit in class RequestBuilder

Parameters:

number - maximum number of records to return

Returns:

this builder instance for chaining

order

public PaymentsRequestBuilder order(RequestBuilder.Order direction)

Description copied from class: RequestBuilder

Sets order parameter on the request.

Overrides:

order in class RequestBuilder

Parameters:

direction - RequestBuilder.Order

Returns:

this builder instance for chaining