Package io.moov.sdk

Class Transfers

    • Method Detail

      • create

        public CreateTransferRequestBuilder create()
        Move money by providing the source, destination, and amount in the request body.

        Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

        Returns:
        The call builder

      • create

        public CreateTransferResponse create​(CreateTransferRequest request)
                              throws java.lang.Exception
        Move money by providing the source, destination, and amount in the request body.

        Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

        Specified by:
        create in interface SDKMethodInterfaces.MethodCallCreateTransfer
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • list

        public ListTransfersRequestBuilder list()
        List all the transfers associated with a particular Moov account.

        Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        When you run this request, you retrieve 200 transfers at a time. You can advance past a results set of 200 transfers by using the `skip` parameter (for example, if you set `skip`= 10, you will see a results set of 200 transfers after the first 10). If you are searching a high volume of transfers, the request will likely process very slowly. To achieve faster performance, restrict the data as much as you can by using the `StartDateTime` and `EndDateTime` parameters for a limited period of time. You can run multiple requests in smaller time window increments until you've retrieved all the transfers you need.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Returns:
        The call builder

      • list

        public ListTransfersResponse list​(ListTransfersRequest request)
                           throws java.lang.Exception
        List all the transfers associated with a particular Moov account.

        Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        When you run this request, you retrieve 200 transfers at a time. You can advance past a results set of 200 transfers by using the `skip` parameter (for example, if you set `skip`= 10, you will see a results set of 200 transfers after the first 10). If you are searching a high volume of transfers, the request will likely process very slowly. To achieve faster performance, restrict the data as much as you can by using the `StartDateTime` and `EndDateTime` parameters for a limited period of time. You can run multiple requests in smaller time window increments until you've retrieved all the transfers you need.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Specified by:
        list in interface SDKMethodInterfaces.MethodCallListTransfers
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • get

        public GetTransferRequestBuilder get()
        Retrieve full transfer details for an individual transfer of a particular Moov account.

        Payment rail-specific details are included in the source and destination. Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Returns:
        The call builder

      • get

        public GetTransferResponse get​(java.lang.String transferID,
                               java.lang.String accountID)
                        throws java.lang.Exception
        Retrieve full transfer details for an individual transfer of a particular Moov account.

        Payment rail-specific details are included in the source and destination. Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Parameters:
        transferID - Identifier for the transfer.
        accountID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • get

        public GetTransferResponse get​(java.util.Optional<java.lang.String> xMoovVersion,
                               java.lang.String transferID,
                               java.lang.String accountID)
                        throws java.lang.Exception
        Retrieve full transfer details for an individual transfer of a particular Moov account.

        Payment rail-specific details are included in the source and destination. Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Specified by:
        get in interface SDKMethodInterfaces.MethodCallGetTransfer
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        transferID - Identifier for the transfer.
        accountID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • update

        public UpdateTransferRequestBuilder update()
        Update the metadata contained on a transfer.

        Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

        Returns:
        The call builder

      • update

        public UpdateTransferResponse update​(java.lang.String transferID,
                                     java.lang.String accountID,
                                     PatchTransfer patchTransfer)
                              throws java.lang.Exception
        Update the metadata contained on a transfer.

        Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

        Parameters:
        transferID - Identifier for the transfer.
        accountID -
        patchTransfer -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • update

        public UpdateTransferResponse update​(java.util.Optional<java.lang.String> xMoovVersion,
                                     java.lang.String transferID,
                                     java.lang.String accountID,
                                     PatchTransfer patchTransfer)
                              throws java.lang.Exception
        Update the metadata contained on a transfer.

        Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

        Specified by:
        update in interface SDKMethodInterfaces.MethodCallUpdateTransfer
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        transferID - Identifier for the transfer.
        accountID -
        patchTransfer -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • createCancellation

        public CreateCancellationRequestBuilder createCancellation()
        Initiate a cancellation for a card, ACH, or queued transfer.

        To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

        Returns:
        The call builder

      • createCancellation

        public CreateCancellationResponse createCancellation​(java.lang.String accountID,
                                                     java.lang.String transferID)
                                              throws java.lang.Exception
        Initiate a cancellation for a card, ACH, or queued transfer.

        To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

        Parameters:
        accountID - The partner's Moov account ID.
        transferID - The transfer ID to cancel.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • createCancellation

        public CreateCancellationResponse createCancellation​(java.util.Optional<java.lang.String> xMoovVersion,
                                                     java.lang.String accountID,
                                                     java.lang.String transferID)
                                              throws java.lang.Exception
        Initiate a cancellation for a card, ACH, or queued transfer.

        To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

        Specified by:
        createCancellation in interface SDKMethodInterfaces.MethodCallCreateCancellation
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        accountID - The partner's Moov account ID.
        transferID - The transfer ID to cancel.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • getCancellation

        public GetCancellationRequestBuilder getCancellation()
        Get details of a cancellation for a transfer.

        To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Returns:
        The call builder

      • getCancellation

        public GetCancellationResponse getCancellation​(java.lang.String accountID,
                                               java.lang.String transferID,
                                               java.lang.String cancellationID)
                                        throws java.lang.Exception
        Get details of a cancellation for a transfer.

        To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Parameters:
        accountID - Moov account ID of the partner or transfer's source or destination.
        transferID - Identifier for the transfer.
        cancellationID - Identifier for the cancellation.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • getCancellation

        public GetCancellationResponse getCancellation​(java.util.Optional<java.lang.String> xMoovVersion,
                                               java.lang.String accountID,
                                               java.lang.String transferID,
                                               java.lang.String cancellationID)
                                        throws java.lang.Exception
        Get details of a cancellation for a transfer.

        To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Specified by:
        getCancellation in interface SDKMethodInterfaces.MethodCallGetCancellation
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        accountID - Moov account ID of the partner or transfer's source or destination.
        transferID - Identifier for the transfer.
        cancellationID - Identifier for the cancellation.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • initiateRefund

        public InitiateRefundRequestBuilder initiateRefund()
        Initiate a refund for a card transfer.

        **Use the [Cancel or refund a card transfer](https://docs.moov.io/api/money-movement/refunds/cancel/) endpoint for more comprehensive cancel and refund options.** See the [reversals](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/reversals/) guide for more information.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

        Returns:
        The call builder

      • initiateRefund

        public InitiateRefundResponse initiateRefund​(InitiateRefundRequest request)
                                      throws java.lang.Exception
        Initiate a refund for a card transfer.

        **Use the [Cancel or refund a card transfer](https://docs.moov.io/api/money-movement/refunds/cancel/) endpoint for more comprehensive cancel and refund options.** See the [reversals](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/reversals/) guide for more information.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

        Specified by:
        initiateRefund in interface SDKMethodInterfaces.MethodCallInitiateRefund
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • listRefunds

        public ListRefundsRequestBuilder listRefunds()
        Get a list of refunds for a card transfer.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Returns:
        The call builder

      • listRefunds

        public ListRefundsResponse listRefunds​(java.lang.String accountID,
                                       java.lang.String transferID)
                                throws java.lang.Exception
        Get a list of refunds for a card transfer.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Parameters:
        accountID -
        transferID - Identifier for the transfer.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • listRefunds

        public ListRefundsResponse listRefunds​(java.util.Optional<java.lang.String> xMoovVersion,
                                       java.lang.String accountID,
                                       java.lang.String transferID)
                                throws java.lang.Exception
        Get a list of refunds for a card transfer.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Specified by:
        listRefunds in interface SDKMethodInterfaces.MethodCallListRefunds
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        accountID -
        transferID - Identifier for the transfer.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • getRefund

        public GetRefundRequestBuilder getRefund()
        Get details of a refund for a card transfer.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Returns:
        The call builder

      • getRefund

        public GetRefundResponse getRefund​(java.lang.String transferID,
                                   java.lang.String accountID,
                                   java.lang.String refundID)
                            throws java.lang.Exception
        Get details of a refund for a card transfer.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Parameters:
        transferID - Identifier for the transfer.
        accountID -
        refundID - Identifier for the refund.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • getRefund

        public GetRefundResponse getRefund​(java.util.Optional<java.lang.String> xMoovVersion,
                                   java.lang.String transferID,
                                   java.lang.String accountID,
                                   java.lang.String refundID)
                            throws java.lang.Exception
        Get details of a refund for a card transfer.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Specified by:
        getRefund in interface SDKMethodInterfaces.MethodCallGetRefund
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        transferID - Identifier for the transfer.
        accountID -
        refundID - Identifier for the refund.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • createReversal

        public CreateReversalRequestBuilder createReversal()
        Reverses a card transfer by initiating a cancellation or refund depending on the transaction status. Read our [reversals guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/reversals/) to learn more.

        To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

        Returns:
        The call builder

      • createReversal

        public CreateReversalResponse createReversal​(CreateReversalRequest request)
                                      throws java.lang.Exception
        Reverses a card transfer by initiating a cancellation or refund depending on the transaction status. Read our [reversals guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/reversals/) to learn more.

        To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

        Specified by:
        createReversal in interface SDKMethodInterfaces.MethodCallCreateReversal
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • generateOptions

        public CreateTransferOptionsRequestBuilder generateOptions()
        Generate available payment method options for one or multiple transfer participants depending on the accountID or paymentMethodID you supply in the request.

        Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Returns:
        The call builder

      • generateOptions

        public CreateTransferOptionsResponse generateOptions​(CreateTransferOptions createTransferOptions)
                                              throws java.lang.Exception
        Generate available payment method options for one or multiple transfer participants depending on the accountID or paymentMethodID you supply in the request.

        Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Parameters:
        createTransferOptions -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • generateOptions

        public CreateTransferOptionsResponse generateOptions​(java.util.Optional<java.lang.String> xMoovVersion,
                                                     CreateTransferOptions createTransferOptions)
                                              throws java.lang.Exception
        Generate available payment method options for one or multiple transfer participants depending on the accountID or paymentMethodID you supply in the request.

        Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

        Specified by:
        generateOptions in interface SDKMethodInterfaces.MethodCallCreateTransferOptions
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        createTransferOptions -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails