Package com.adyen.service.transfers

Class TransfersApi

  • public class TransfersApi
extends Service

    • Constructor Detail

      • TransfersApi

        public TransfersApi​(Client client)
        Transfers constructor in package.
        Parameters:
        client - Client (required)

      • TransfersApi

        public TransfersApi​(Client client,
                    String baseURL)
        Transfers 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

      • getAllTransfers

        public FindTransfersResponse getAllTransfers​(OffsetDateTime createdSince,
                                             OffsetDateTime createdUntil)
                                      throws ApiException,
                                             IOException
        Get all transfers
        Parameters:
        createdSince - OffsetDateTime Only include transfers that have been created on or after this point in time. The value must be in ISO 8601 format and not earlier than 6 months before the `createdUntil` date. For example, **2021-05-30T15:07:40Z**. (required)
        createdUntil - OffsetDateTime Only include transfers that have been created on or before this point in time. The value must be in ISO 8601 format and not later than 6 months after the `createdSince` date. For example, **2021-05-30T15:07:40Z**. (required)
        Returns:
        FindTransfersResponse
        Throws:
        ApiException - if fails to make API call
        IOException

      • getAllTransfers

        public FindTransfersResponse getAllTransfers​(String balancePlatform,
                                             String accountHolderId,
                                             String balanceAccountId,
                                             String paymentInstrumentId,
                                             String reference,
                                             String category,
                                             OffsetDateTime createdSince,
                                             OffsetDateTime createdUntil,
                                             String cursor,
                                             Integer limit,
                                             RequestOptions requestOptions)
                                      throws ApiException,
                                             IOException
        Get all transfers
        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)
        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)
        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)
        reference - String Query: The reference you provided in the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) request (optional)
        category - String Query: The type of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account. - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. - **issuedCard**: Transfer initiated by a Adyen-issued card. - **platformPayment**: Fund movements related to payments that are acquired for your users. (optional)
        createdSince - OffsetDateTime Query: Only include transfers that have been created on or after this point in time. The value must be in ISO 8601 format and not earlier than 6 months before the `createdUntil` date. For example, **2021-05-30T15:07:40Z**. (required)
        createdUntil - OffsetDateTime Query: Only include transfers that have been created on or before this point in time. The value must be in ISO 8601 format and not later than 6 months after the `createdSince` date. For example, **2021-05-30T15:07:40Z**. (required)
        cursor - String Query: The `cursor` returned in the links of the previous response. (optional)
        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:
        FindTransfersResponse
        Throws:
        ApiException - if fails to make API call
        IOException