Package com.adyen.service.transfers

Class TransactionsApi

java.lang.Object

com.adyen.Service

com.adyen.service.transfers.TransactionsApi

public class TransactionsApi
extends Service

Field Summary

Fields inherited from class com.adyen.Service

GSON

Constructor Summary

Constructors

Constructor	Description
TransactionsApi(Client client)

Method Summary

Modifier and Type	Method	Description
TransactionSearchResponse	getAllTransactions(String balancePlatform, String paymentInstrumentId, String accountHolderId, String balanceAccountId, String cursor, OffsetDateTime createdSince, OffsetDateTime createdUntil, Integer limit, RequestOptions requestOptions)	Get all transactions
TransactionSearchResponse	getAllTransactions(OffsetDateTime createdSince, OffsetDateTime createdUntil)	Get all transactions
Transaction	getTransaction(String id)	Get a transaction
Transaction	getTransaction(String id, RequestOptions requestOptions)	Get a transaction

Methods inherited from class com.adyen.Service

createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionsApi

public TransactionsApi(Client client)

Method Detail

getAllTransactions

public TransactionSearchResponse getAllTransactions(OffsetDateTime createdSince,
                                                    OffsetDateTime createdUntil)
                                             throws ApiException,
                                                    IOException

Get all transactions

Parameters:

createdSince - OffsetDateTime Only include transactions that have been created on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. (required)

createdUntil - OffsetDateTime Only include transactions that have been created on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. (required)

Returns:

TransactionSearchResponse

Throws:

ApiException - if fails to make API call

IOException

getAllTransactions

public TransactionSearchResponse getAllTransactions(String balancePlatform,
                                                    String paymentInstrumentId,
                                                    String accountHolderId,
                                                    String balanceAccountId,
                                                    String cursor,
                                                    OffsetDateTime createdSince,
                                                    OffsetDateTime createdUntil,
                                                    Integer limit,
                                                    RequestOptions requestOptions)
                                             throws ApiException,
                                                    IOException

Get all transactions

Parameters:

balancePlatform - String Query: Unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id). (optional)

paymentInstrumentId - String Query: Unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_). (optional)

accountHolderId - String Query: Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id). (optional)

balanceAccountId - String Query: Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). (optional)

cursor - String Query: The `cursor` returned in the links of the previous response. (optional)

createdSince - OffsetDateTime Query: Only include transactions that have been created on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. (required)

createdUntil - OffsetDateTime Query: Only include transactions that have been created on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. (required)

limit - Integer Query: The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page. (optional)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

TransactionSearchResponse

Throws:

ApiException - if fails to make API call

IOException

getTransaction

public Transaction getTransaction(String id)
                           throws ApiException,
                                  IOException

Get a transaction

Parameters:

id - String Unique identifier of the transaction. (required)

Returns:

Transaction

Throws:

ApiException - if fails to make API call

IOException

getTransaction

public Transaction getTransaction(String id,
                                  RequestOptions requestOptions)
                           throws ApiException,
                                  IOException

Get a transaction

Parameters:

id - String Unique identifier of the transaction. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

Transaction

Throws:

ApiException - if fails to make API call

IOException