Package org.apache.fineract.client.services

Interface SelfThirdPartyTransferApi

public interface SelfThirdPartyTransferApi

  • Method Details

    • add

      @Headers("Content-Type:application/json") @POST("v1/self/beneficiaries/tpt") retrofit2.Call<PostSelfBeneficiariesTPTResponse> add(@Body PostSelfBeneficiariesTPTRequest postSelfBeneficiariesTPTRequest)
      Add TPT Beneficiary Api to add third party beneficiary linked to current user. Parameter Definitions name : Nick name for beneficiary, should be unique for an self service user officeName : Office Name of beneficiary(not id) accountNumber : Account Number of beneficiary(not id) transferLimit : Each transfer initiated to this account will not exceed this amount Example Requests: /self/beneficiaries/tpt Mandatory Fields: name, officeName, accountNumber, accountType Optional Fields: transferLimit
      Parameters:
      postSelfBeneficiariesTPTRequest - (required)
      Returns:
      Call<PostSelfBeneficiariesTPTResponse>

    • delete21

      @DELETE("v1/self/beneficiaries/tpt/{beneficiaryId}") retrofit2.Call<DeleteSelfBeneficiariesTPTBeneficiaryIdResponse> delete21(@Path("beneficiaryId") Long beneficiaryId)
      Delete TPT Beneficiary Api to delete third party beneficiary linked to current user. Example Requests: /self/beneficiaries/tpt/{beneficiaryId}
      Parameters:
      beneficiaryId - (required)
      Returns:
      Call<DeleteSelfBeneficiariesTPTBeneficiaryIdResponse>

    • retrieveAll35

      @GET("v1/self/beneficiaries/tpt") retrofit2.Call<List<GetSelfBeneficiariesTPTResponse>> retrieveAll35()
      Get All TPT Beneficiary Api to get all third party beneficiary linked to current user. Example Requests: /self/beneficiaries/tpt
      Returns:
      Call<List<GetSelfBeneficiariesTPTResponse>>

    • template16

      @GET("v1/self/beneficiaries/tpt/template") retrofit2.Call<GetSelfBeneficiariesTPTTemplateResponse> template16()
      Beneficiary Third Party Transfer Template Returns Account Type enumerations. Self User is expected to know office name and account number to be able to add beneficiary. Example Requests: /self/beneficiaries/tpt/template
      Returns:
      Call<GetSelfBeneficiariesTPTTemplateResponse>

    • update23

      @Headers("Content-Type:application/json") @PUT("v1/self/beneficiaries/tpt/{beneficiaryId}") retrofit2.Call<PutSelfBeneficiariesTPTBeneficiaryIdResponse> update23(@Path("beneficiaryId") Long beneficiaryId, @Body PutSelfBeneficiariesTPTBeneficiaryIdRequest putSelfBeneficiariesTPTBeneficiaryIdRequest)
      Update TPT Beneficiary Api to update third party beneficiary linked to current user. Example Requests: /self/beneficiaries/tpt/{beneficiaryId} Optional Fields: name, transferLimit
      Parameters:
      beneficiaryId - beneficiaryId (required)
      putSelfBeneficiariesTPTBeneficiaryIdRequest - (required)
      Returns:
      Call<PutSelfBeneficiariesTPTBeneficiaryIdResponse>

    • add

      @Headers("Content-Type:application/json") @POST("v1/self/beneficiaries/tpt") retrofit2.Call<PostSelfBeneficiariesTPTResponse> add(@Body PostSelfBeneficiariesTPTRequest postSelfBeneficiariesTPTRequest, @HeaderMap Map<String,String> headers)
      Add TPT Beneficiary Api to add third party beneficiary linked to current user. Parameter Definitions name : Nick name for beneficiary, should be unique for an self service user officeName : Office Name of beneficiary(not id) accountNumber : Account Number of beneficiary(not id) transferLimit : Each transfer initiated to this account will not exceed this amount Example Requests: /self/beneficiaries/tpt Mandatory Fields: name, officeName, accountNumber, accountType Optional Fields: transferLimit
      Parameters:
      postSelfBeneficiariesTPTRequest - (required)
      Returns:
      Call<PostSelfBeneficiariesTPTResponse>

    • delete21

      @DELETE("v1/self/beneficiaries/tpt/{beneficiaryId}") retrofit2.Call<DeleteSelfBeneficiariesTPTBeneficiaryIdResponse> delete21(@Path("beneficiaryId") Long beneficiaryId, @HeaderMap Map<String,String> headers)
      Delete TPT Beneficiary Api to delete third party beneficiary linked to current user. Example Requests: /self/beneficiaries/tpt/{beneficiaryId}
      Parameters:
      beneficiaryId - (required)
      Returns:
      Call<DeleteSelfBeneficiariesTPTBeneficiaryIdResponse>

    • retrieveAll35

      @GET("v1/self/beneficiaries/tpt") retrofit2.Call<List<GetSelfBeneficiariesTPTResponse>> retrieveAll35(@HeaderMap Map<String,String> headers)
      Get All TPT Beneficiary Api to get all third party beneficiary linked to current user. Example Requests: /self/beneficiaries/tpt
      Returns:
      Call<List<GetSelfBeneficiariesTPTResponse>>

    • template16

      @GET("v1/self/beneficiaries/tpt/template") retrofit2.Call<GetSelfBeneficiariesTPTTemplateResponse> template16(@HeaderMap Map<String,String> headers)
      Beneficiary Third Party Transfer Template Returns Account Type enumerations. Self User is expected to know office name and account number to be able to add beneficiary. Example Requests: /self/beneficiaries/tpt/template
      Returns:
      Call<GetSelfBeneficiariesTPTTemplateResponse>

    • update23

      @Headers("Content-Type:application/json") @PUT("v1/self/beneficiaries/tpt/{beneficiaryId}") retrofit2.Call<PutSelfBeneficiariesTPTBeneficiaryIdResponse> update23(@Path("beneficiaryId") Long beneficiaryId, @Body PutSelfBeneficiariesTPTBeneficiaryIdRequest putSelfBeneficiariesTPTBeneficiaryIdRequest, @HeaderMap Map<String,String> headers)
      Update TPT Beneficiary Api to update third party beneficiary linked to current user. Example Requests: /self/beneficiaries/tpt/{beneficiaryId} Optional Fields: name, transferLimit
      Parameters:
      beneficiaryId - beneficiaryId (required)
      putSelfBeneficiariesTPTBeneficiaryIdRequest - (required)
      Returns:
      Call<PutSelfBeneficiariesTPTBeneficiaryIdResponse>