Package com.adyen.service.transfers

Class TransactionsApi

  • public class TransactionsApi
extends Service

    • Constructor Detail

      • TransactionsApi

        public TransactionsApi​(Client client)
        Transactions constructor in package.
        Parameters:
        client - Client (required)

      • TransactionsApi

        public TransactionsApi​(Client client,
                       String baseURL)
        Transactions constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
        Parameters:
        client - Client (required)
        baseURL - String (required)

    • Method Detail

      • 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: The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id). Required if you don't provide a `balanceAccountId` or `accountHolderId`. (optional)
        paymentInstrumentId - String Query: The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_). To use this parameter, you must also provide a `balanceAccountId`, `accountHolderId`, or `balancePlatform`. The `paymentInstrumentId` must be related to the `balanceAccountId` or `accountHolderId` that you provide. (optional)
        accountHolderId - String Query: The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id). Required if you don't provide a `balanceAccountId` or `balancePlatform`. If you provide a `balanceAccountId`, the `accountHolderId` must be related to the `balanceAccountId`. (optional)
        balanceAccountId - String Query: The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). Required if you don't provide an `accountHolderId` or `balancePlatform`. If you provide an `accountHolderId`, the `balanceAccountId` must be related to the `accountHolderId`. (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