Package io.moov.sdk

Class Disputes

    • Method Detail

      • list

        public ListDisputesRequestBuilder list()
        Returns the list of disputes.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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
      • list

        public ListDisputesResponse list​(ListDisputesRequest request)
                                  throws java.lang.Exception
        Returns the list of disputes.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        list in interface SDKMethodInterfaces.MethodCallListDisputes
        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 GetDisputeRequestBuilder get()
        Get a dispute by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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 GetDisputeResponse get​(java.lang.String accountID,
                                      java.lang.String disputeID)
                               throws java.lang.Exception
        Get a dispute by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        accountID -
        disputeID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • get

        public GetDisputeResponse get​(java.util.Optional<java.lang.String> xMoovVersion,
                                      java.lang.String accountID,
                                      java.lang.String disputeID)
                               throws java.lang.Exception
        Get a dispute by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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.MethodCallGetDispute
        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 -
        disputeID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • accept

        public AcceptDisputeRequestBuilder accept()
        Accepts liability for a dispute.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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
      • accept

        public AcceptDisputeResponse accept​(java.lang.String accountID,
                                            java.lang.String disputeID)
                                     throws java.lang.Exception
        Accepts liability for a dispute.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        accountID -
        disputeID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • accept

        public AcceptDisputeResponse accept​(java.util.Optional<java.lang.String> xMoovVersion,
                                            java.lang.String accountID,
                                            java.lang.String disputeID)
                                     throws java.lang.Exception
        Accepts liability for a dispute.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        accept in interface SDKMethodInterfaces.MethodCallAcceptDispute
        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 -
        disputeID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listEvidence

        public ListDisputeEvidenceRequestBuilder listEvidence()
        Returns a dispute's public evidence by its ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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
      • listEvidence

        public ListDisputeEvidenceResponse listEvidence​(java.lang.String accountID,
                                                        java.lang.String disputeID)
                                                 throws java.lang.Exception
        Returns a dispute's public evidence by its ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        accountID -
        disputeID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listEvidence

        public ListDisputeEvidenceResponse listEvidence​(java.util.Optional<java.lang.String> xMoovVersion,
                                                        java.lang.String accountID,
                                                        java.lang.String disputeID)
                                                 throws java.lang.Exception
        Returns a dispute's public evidence by its ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        listEvidence in interface SDKMethodInterfaces.MethodCallListDisputeEvidence
        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 -
        disputeID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • uploadEvidenceFile

        public UploadDisputeEvidenceFileRequestBuilder uploadEvidenceFile()
        Uploads a file as evidence for a dispute.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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
      • uploadEvidenceFile

        public UploadDisputeEvidenceFileResponse uploadEvidenceFile​(java.lang.String accountID,
                                                                    java.lang.String disputeID,
                                                                    CreateEvidenceFileMultiPart createEvidenceFileMultiPart)
                                                             throws java.lang.Exception
        Uploads a file as evidence for a dispute.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        accountID -
        disputeID -
        createEvidenceFileMultiPart -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • uploadEvidenceFile

        public UploadDisputeEvidenceFileResponse uploadEvidenceFile​(java.util.Optional<java.lang.String> xMoovVersion,
                                                                    java.lang.String accountID,
                                                                    java.lang.String disputeID,
                                                                    CreateEvidenceFileMultiPart createEvidenceFileMultiPart)
                                                             throws java.lang.Exception
        Uploads a file as evidence for a dispute.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        uploadEvidenceFile in interface SDKMethodInterfaces.MethodCallUploadDisputeEvidenceFile
        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 -
        disputeID -
        createEvidenceFileMultiPart -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • uploadEvidenceText

        public UploadDisputeEvidenceTextRequestBuilder uploadEvidenceText()
        Uploads text as evidence for a dispute.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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
      • uploadEvidenceText

        public UploadDisputeEvidenceTextResponse uploadEvidenceText​(java.lang.String accountID,
                                                                    java.lang.String disputeID,
                                                                    CreateEvidenceText createEvidenceText)
                                                             throws java.lang.Exception
        Uploads text as evidence for a dispute.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        accountID -
        disputeID -
        createEvidenceText -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • uploadEvidenceText

        public UploadDisputeEvidenceTextResponse uploadEvidenceText​(java.util.Optional<java.lang.String> xMoovVersion,
                                                                    java.lang.String accountID,
                                                                    java.lang.String disputeID,
                                                                    CreateEvidenceText createEvidenceText)
                                                             throws java.lang.Exception
        Uploads text as evidence for a dispute.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        uploadEvidenceText in interface SDKMethodInterfaces.MethodCallUploadDisputeEvidenceText
        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 -
        disputeID -
        createEvidenceText -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • submitEvidence

        public SubmitDisputeEvidenceRequestBuilder submitEvidence()
        Submit the evidence associated with a dispute.

        Evidence items must be uploaded using the appropriate endpoint(s) prior to calling this endpoint to submit it. **Evidence can only be submitted once per dispute.**

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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
      • submitEvidence

        public SubmitDisputeEvidenceResponse submitEvidence​(java.lang.String accountID,
                                                            java.lang.String disputeID)
                                                     throws java.lang.Exception
        Submit the evidence associated with a dispute.

        Evidence items must be uploaded using the appropriate endpoint(s) prior to calling this endpoint to submit it. **Evidence can only be submitted once per dispute.**

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        accountID -
        disputeID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • submitEvidence

        public SubmitDisputeEvidenceResponse submitEvidence​(java.util.Optional<java.lang.String> xMoovVersion,
                                                            java.lang.String accountID,
                                                            java.lang.String disputeID)
                                                     throws java.lang.Exception
        Submit the evidence associated with a dispute.

        Evidence items must be uploaded using the appropriate endpoint(s) prior to calling this endpoint to submit it. **Evidence can only be submitted once per dispute.**

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        submitEvidence in interface SDKMethodInterfaces.MethodCallSubmitDisputeEvidence
        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 -
        disputeID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getEvidence

        public GetDisputeEvidenceRequestBuilder getEvidence()
        Get dispute evidence by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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
      • getEvidence

        public GetDisputeEvidenceResponse getEvidence​(java.lang.String accountID,
                                                      java.lang.String disputeID,
                                                      java.lang.String evidenceID)
                                               throws java.lang.Exception
        Get dispute evidence by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        accountID -
        disputeID -
        evidenceID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getEvidence

        public GetDisputeEvidenceResponse getEvidence​(java.util.Optional<java.lang.String> xMoovVersion,
                                                      java.lang.String accountID,
                                                      java.lang.String disputeID,
                                                      java.lang.String evidenceID)
                                               throws java.lang.Exception
        Get dispute evidence by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        getEvidence in interface SDKMethodInterfaces.MethodCallGetDisputeEvidence
        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 -
        disputeID -
        evidenceID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • updateEvidence

        public UpdateDisputeEvidenceRequestBuilder updateEvidence()
        Updates dispute evidence by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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
      • updateEvidence

        public UpdateDisputeEvidenceResponse updateEvidence​(UpdateDisputeEvidenceRequest request)
                                                     throws java.lang.Exception
        Updates dispute evidence by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        updateEvidence in interface SDKMethodInterfaces.MethodCallUpdateDisputeEvidence
        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
      • deleteEvidence

        public DeleteDisputeEvidenceFileRequestBuilder deleteEvidence()
        Deletes dispute evidence by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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
      • deleteEvidence

        public DeleteDisputeEvidenceFileResponse deleteEvidence​(java.lang.String accountID,
                                                                java.lang.String disputeID,
                                                                java.lang.String evidenceID)
                                                         throws java.lang.Exception
        Deletes dispute evidence by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        accountID -
        disputeID -
        evidenceID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • deleteEvidence

        public DeleteDisputeEvidenceFileResponse deleteEvidence​(java.util.Optional<java.lang.String> xMoovVersion,
                                                                java.lang.String accountID,
                                                                java.lang.String disputeID,
                                                                java.lang.String evidenceID)
                                                         throws java.lang.Exception
        Deletes dispute evidence by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        deleteEvidence in interface SDKMethodInterfaces.MethodCallDeleteDisputeEvidenceFile
        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 -
        disputeID -
        evidenceID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getEvidenceData

        public GetDisputeEvidenceDataRequestBuilder getEvidenceData()
        Downloads dispute evidence data by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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
      • getEvidenceData

        public GetDisputeEvidenceDataResponse getEvidenceData​(java.lang.String accountID,
                                                              java.lang.String disputeID,
                                                              java.lang.String evidenceID)
                                                       throws java.lang.Exception
        Downloads dispute evidence data by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        accountID -
        disputeID -
        evidenceID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getEvidenceData

        public GetDisputeEvidenceDataResponse getEvidenceData​(java.util.Optional<java.lang.String> xMoovVersion,
                                                              java.lang.String accountID,
                                                              java.lang.String disputeID,
                                                              java.lang.String evidenceID)
                                                       throws java.lang.Exception
        Downloads dispute evidence data by ID.

        Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) 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:
        getEvidenceData in interface SDKMethodInterfaces.MethodCallGetDisputeEvidenceData
        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 -
        disputeID -
        evidenceID -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails