Package org.apache.fineract.client.services

Interface InterOperationApi

public interface InterOperationApi

  • Method Details

    • createQuote

      @Headers("Content-Type:application/json") @POST("v1/interoperation/quotes") retrofit2.Call<InteropQuoteResponseData> createQuote(@Body InteropQuoteRequestData interopQuoteRequestData)
      Calculate Interoperation Quote
      Parameters:
      interopQuoteRequestData - (required)
      Returns:
      Call<InteropQuoteResponseData>

    • createTransactionRequest

      @Headers("Content-Type:application/json") @POST("v1/interoperation/requests") retrofit2.Call<InteropTransactionRequestResponseData> createTransactionRequest(@Body InteropTransactionRequestData interopTransactionRequestData)
      Allow Interoperation Transaction Request
      Parameters:
      interopTransactionRequestData - (required)
      Returns:
      Call<InteropTransactionRequestResponseData>

    • deleteAccountIdentifier

      @Headers("Content-Type:application/json") @DELETE("v1/interoperation/parties/{idType}/{idValue}") retrofit2.Call<InteropIdentifierAccountResponseData> deleteAccountIdentifier(@Path("idType") String idType, @Path("idValue") String idValue, @Body InteropIdentifierRequestData interopIdentifierRequestData)
      Allow Interoperation Identifier registration
      Parameters:
      idType - idType (required)
      idValue - idValue (required)
      interopIdentifierRequestData - (required)
      Returns:
      Call<InteropIdentifierAccountResponseData>

    • deleteAccountIdentifier1

      @Headers("Content-Type:application/json") @DELETE("v1/interoperation/parties/{idType}/{idValue}/{subIdOrType}") retrofit2.Call<InteropIdentifierAccountResponseData> deleteAccountIdentifier1(@Path("idType") String idType, @Path("idValue") String idValue, @Path("subIdOrType") String subIdOrType, @Body InteropIdentifierRequestData interopIdentifierRequestData)
      Allow Interoperation Identifier registration
      Parameters:
      idType - idType (required)
      idValue - idValue (required)
      subIdOrType - subIdOrType (required)
      interopIdentifierRequestData - (required)
      Returns:
      Call<InteropIdentifierAccountResponseData>

    • disburseLoan

      @POST("v1/interoperation/transactions/{accountId}/disburse") retrofit2.Call<String> disburseLoan(@Path("accountId") String accountId)
      Disburse Loan by Account Id
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<String>

    • getAccountByIdentifier

      @GET("v1/interoperation/parties/{idType}/{idValue}") retrofit2.Call<InteropIdentifierAccountResponseData> getAccountByIdentifier(@Path("idType") String idType, @Path("idValue") String idValue)
      Query Interoperation Account by secondary identifier
      Parameters:
      idType - idType (required)
      idValue - idValue (required)
      Returns:
      Call<InteropIdentifierAccountResponseData>

    • getAccountByIdentifier1

      @GET("v1/interoperation/parties/{idType}/{idValue}/{subIdOrType}") retrofit2.Call<InteropIdentifierAccountResponseData> getAccountByIdentifier1(@Path("idType") String idType, @Path("idValue") String idValue, @Path("subIdOrType") String subIdOrType)
      Query Interoperation Account by secondary identifier
      Parameters:
      idType - idType (required)
      idValue - idValue (required)
      subIdOrType - subIdOrType (required)
      Returns:
      Call<InteropIdentifierAccountResponseData>

    • getAccountDetails

      @GET("v1/interoperation/accounts/{accountId}") retrofit2.Call<InteropAccountData> getAccountDetails(@Path("accountId") String accountId)
      Query Interoperation Account details
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<InteropAccountData>

    • getAccountIdentifiers

      @GET("v1/interoperation/accounts/{accountId}/identifiers") retrofit2.Call<InteropIdentifiersResponseData> getAccountIdentifiers(@Path("accountId") String accountId)
      Query Interoperation secondary identifiers by Account Id
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<InteropIdentifiersResponseData>

    • getAccountTransactions

      @GET("v1/interoperation/accounts/{accountId}/transactions") retrofit2.Call<InteropTransactionsData> getAccountTransactions(@Path("accountId") String accountId, @Query("debit") Boolean debit, @Query("credit") Boolean credit, @Query("fromBookingDateTime") String fromBookingDateTime, @Query("toBookingDateTime") String toBookingDateTime)
      Query transactions by Account Id
      Parameters:
      accountId - accountId (required)
      debit - debit (optional, default to true)
      credit - credit (optional, default to false)
      fromBookingDateTime - fromBookingDateTime (optional)
      toBookingDateTime - toBookingDateTime (optional)
      Returns:
      Call<InteropTransactionsData>

    • getClientKyc

      @GET("v1/interoperation/accounts/{accountId}/kyc") retrofit2.Call<InteropKycResponseData> getClientKyc(@Path("accountId") String accountId)
      Query KYC by Account Id
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<InteropKycResponseData>

    • getQuote

      @GET("v1/interoperation/transactions/{transactionCode}/quotes/{quoteCode}") retrofit2.Call<InteropQuoteResponseData> getQuote(@Path("transactionCode") String transactionCode, @Path("quoteCode") String quoteCode)
      Query Interoperation Quote
      Parameters:
      transactionCode - transactionCode (required)
      quoteCode - quoteCode (required)
      Returns:
      Call<InteropQuoteResponseData>

    • getTransactionRequest

      @GET("v1/interoperation/transactions/{transactionCode}/requests/{requestCode}") retrofit2.Call<InteropTransactionRequestResponseData> getTransactionRequest(@Path("transactionCode") String transactionCode, @Path("requestCode") String requestCode)
      Query Interoperation Transaction Request
      Parameters:
      transactionCode - transactionCode (required)
      requestCode - requestCode (required)
      Returns:
      Call<InteropTransactionRequestResponseData>

    • getTransfer

      @GET("v1/interoperation/transactions/{transactionCode}/transfers/{transferCode}") retrofit2.Call<InteropTransferResponseData> getTransfer(@Path("transactionCode") String transactionCode, @Path("transferCode") String transferCode)
      Query Interoperation Transfer
      Parameters:
      transactionCode - transactionCode (required)
      transferCode - transferCode (required)
      Returns:
      Call<InteropTransferResponseData>

    • health

      @GET("v1/interoperation/health") retrofit2.Call<Void> health()
      Query Interoperation Health Request
      Returns:
      Call<Void>

    • loanRepayment

      @POST("v1/interoperation/transactions/{accountId}/loanrepayment") retrofit2.Call<String> loanRepayment(@Path("accountId") String accountId)
      Disburse Loan by Account Id
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<String>

    • performTransfer

      @Headers("Content-Type:application/json") @POST("v1/interoperation/transfers") retrofit2.Call<InteropTransferResponseData> performTransfer(@Body InteropTransferRequestData interopTransferRequestData, @Query("action") String action)
      Prepare Interoperation Transfer
      Parameters:
      interopTransferRequestData - (required)
      action - action (optional)
      Returns:
      Call<InteropTransferResponseData>

    • registerAccountIdentifier

      @Headers("Content-Type:application/json") @POST("v1/interoperation/parties/{idType}/{idValue}") retrofit2.Call<InteropIdentifierAccountResponseData> registerAccountIdentifier(@Path("idType") String idType, @Path("idValue") String idValue, @Body InteropIdentifierRequestData interopIdentifierRequestData)
      Interoperation Identifier registration
      Parameters:
      idType - idType (required)
      idValue - idValue (required)
      interopIdentifierRequestData - (required)
      Returns:
      Call<InteropIdentifierAccountResponseData>

    • registerAccountIdentifier1

      @Headers("Content-Type:application/json") @POST("v1/interoperation/parties/{idType}/{idValue}/{subIdOrType}") retrofit2.Call<InteropIdentifierAccountResponseData> registerAccountIdentifier1(@Path("idType") String idType, @Path("idValue") String idValue, @Path("subIdOrType") String subIdOrType, @Body InteropIdentifierRequestData interopIdentifierRequestData)
      Interoperation Identifier registration
      Parameters:
      idType - idType (required)
      idValue - idValue (required)
      subIdOrType - subIdOrType (required)
      interopIdentifierRequestData - (required)
      Returns:
      Call<InteropIdentifierAccountResponseData>

    • createQuote

      @Headers("Content-Type:application/json") @POST("v1/interoperation/quotes") retrofit2.Call<InteropQuoteResponseData> createQuote(@Body InteropQuoteRequestData interopQuoteRequestData, @HeaderMap Map<String,String> headers)
      Calculate Interoperation Quote
      Parameters:
      interopQuoteRequestData - (required)
      Returns:
      Call<InteropQuoteResponseData>

    • createTransactionRequest

      @Headers("Content-Type:application/json") @POST("v1/interoperation/requests") retrofit2.Call<InteropTransactionRequestResponseData> createTransactionRequest(@Body InteropTransactionRequestData interopTransactionRequestData, @HeaderMap Map<String,String> headers)
      Allow Interoperation Transaction Request
      Parameters:
      interopTransactionRequestData - (required)
      Returns:
      Call<InteropTransactionRequestResponseData>

    • deleteAccountIdentifier

      @Headers("Content-Type:application/json") @DELETE("v1/interoperation/parties/{idType}/{idValue}") retrofit2.Call<InteropIdentifierAccountResponseData> deleteAccountIdentifier(@Path("idType") String idType, @Path("idValue") String idValue, @Body InteropIdentifierRequestData interopIdentifierRequestData, @HeaderMap Map<String,String> headers)
      Allow Interoperation Identifier registration
      Parameters:
      idType - idType (required)
      idValue - idValue (required)
      interopIdentifierRequestData - (required)
      Returns:
      Call<InteropIdentifierAccountResponseData>

    • deleteAccountIdentifier1

      @Headers("Content-Type:application/json") @DELETE("v1/interoperation/parties/{idType}/{idValue}/{subIdOrType}") retrofit2.Call<InteropIdentifierAccountResponseData> deleteAccountIdentifier1(@Path("idType") String idType, @Path("idValue") String idValue, @Path("subIdOrType") String subIdOrType, @Body InteropIdentifierRequestData interopIdentifierRequestData, @HeaderMap Map<String,String> headers)
      Allow Interoperation Identifier registration
      Parameters:
      idType - idType (required)
      idValue - idValue (required)
      subIdOrType - subIdOrType (required)
      interopIdentifierRequestData - (required)
      Returns:
      Call<InteropIdentifierAccountResponseData>

    • disburseLoan

      @POST("v1/interoperation/transactions/{accountId}/disburse") retrofit2.Call<String> disburseLoan(@Path("accountId") String accountId, @HeaderMap Map<String,String> headers)
      Disburse Loan by Account Id
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<String>

    • getAccountByIdentifier

      @GET("v1/interoperation/parties/{idType}/{idValue}") retrofit2.Call<InteropIdentifierAccountResponseData> getAccountByIdentifier(@Path("idType") String idType, @Path("idValue") String idValue, @HeaderMap Map<String,String> headers)
      Query Interoperation Account by secondary identifier
      Parameters:
      idType - idType (required)
      idValue - idValue (required)
      Returns:
      Call<InteropIdentifierAccountResponseData>

    • getAccountByIdentifier1

      @GET("v1/interoperation/parties/{idType}/{idValue}/{subIdOrType}") retrofit2.Call<InteropIdentifierAccountResponseData> getAccountByIdentifier1(@Path("idType") String idType, @Path("idValue") String idValue, @Path("subIdOrType") String subIdOrType, @HeaderMap Map<String,String> headers)
      Query Interoperation Account by secondary identifier
      Parameters:
      idType - idType (required)
      idValue - idValue (required)
      subIdOrType - subIdOrType (required)
      Returns:
      Call<InteropIdentifierAccountResponseData>

    • getAccountDetails

      @GET("v1/interoperation/accounts/{accountId}") retrofit2.Call<InteropAccountData> getAccountDetails(@Path("accountId") String accountId, @HeaderMap Map<String,String> headers)
      Query Interoperation Account details
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<InteropAccountData>

    • getAccountIdentifiers

      @GET("v1/interoperation/accounts/{accountId}/identifiers") retrofit2.Call<InteropIdentifiersResponseData> getAccountIdentifiers(@Path("accountId") String accountId, @HeaderMap Map<String,String> headers)
      Query Interoperation secondary identifiers by Account Id
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<InteropIdentifiersResponseData>

    • getAccountTransactions

      @GET("v1/interoperation/accounts/{accountId}/transactions") retrofit2.Call<InteropTransactionsData> getAccountTransactions(@Path("accountId") String accountId, @Query("debit") Boolean debit, @Query("credit") Boolean credit, @Query("fromBookingDateTime") String fromBookingDateTime, @Query("toBookingDateTime") String toBookingDateTime, @HeaderMap Map<String,String> headers)
      Query transactions by Account Id
      Parameters:
      accountId - accountId (required)
      debit - debit (optional, default to true)
      credit - credit (optional, default to false)
      fromBookingDateTime - fromBookingDateTime (optional)
      toBookingDateTime - toBookingDateTime (optional)
      Returns:
      Call<InteropTransactionsData>

    • getClientKyc

      @GET("v1/interoperation/accounts/{accountId}/kyc") retrofit2.Call<InteropKycResponseData> getClientKyc(@Path("accountId") String accountId, @HeaderMap Map<String,String> headers)
      Query KYC by Account Id
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<InteropKycResponseData>

    • getQuote

      @GET("v1/interoperation/transactions/{transactionCode}/quotes/{quoteCode}") retrofit2.Call<InteropQuoteResponseData> getQuote(@Path("transactionCode") String transactionCode, @Path("quoteCode") String quoteCode, @HeaderMap Map<String,String> headers)
      Query Interoperation Quote
      Parameters:
      transactionCode - transactionCode (required)
      quoteCode - quoteCode (required)
      Returns:
      Call<InteropQuoteResponseData>

    • getTransactionRequest

      @GET("v1/interoperation/transactions/{transactionCode}/requests/{requestCode}") retrofit2.Call<InteropTransactionRequestResponseData> getTransactionRequest(@Path("transactionCode") String transactionCode, @Path("requestCode") String requestCode, @HeaderMap Map<String,String> headers)
      Query Interoperation Transaction Request
      Parameters:
      transactionCode - transactionCode (required)
      requestCode - requestCode (required)
      Returns:
      Call<InteropTransactionRequestResponseData>

    • getTransfer

      @GET("v1/interoperation/transactions/{transactionCode}/transfers/{transferCode}") retrofit2.Call<InteropTransferResponseData> getTransfer(@Path("transactionCode") String transactionCode, @Path("transferCode") String transferCode, @HeaderMap Map<String,String> headers)
      Query Interoperation Transfer
      Parameters:
      transactionCode - transactionCode (required)
      transferCode - transferCode (required)
      Returns:
      Call<InteropTransferResponseData>

    • health

      @GET("v1/interoperation/health") retrofit2.Call<Void> health(@HeaderMap Map<String,String> headers)
      Query Interoperation Health Request
      Returns:
      Call<Void>

    • loanRepayment

      @POST("v1/interoperation/transactions/{accountId}/loanrepayment") retrofit2.Call<String> loanRepayment(@Path("accountId") String accountId, @HeaderMap Map<String,String> headers)
      Disburse Loan by Account Id
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<String>

    • performTransfer

      @Headers("Content-Type:application/json") @POST("v1/interoperation/transfers") retrofit2.Call<InteropTransferResponseData> performTransfer(@Body InteropTransferRequestData interopTransferRequestData, @Query("action") String action, @HeaderMap Map<String,String> headers)
      Prepare Interoperation Transfer
      Parameters:
      interopTransferRequestData - (required)
      action - action (optional)
      Returns:
      Call<InteropTransferResponseData>

    • registerAccountIdentifier

      @Headers("Content-Type:application/json") @POST("v1/interoperation/parties/{idType}/{idValue}") retrofit2.Call<InteropIdentifierAccountResponseData> registerAccountIdentifier(@Path("idType") String idType, @Path("idValue") String idValue, @Body InteropIdentifierRequestData interopIdentifierRequestData, @HeaderMap Map<String,String> headers)
      Interoperation Identifier registration
      Parameters:
      idType - idType (required)
      idValue - idValue (required)
      interopIdentifierRequestData - (required)
      Returns:
      Call<InteropIdentifierAccountResponseData>

    • registerAccountIdentifier1

      @Headers("Content-Type:application/json") @POST("v1/interoperation/parties/{idType}/{idValue}/{subIdOrType}") retrofit2.Call<InteropIdentifierAccountResponseData> registerAccountIdentifier1(@Path("idType") String idType, @Path("idValue") String idValue, @Path("subIdOrType") String subIdOrType, @Body InteropIdentifierRequestData interopIdentifierRequestData, @HeaderMap Map<String,String> headers)
      Interoperation Identifier registration
      Parameters:
      idType - idType (required)
      idValue - idValue (required)
      subIdOrType - subIdOrType (required)
      interopIdentifierRequestData - (required)
      Returns:
      Call<InteropIdentifierAccountResponseData>