Package io.moov.sdk

Class PaymentMethods

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      GetPaymentMethodRequestBuilder get()
      Get the specified payment method associated with a Moov account.
      GetPaymentMethodResponse get​(java.lang.String accountID, java.lang.String paymentMethodID)
      Get the specified payment method associated with a Moov account.
      GetPaymentMethodResponse get​(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String paymentMethodID)
      Get the specified payment method associated with a Moov account.
      ListPaymentMethodsRequestBuilder list()
      Retrieve a list of payment methods associated with a Moov account.
      ListPaymentMethodsResponse list​(java.lang.String accountID)
      Retrieve a list of payment methods associated with a Moov account.
      ListPaymentMethodsResponse list​(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.util.Optional<java.lang.String> sourceID, java.util.Optional<? extends PaymentMethodType> paymentMethodType)
      Retrieve a list of payment methods associated with a Moov account.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • list

        public ListPaymentMethodsRequestBuilder list()
        Retrieve a list of payment methods associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) 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}/payment-methods.read` scope.

        Returns:
        The call builder

      • list

        public ListPaymentMethodsResponse list​(java.lang.String accountID)
                                throws java.lang.Exception
        Retrieve a list of payment methods associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) 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}/payment-methods.read` scope.

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

      • list

        public ListPaymentMethodsResponse list​(java.util.Optional<java.lang.String> xMoovVersion,
                                       java.lang.String accountID,
                                       java.util.Optional<java.lang.String> sourceID,
                                       java.util.Optional<? extends PaymentMethodType> paymentMethodType)
                                throws java.lang.Exception
        Retrieve a list of payment methods associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) 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}/payment-methods.read` scope.

        Specified by:
        list in interface SDKMethodInterfaces.MethodCallListPaymentMethods
        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 -
        sourceID - Optional parameter to filter the account's payment methods by source ID. A source ID can be a [walletID](https://docs.moov.io/api/sources/wallets/list/), [cardID](https://docs.moov.io/api/sources/cards/list/), or [bankAccountID](https://docs.moov.io/api/sources/bank-accounts/list/).
        paymentMethodType - The payment method type that represents a payment rail and directionality
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • get

        public GetPaymentMethodRequestBuilder get()
        Get the specified payment method associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) 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}/payment-methods.read` scope.

        Returns:
        The call builder

      • get

        public GetPaymentMethodResponse get​(java.lang.String accountID,
                                    java.lang.String paymentMethodID)
                             throws java.lang.Exception
        Get the specified payment method associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) 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}/payment-methods.read` scope.

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

      • get

        public GetPaymentMethodResponse get​(java.util.Optional<java.lang.String> xMoovVersion,
                                    java.lang.String accountID,
                                    java.lang.String paymentMethodID)
                             throws java.lang.Exception
        Get the specified payment method associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) 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}/payment-methods.read` scope.

        Specified by:
        get in interface SDKMethodInterfaces.MethodCallGetPaymentMethod
        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 -
        paymentMethodID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails