Package io.moov.sdk

Class Cards

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      DisableCardRequestBuilder disable()
      Disables a card associated with a Moov account.
      DisableCardResponse disable​(java.lang.String accountID, java.lang.String cardID)
      Disables a card associated with a Moov account.
      DisableCardResponse disable​(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String cardID)
      Disables a card associated with a Moov account.
      GetCardRequestBuilder get()
      Fetch a specific card associated with a Moov account.
      GetCardResponse get​(java.lang.String accountID, java.lang.String cardID)
      Fetch a specific card associated with a Moov account.
      GetCardResponse get​(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String cardID)
      Fetch a specific card associated with a Moov account.
      LinkCardRequestBuilder link()
      Link a card to an existing Moov account.
      LinkCardResponse link​(java.lang.String accountID, LinkCard linkCard)
      Link a card to an existing Moov account.
      LinkCardResponse link​(java.util.Optional<java.lang.String> xMoovVersion, java.util.Optional<? extends LinkCardWaitFor> xWaitFor, java.lang.String accountID, LinkCard linkCard)
      Link a card to an existing Moov account.
      ListCardsRequestBuilder list()
      List all the active cards associated with a Moov account.
      ListCardsResponse list​(java.lang.String accountID)
      List all the active cards associated with a Moov account.
      ListCardsResponse list​(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID)
      List all the active cards associated with a Moov account.
      UpdateCardRequestBuilder update()
      Update a linked card and/or resubmit it for verification.
      UpdateCardResponse update​(java.lang.String accountID, java.lang.String cardID, UpdateCard updateCard)
      Update a linked card and/or resubmit it for verification.
      UpdateCardResponse update​(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String cardID, UpdateCard updateCard)
      Update a linked card and/or resubmit it for verification.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • link

        public LinkCardRequestBuilder link()
        Link a card to an existing Moov account.

        Read our [accept card payments guide](https://docs.moov.io/guides/sources/cards/accept-card-payments/#link-a-card) to learn more.

        Only use this endpoint if you have provided Moov with a copy of your PCI attestation of compliance.

        During card linking, the provided data will be verified by submitting a $0 authorization (account verification) request. If `merchantAccountID` is provided, the authorization request will contain that account's statement descriptor and address. Otherwise, the platform account's profile will be used. If no statement descriptor has been set, the authorization will use the account's name instead.

        It is strongly recommended that callers include the `X-Wait-For` header, set to `payment-method`, if the newly linked card is intended to be used right away. If this header is not included, the caller will need to poll the [List Payment Methods](https://docs.moov.io/api/sources/payment-methods/list/) endpoint to wait for the new payment methods to be available for use.

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

        Returns:
        The call builder

      • link

        public LinkCardResponse link​(java.lang.String accountID,
                             LinkCard linkCard)
                      throws java.lang.Exception
        Link a card to an existing Moov account.

        Read our [accept card payments guide](https://docs.moov.io/guides/sources/cards/accept-card-payments/#link-a-card) to learn more.

        Only use this endpoint if you have provided Moov with a copy of your PCI attestation of compliance.

        During card linking, the provided data will be verified by submitting a $0 authorization (account verification) request. If `merchantAccountID` is provided, the authorization request will contain that account's statement descriptor and address. Otherwise, the platform account's profile will be used. If no statement descriptor has been set, the authorization will use the account's name instead.

        It is strongly recommended that callers include the `X-Wait-For` header, set to `payment-method`, if the newly linked card is intended to be used right away. If this header is not included, the caller will need to poll the [List Payment Methods](https://docs.moov.io/api/sources/payment-methods/list/) endpoint to wait for the new payment methods to be available for use.

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

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

      • link

        public LinkCardResponse link​(java.util.Optional<java.lang.String> xMoovVersion,
                             java.util.Optional<? extends LinkCardWaitFor> xWaitFor,
                             java.lang.String accountID,
                             LinkCard linkCard)
                      throws java.lang.Exception
        Link a card to an existing Moov account.

        Read our [accept card payments guide](https://docs.moov.io/guides/sources/cards/accept-card-payments/#link-a-card) to learn more.

        Only use this endpoint if you have provided Moov with a copy of your PCI attestation of compliance.

        During card linking, the provided data will be verified by submitting a $0 authorization (account verification) request. If `merchantAccountID` is provided, the authorization request will contain that account's statement descriptor and address. Otherwise, the platform account's profile will be used. If no statement descriptor has been set, the authorization will use the account's name instead.

        It is strongly recommended that callers include the `X-Wait-For` header, set to `payment-method`, if the newly linked card is intended to be used right away. If this header is not included, the caller will need to poll the [List Payment Methods](https://docs.moov.io/api/sources/payment-methods/list/) endpoint to wait for the new payment methods to be available for use.

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

        Specified by:
        link in interface SDKMethodInterfaces.MethodCallLinkCard
        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.
        xWaitFor -
        accountID -
        linkCard -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • list

        public ListCardsRequestBuilder list()
        List all the active cards associated with a Moov account.

        Read our [accept card payments guide](https://docs.moov.io/guides/sources/cards/accept-card-payments/) 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}/cards.read` scope.

        Returns:
        The call builder

      • list

        public ListCardsResponse list​(java.lang.String accountID)
                       throws java.lang.Exception
        List all the active cards associated with a Moov account.

        Read our [accept card payments guide](https://docs.moov.io/guides/sources/cards/accept-card-payments/) 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}/cards.read` scope.

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

      • list

        public ListCardsResponse list​(java.util.Optional<java.lang.String> xMoovVersion,
                              java.lang.String accountID)
                       throws java.lang.Exception
        List all the active cards associated with a Moov account.

        Read our [accept card payments guide](https://docs.moov.io/guides/sources/cards/accept-card-payments/) 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}/cards.read` scope.

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

      • get

        public GetCardRequestBuilder get()
        Fetch a specific card associated with a Moov account.

        Read our [accept card payments guide](https://docs.moov.io/guides/sources/cards/accept-card-payments/) 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}/cards.read` scope.

        Returns:
        The call builder

      • get

        public GetCardResponse get​(java.lang.String accountID,
                           java.lang.String cardID)
                    throws java.lang.Exception
        Fetch a specific card associated with a Moov account.

        Read our [accept card payments guide](https://docs.moov.io/guides/sources/cards/accept-card-payments/) 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}/cards.read` scope.

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

      • get

        public GetCardResponse get​(java.util.Optional<java.lang.String> xMoovVersion,
                           java.lang.String accountID,
                           java.lang.String cardID)
                    throws java.lang.Exception
        Fetch a specific card associated with a Moov account.

        Read our [accept card payments guide](https://docs.moov.io/guides/sources/cards/accept-card-payments/) 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}/cards.read` scope.

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

      • update

        public UpdateCardRequestBuilder update()
        Update a linked card and/or resubmit it for verification.

        If a value is provided for CVV, a new verification ($0 authorization) will be submitted for the card. Updating the expiration date or address will update the information stored on file for the card but will not be verified.

        Read our [accept card payments guide](https://docs.moov.io/guides/sources/cards/accept-card-payments/#reverify-a-card) to learn more.

        Only use this endpoint if you have provided Moov with a copy of your PCI attestation of compliance.

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

        Returns:
        The call builder

      • update

        public UpdateCardResponse update​(java.lang.String accountID,
                                 java.lang.String cardID,
                                 UpdateCard updateCard)
                          throws java.lang.Exception
        Update a linked card and/or resubmit it for verification.

        If a value is provided for CVV, a new verification ($0 authorization) will be submitted for the card. Updating the expiration date or address will update the information stored on file for the card but will not be verified.

        Read our [accept card payments guide](https://docs.moov.io/guides/sources/cards/accept-card-payments/#reverify-a-card) to learn more.

        Only use this endpoint if you have provided Moov with a copy of your PCI attestation of compliance.

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

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

      • update

        public UpdateCardResponse update​(java.util.Optional<java.lang.String> xMoovVersion,
                                 java.lang.String accountID,
                                 java.lang.String cardID,
                                 UpdateCard updateCard)
                          throws java.lang.Exception
        Update a linked card and/or resubmit it for verification.

        If a value is provided for CVV, a new verification ($0 authorization) will be submitted for the card. Updating the expiration date or address will update the information stored on file for the card but will not be verified.

        Read our [accept card payments guide](https://docs.moov.io/guides/sources/cards/accept-card-payments/#reverify-a-card) to learn more.

        Only use this endpoint if you have provided Moov with a copy of your PCI attestation of compliance.

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

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

      • disable

        public DisableCardRequestBuilder disable()
        Disables a card associated with a Moov account.

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

        Returns:
        The call builder

      • disable

        public DisableCardResponse disable​(java.lang.String accountID,
                                   java.lang.String cardID)
                            throws java.lang.Exception
        Disables a card associated with a Moov account.

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

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

      • disable

        public DisableCardResponse disable​(java.util.Optional<java.lang.String> xMoovVersion,
                                   java.lang.String accountID,
                                   java.lang.String cardID)
                            throws java.lang.Exception
        Disables a card associated with a Moov account.

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

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