Package org.apache.fineract.client.services

Interface LoanTransactionsApi

public interface LoanTransactionsApi

  • Method Details

    • adjustLoanTransaction

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}/transactions/{transactionId}") retrofit2.Call<PostLoansLoanIdTransactionsResponse> adjustLoanTransaction(@Path("loanId") Long loanId, @Path("transactionId") Long transactionId, @Body PostLoansLoanIdTransactionsTransactionIdRequest postLoansLoanIdTransactionsTransactionIdRequest, @Query("command") String command)
      Adjust a Transaction Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount
      Parameters:
      loanId - loanId (required)
      transactionId - transactionId (required)
      postLoansLoanIdTransactionsTransactionIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdTransactionsResponse>

    • adjustLoanTransaction1

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}/transactions/external-id/{externalTransactionId}") retrofit2.Call<PostLoansLoanIdTransactionsResponse> adjustLoanTransaction1(@Path("loanId") Long loanId, @Path("externalTransactionId") String externalTransactionId, @Body PostLoansLoanIdTransactionsTransactionIdRequest postLoansLoanIdTransactionsTransactionIdRequest, @Query("command") String command)
      Adjust a Transaction Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount
      Parameters:
      loanId - loanId (required)
      externalTransactionId - externalTransactionId (required)
      postLoansLoanIdTransactionsTransactionIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdTransactionsResponse>

    • adjustLoanTransaction2

      @Headers("Content-Type:application/json") @POST("v1/loans/external-id/{loanExternalId}/transactions/{transactionId}") retrofit2.Call<PostLoansLoanIdTransactionsResponse> adjustLoanTransaction2(@Path("loanExternalId") String loanExternalId, @Path("transactionId") Long transactionId, @Body PostLoansLoanIdTransactionsTransactionIdRequest postLoansLoanIdTransactionsTransactionIdRequest, @Query("command") String command)
      Adjust a Transaction Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount
      Parameters:
      loanExternalId - loanExternalId (required)
      transactionId - transactionId (required)
      postLoansLoanIdTransactionsTransactionIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdTransactionsResponse>

    • adjustLoanTransaction3

      @Headers("Content-Type:application/json") @POST("v1/loans/external-id/{loanExternalId}/transactions/external-id/{externalTransactionId}") retrofit2.Call<PostLoansLoanIdTransactionsResponse> adjustLoanTransaction3(@Path("loanExternalId") String loanExternalId, @Path("externalTransactionId") String externalTransactionId, @Body PostLoansLoanIdTransactionsTransactionIdRequest postLoansLoanIdTransactionsTransactionIdRequest, @Query("command") String command)
      Adjust a Transaction Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount
      Parameters:
      loanExternalId - loanExternalId (required)
      externalTransactionId - externalTransactionId (required)
      postLoansLoanIdTransactionsTransactionIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdTransactionsResponse>

    • executeLoanTransaction

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}/transactions") retrofit2.Call<PostLoansLoanIdTransactionsResponse> executeLoanTransaction(@Path("loanId") Long loanId, @Body PostLoansLoanIdTransactionsRequest postLoansLoanIdTransactionsRequest, @Query("command") String command)
      Significant Loan Transactions This API covers the major loan transaction functionality Example Requests: loans/1/transactions?command=repayment | Make a Repayment | loans/1/transactions?command=merchantIssuedRefund | Merchant Issued Refund | loans/1/transactions?command=payoutRefund | Payout Refund | loans/1/transactions?command=goodwillCredit | Goodwil Credit | loans/1/transactions?command=chargeRefund | Charge Refund | loans/1/transactions?command=waiveinterest | Waive Interest | loans/1/transactions?command=writeoff | Write-off Loan | loans/1/transactions?command=close-rescheduled | Close Rescheduled Loan | loans/1/transactions?command=close | Close Loan | loans/1/transactions?command=undowriteoff | Undo Loan Write-off | loans/1/transactions?command=recoverypayment | Make Recovery Payment | loans/1/transactions?command=refundByCash | Make a Refund of an Active Loan by Cash | loans/1/transactions?command=foreclosure | Foreclosure of an Active Loan | loans/1/transactions?command=creditBalanceRefund | Credit Balance Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=charge-off | Charge-off Loan | loans/1/transactions?command=downPayment | Down Payment |
      Parameters:
      loanId - loanId (required)
      postLoansLoanIdTransactionsRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdTransactionsResponse>

    • executeLoanTransaction1

      @Headers("Content-Type:application/json") @POST("v1/loans/external-id/{loanExternalId}/transactions") retrofit2.Call<PostLoansLoanIdTransactionsResponse> executeLoanTransaction1(@Path("loanExternalId") String loanExternalId, @Body PostLoansLoanIdTransactionsRequest postLoansLoanIdTransactionsRequest, @Query("command") String command)
      Significant Loan Transactions This API covers the major loan transaction functionality Example Requests: loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=repayment | Make a Repayment | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=merchantIssuedRefund | Merchant Issued Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=payoutRefund | Payout Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=goodwillCredit | Goodwil Credit | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=chargeRefund | Charge Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=waiveinterest | Waive Interest | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=writeoff | Write-off Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=close-rescheduled | Close Rescheduled Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=close | Close Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=undowriteoff | Undo Loan Write-off | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=recoverypayment | Make Recovery Payment | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=refundByCash | Make a Refund of an Active Loan by Cash | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=foreclosure | Foreclosure of an Active Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=creditBalanceRefund | Credit Balance Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=charge-off | Charge-off Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=downPayment | Down Payment |
      Parameters:
      loanExternalId - loanExternalId (required)
      postLoansLoanIdTransactionsRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdTransactionsResponse>

    • retrieveTransaction

      @GET("v1/loans/{loanId}/transactions/{transactionId}") retrofit2.Call<GetLoansLoanIdTransactionsTransactionIdResponse> retrieveTransaction(@Path("loanId") Long loanId, @Path("transactionId") Long transactionId, @Query("fields") String fields)
      Retrieve a Transaction Details Retrieves a Transaction Details Example Request: loans/5/transactions/3
      Parameters:
      loanId - loanId (required)
      transactionId - transactionId (required)
      fields - Optional Loan Transaction attribute list to be in the response (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsTransactionIdResponse>

    • retrieveTransactionByLoanExternalIdAndTransactionExternalId

      @GET("v1/loans/external-id/{loanExternalId}/transactions/external-id/{externalTransactionId}") retrofit2.Call<GetLoansLoanIdTransactionsTransactionIdResponse> retrieveTransactionByLoanExternalIdAndTransactionExternalId(@Path("loanExternalId") String loanExternalId, @Path("externalTransactionId") String externalTransactionId, @Query("fields") String fields)
      Retrieve a Transaction Details Retrieves a Transaction Details Example Request: loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions/external-id/5dd80a7c-ccba-4446-b378-01eb6f53e871
      Parameters:
      loanExternalId - loanExternalId (required)
      externalTransactionId - externalTransactionId (required)
      fields - Optional Loan Transaction attribute list to be in the response (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsTransactionIdResponse>

    • retrieveTransactionByLoanExternalIdAndTransactionId

      @GET("v1/loans/external-id/{loanExternalId}/transactions/{transactionId}") retrofit2.Call<GetLoansLoanIdTransactionsTransactionIdResponse> retrieveTransactionByLoanExternalIdAndTransactionId(@Path("loanExternalId") String loanExternalId, @Path("transactionId") Long transactionId, @Query("fields") String fields)
      Retrieve a Transaction Details Retrieves a Transaction Details Example Request: loans/5/transactions/3
      Parameters:
      loanExternalId - loanExternalId (required)
      transactionId - transactionId (required)
      fields - Optional Loan Transaction attribute list to be in the response (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsTransactionIdResponse>

    • retrieveTransactionByTransactionExternalId

      @GET("v1/loans/{loanId}/transactions/external-id/{externalTransactionId}") retrofit2.Call<GetLoansLoanIdTransactionsTransactionIdResponse> retrieveTransactionByTransactionExternalId(@Path("loanId") Long loanId, @Path("externalTransactionId") String externalTransactionId, @Query("fields") String fields)
      Retrieve a Transaction Details Retrieves a Transaction Details Example Request: loans/5/transactions/external-id/5dd80a7c-ccba-4446-b378-01eb6f53e871
      Parameters:
      loanId - loanId (required)
      externalTransactionId - externalTransactionId (required)
      fields - Optional Loan Transaction attribute list to be in the response (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsTransactionIdResponse>

    • retrieveTransactionTemplate

      @GET("v1/loans/{loanId}/transactions/template") retrofit2.Call<GetLoansLoanIdTransactionsTemplateResponse> retrieveTransactionTemplate(@Path("loanId") Long loanId, @Query("command") String command, @Query("dateFormat") String dateFormat, @Query("transactionDate") Object transactionDate, @Query("locale") String locale, @Query("transactionId") Long transactionId)
      Retrieve Loan Transaction Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: loans/1/transactions/template?command=repaymentloans/1/transactions/template?command=merchantIssuedRefundloans/1/transactions/template?command=payoutRefundloans/1/transactions/template?command=goodwillCredit loans/1/transactions/template?command=waiveinterest loans/1/transactions/template?command=writeoff loans/1/transactions/template?command=close-rescheduled loans/1/transactions/template?command=close loans/1/transactions/template?command=disburse loans/1/transactions/template?command=disburseToSavings loans/1/transactions/template?command=recoverypayment loans/1/transactions/template?command=prepayLoan loans/1/transactions/template?command=refundbycash loans/1/transactions/template?command=refundbytransfer loans/1/transactions/template?command=foreclosure loans/1/transactions/template?command=interestPaymentWaiver loans/1/transactions/template?command=creditBalanceRefund (returned 'amount' field will have the overpaid value) loans/1/transactions/template?command=charge-off loans/1/transactions/template?command=downPayment loans/1/transactions/template?command=interest-refund
      Parameters:
      loanId - loanId (required)
      command - command (optional)
      dateFormat - dateFormat (optional)
      transactionDate - transactionDate (optional)
      locale - locale (optional)
      transactionId - transactionId (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsTemplateResponse>

    • retrieveTransactionTemplate1

      @GET("v1/loans/external-id/{loanExternalId}/transactions/template") retrofit2.Call<GetLoansLoanIdTransactionsTemplateResponse> retrieveTransactionTemplate1(@Path("loanExternalId") String loanExternalId, @Query("command") String command, @Query("dateFormat") String dateFormat, @Query("transactionDate") Object transactionDate, @Query("locale") String locale, @Query("transactionId") Long transactionId)
      Retrieve Loan Transaction Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: loans/1/transactions/template?command=repaymentloans/1/transactions/template?command=merchantIssuedRefundloans/1/transactions/template?command=payoutRefundloans/1/transactions/template?command=goodwillCredit loans/1/transactions/template?command=waiveinterest loans/1/transactions/template?command=writeoff loans/1/transactions/template?command=close-rescheduled loans/1/transactions/template?command=close loans/1/transactions/template?command=disburse loans/1/transactions/template?command=disburseToSavings loans/1/transactions/template?command=recoverypayment loans/1/transactions/template?command=prepayLoan loans/1/transactions/template?command=refundbycash loans/1/transactions/template?command=refundbytransfer loans/1/transactions/template?command=foreclosure loans/1/transactions/template?command=interestPaymentWaiver loans/1/transactions/template?command=creditBalanceRefund (returned 'amount' field will have the overpaid value) loans/1/transactions/template?command=charge-off loans/1/transactions/template?command=downPayment loans/1/transactions/template?command=interest-refund
      Parameters:
      loanExternalId - loanExternalId (required)
      command - command (optional)
      dateFormat - dateFormat (optional)
      transactionDate - transactionDate (optional)
      locale - locale (optional)
      transactionId - transactionId (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsTemplateResponse>

    • retrieveTransactionsByExternalLoanId

      @GET("v1/loans/external-id/{loanExternalId}/transactions") retrofit2.Call<GetLoansLoanIdTransactionsResponse> retrieveTransactionsByExternalLoanId(@Path("loanExternalId") String loanExternalId, @Query("excludedTypes") List<TransactionType> excludedTypes, @Query("page") Integer page, @Query("size") Integer size, @Query("sort") String sort)
      Retrieve Transactions Retrieves transactions of a loan
      Parameters:
      loanExternalId - loanId (required)
      excludedTypes - excludedTypes (optional)
      page - page (optional)
      size - size (optional)
      sort - sort (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsResponse>

    • retrieveTransactionsByLoanId

      @GET("v1/loans/{loanId}/transactions") retrofit2.Call<GetLoansLoanIdTransactionsResponse> retrieveTransactionsByLoanId(@Path("loanId") Long loanId, @Query("excludedTypes") List<TransactionType> excludedTypes, @Query("page") Integer page, @Query("size") Integer size, @Query("sort") String sort)
      Retrieve Transactions Retrieves transactions of a loan
      Parameters:
      loanId - loanId (required)
      excludedTypes - excludedTypes (optional)
      page - page (optional)
      size - size (optional)
      sort - sort (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsResponse>

    • undoWaiveCharge

      @Headers("Content-Type:application/json") @PUT("v1/loans/{loanId}/transactions/{transactionId}") retrofit2.Call<PutChargeTransactionChangesResponse> undoWaiveCharge(@Path("loanId") Long loanId, @Path("transactionId") Long transactionId, @Body PutChargeTransactionChangesRequest putChargeTransactionChangesRequest)
      Undo a Waive Charge Transaction Undo a Waive Charge Transaction
      Parameters:
      loanId - loanId (required)
      transactionId - transactionId (required)
      putChargeTransactionChangesRequest - (required)
      Returns:
      Call<PutChargeTransactionChangesResponse>

    • undoWaiveCharge1

      @Headers("Content-Type:application/json") @PUT("v1/loans/{loanId}/transactions/external-id/{transactionExternalId}") retrofit2.Call<PutChargeTransactionChangesResponse> undoWaiveCharge1(@Path("loanId") Long loanId, @Path("transactionExternalId") String transactionExternalId, @Body PutChargeTransactionChangesRequest putChargeTransactionChangesRequest)
      Undo a Waive Charge Transaction Undo a Waive Charge Transaction
      Parameters:
      loanId - loanId (required)
      transactionExternalId - transactionExternalId (required)
      putChargeTransactionChangesRequest - (required)
      Returns:
      Call<PutChargeTransactionChangesResponse>

    • undoWaiveCharge2

      @Headers("Content-Type:application/json") @PUT("v1/loans/external-id/{loanExternalId}/transactions/{transactionId}") retrofit2.Call<PutChargeTransactionChangesResponse> undoWaiveCharge2(@Path("loanExternalId") String loanExternalId, @Path("transactionId") Long transactionId, @Body PutChargeTransactionChangesRequest putChargeTransactionChangesRequest)
      Undo a Waive Charge Transaction Undo a Waive Charge Transaction
      Parameters:
      loanExternalId - loanExternalId (required)
      transactionId - transactionId (required)
      putChargeTransactionChangesRequest - (required)
      Returns:
      Call<PutChargeTransactionChangesResponse>

    • undoWaiveCharge3

      @Headers("Content-Type:application/json") @PUT("v1/loans/external-id/{loanExternalId}/transactions/external-id/{transactionExternalId}") retrofit2.Call<PutChargeTransactionChangesResponse> undoWaiveCharge3(@Path("loanExternalId") String loanExternalId, @Path("transactionExternalId") String transactionExternalId, @Body PutChargeTransactionChangesRequest putChargeTransactionChangesRequest)
      Undo a Waive Charge Transaction Undo a Waive Charge Transaction
      Parameters:
      loanExternalId - loanExternalId (required)
      transactionExternalId - transactionExternalId (required)
      putChargeTransactionChangesRequest - (required)
      Returns:
      Call<PutChargeTransactionChangesResponse>

    • adjustLoanTransaction

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}/transactions/{transactionId}") retrofit2.Call<PostLoansLoanIdTransactionsResponse> adjustLoanTransaction(@Path("loanId") Long loanId, @Path("transactionId") Long transactionId, @Body PostLoansLoanIdTransactionsTransactionIdRequest postLoansLoanIdTransactionsTransactionIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Adjust a Transaction Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount
      Parameters:
      loanId - loanId (required)
      transactionId - transactionId (required)
      postLoansLoanIdTransactionsTransactionIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdTransactionsResponse>

    • adjustLoanTransaction1

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}/transactions/external-id/{externalTransactionId}") retrofit2.Call<PostLoansLoanIdTransactionsResponse> adjustLoanTransaction1(@Path("loanId") Long loanId, @Path("externalTransactionId") String externalTransactionId, @Body PostLoansLoanIdTransactionsTransactionIdRequest postLoansLoanIdTransactionsTransactionIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Adjust a Transaction Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount
      Parameters:
      loanId - loanId (required)
      externalTransactionId - externalTransactionId (required)
      postLoansLoanIdTransactionsTransactionIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdTransactionsResponse>

    • adjustLoanTransaction2

      @Headers("Content-Type:application/json") @POST("v1/loans/external-id/{loanExternalId}/transactions/{transactionId}") retrofit2.Call<PostLoansLoanIdTransactionsResponse> adjustLoanTransaction2(@Path("loanExternalId") String loanExternalId, @Path("transactionId") Long transactionId, @Body PostLoansLoanIdTransactionsTransactionIdRequest postLoansLoanIdTransactionsTransactionIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Adjust a Transaction Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount
      Parameters:
      loanExternalId - loanExternalId (required)
      transactionId - transactionId (required)
      postLoansLoanIdTransactionsTransactionIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdTransactionsResponse>

    • adjustLoanTransaction3

      @Headers("Content-Type:application/json") @POST("v1/loans/external-id/{loanExternalId}/transactions/external-id/{externalTransactionId}") retrofit2.Call<PostLoansLoanIdTransactionsResponse> adjustLoanTransaction3(@Path("loanExternalId") String loanExternalId, @Path("externalTransactionId") String externalTransactionId, @Body PostLoansLoanIdTransactionsTransactionIdRequest postLoansLoanIdTransactionsTransactionIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Adjust a Transaction Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount
      Parameters:
      loanExternalId - loanExternalId (required)
      externalTransactionId - externalTransactionId (required)
      postLoansLoanIdTransactionsTransactionIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdTransactionsResponse>

    • executeLoanTransaction

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}/transactions") retrofit2.Call<PostLoansLoanIdTransactionsResponse> executeLoanTransaction(@Path("loanId") Long loanId, @Body PostLoansLoanIdTransactionsRequest postLoansLoanIdTransactionsRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Significant Loan Transactions This API covers the major loan transaction functionality Example Requests: loans/1/transactions?command=repayment | Make a Repayment | loans/1/transactions?command=merchantIssuedRefund | Merchant Issued Refund | loans/1/transactions?command=payoutRefund | Payout Refund | loans/1/transactions?command=goodwillCredit | Goodwil Credit | loans/1/transactions?command=chargeRefund | Charge Refund | loans/1/transactions?command=waiveinterest | Waive Interest | loans/1/transactions?command=writeoff | Write-off Loan | loans/1/transactions?command=close-rescheduled | Close Rescheduled Loan | loans/1/transactions?command=close | Close Loan | loans/1/transactions?command=undowriteoff | Undo Loan Write-off | loans/1/transactions?command=recoverypayment | Make Recovery Payment | loans/1/transactions?command=refundByCash | Make a Refund of an Active Loan by Cash | loans/1/transactions?command=foreclosure | Foreclosure of an Active Loan | loans/1/transactions?command=creditBalanceRefund | Credit Balance Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=charge-off | Charge-off Loan | loans/1/transactions?command=downPayment | Down Payment |
      Parameters:
      loanId - loanId (required)
      postLoansLoanIdTransactionsRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdTransactionsResponse>

    • executeLoanTransaction1

      @Headers("Content-Type:application/json") @POST("v1/loans/external-id/{loanExternalId}/transactions") retrofit2.Call<PostLoansLoanIdTransactionsResponse> executeLoanTransaction1(@Path("loanExternalId") String loanExternalId, @Body PostLoansLoanIdTransactionsRequest postLoansLoanIdTransactionsRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Significant Loan Transactions This API covers the major loan transaction functionality Example Requests: loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=repayment | Make a Repayment | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=merchantIssuedRefund | Merchant Issued Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=payoutRefund | Payout Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=goodwillCredit | Goodwil Credit | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=chargeRefund | Charge Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=waiveinterest | Waive Interest | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=writeoff | Write-off Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=close-rescheduled | Close Rescheduled Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=close | Close Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=undowriteoff | Undo Loan Write-off | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=recoverypayment | Make Recovery Payment | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=refundByCash | Make a Refund of an Active Loan by Cash | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=foreclosure | Foreclosure of an Active Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=creditBalanceRefund | Credit Balance Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=charge-off | Charge-off Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=downPayment | Down Payment |
      Parameters:
      loanExternalId - loanExternalId (required)
      postLoansLoanIdTransactionsRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdTransactionsResponse>

    • retrieveTransaction

      @GET("v1/loans/{loanId}/transactions/{transactionId}") retrofit2.Call<GetLoansLoanIdTransactionsTransactionIdResponse> retrieveTransaction(@Path("loanId") Long loanId, @Path("transactionId") Long transactionId, @Query("fields") String fields, @HeaderMap Map<String,String> headers)
      Retrieve a Transaction Details Retrieves a Transaction Details Example Request: loans/5/transactions/3
      Parameters:
      loanId - loanId (required)
      transactionId - transactionId (required)
      fields - Optional Loan Transaction attribute list to be in the response (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsTransactionIdResponse>

    • retrieveTransactionByLoanExternalIdAndTransactionExternalId

      @GET("v1/loans/external-id/{loanExternalId}/transactions/external-id/{externalTransactionId}") retrofit2.Call<GetLoansLoanIdTransactionsTransactionIdResponse> retrieveTransactionByLoanExternalIdAndTransactionExternalId(@Path("loanExternalId") String loanExternalId, @Path("externalTransactionId") String externalTransactionId, @Query("fields") String fields, @HeaderMap Map<String,String> headers)
      Retrieve a Transaction Details Retrieves a Transaction Details Example Request: loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions/external-id/5dd80a7c-ccba-4446-b378-01eb6f53e871
      Parameters:
      loanExternalId - loanExternalId (required)
      externalTransactionId - externalTransactionId (required)
      fields - Optional Loan Transaction attribute list to be in the response (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsTransactionIdResponse>

    • retrieveTransactionByLoanExternalIdAndTransactionId

      @GET("v1/loans/external-id/{loanExternalId}/transactions/{transactionId}") retrofit2.Call<GetLoansLoanIdTransactionsTransactionIdResponse> retrieveTransactionByLoanExternalIdAndTransactionId(@Path("loanExternalId") String loanExternalId, @Path("transactionId") Long transactionId, @Query("fields") String fields, @HeaderMap Map<String,String> headers)
      Retrieve a Transaction Details Retrieves a Transaction Details Example Request: loans/5/transactions/3
      Parameters:
      loanExternalId - loanExternalId (required)
      transactionId - transactionId (required)
      fields - Optional Loan Transaction attribute list to be in the response (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsTransactionIdResponse>

    • retrieveTransactionByTransactionExternalId

      @GET("v1/loans/{loanId}/transactions/external-id/{externalTransactionId}") retrofit2.Call<GetLoansLoanIdTransactionsTransactionIdResponse> retrieveTransactionByTransactionExternalId(@Path("loanId") Long loanId, @Path("externalTransactionId") String externalTransactionId, @Query("fields") String fields, @HeaderMap Map<String,String> headers)
      Retrieve a Transaction Details Retrieves a Transaction Details Example Request: loans/5/transactions/external-id/5dd80a7c-ccba-4446-b378-01eb6f53e871
      Parameters:
      loanId - loanId (required)
      externalTransactionId - externalTransactionId (required)
      fields - Optional Loan Transaction attribute list to be in the response (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsTransactionIdResponse>

    • retrieveTransactionTemplate

      @GET("v1/loans/{loanId}/transactions/template") retrofit2.Call<GetLoansLoanIdTransactionsTemplateResponse> retrieveTransactionTemplate(@Path("loanId") Long loanId, @Query("command") String command, @Query("dateFormat") String dateFormat, @Query("transactionDate") Object transactionDate, @Query("locale") String locale, @Query("transactionId") Long transactionId, @HeaderMap Map<String,String> headers)
      Retrieve Loan Transaction Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: loans/1/transactions/template?command=repaymentloans/1/transactions/template?command=merchantIssuedRefundloans/1/transactions/template?command=payoutRefundloans/1/transactions/template?command=goodwillCredit loans/1/transactions/template?command=waiveinterest loans/1/transactions/template?command=writeoff loans/1/transactions/template?command=close-rescheduled loans/1/transactions/template?command=close loans/1/transactions/template?command=disburse loans/1/transactions/template?command=disburseToSavings loans/1/transactions/template?command=recoverypayment loans/1/transactions/template?command=prepayLoan loans/1/transactions/template?command=refundbycash loans/1/transactions/template?command=refundbytransfer loans/1/transactions/template?command=foreclosure loans/1/transactions/template?command=interestPaymentWaiver loans/1/transactions/template?command=creditBalanceRefund (returned 'amount' field will have the overpaid value) loans/1/transactions/template?command=charge-off loans/1/transactions/template?command=downPayment loans/1/transactions/template?command=interest-refund
      Parameters:
      loanId - loanId (required)
      command - command (optional)
      dateFormat - dateFormat (optional)
      transactionDate - transactionDate (optional)
      locale - locale (optional)
      transactionId - transactionId (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsTemplateResponse>

    • retrieveTransactionTemplate1

      @GET("v1/loans/external-id/{loanExternalId}/transactions/template") retrofit2.Call<GetLoansLoanIdTransactionsTemplateResponse> retrieveTransactionTemplate1(@Path("loanExternalId") String loanExternalId, @Query("command") String command, @Query("dateFormat") String dateFormat, @Query("transactionDate") Object transactionDate, @Query("locale") String locale, @Query("transactionId") Long transactionId, @HeaderMap Map<String,String> headers)
      Retrieve Loan Transaction Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: loans/1/transactions/template?command=repaymentloans/1/transactions/template?command=merchantIssuedRefundloans/1/transactions/template?command=payoutRefundloans/1/transactions/template?command=goodwillCredit loans/1/transactions/template?command=waiveinterest loans/1/transactions/template?command=writeoff loans/1/transactions/template?command=close-rescheduled loans/1/transactions/template?command=close loans/1/transactions/template?command=disburse loans/1/transactions/template?command=disburseToSavings loans/1/transactions/template?command=recoverypayment loans/1/transactions/template?command=prepayLoan loans/1/transactions/template?command=refundbycash loans/1/transactions/template?command=refundbytransfer loans/1/transactions/template?command=foreclosure loans/1/transactions/template?command=interestPaymentWaiver loans/1/transactions/template?command=creditBalanceRefund (returned 'amount' field will have the overpaid value) loans/1/transactions/template?command=charge-off loans/1/transactions/template?command=downPayment loans/1/transactions/template?command=interest-refund
      Parameters:
      loanExternalId - loanExternalId (required)
      command - command (optional)
      dateFormat - dateFormat (optional)
      transactionDate - transactionDate (optional)
      locale - locale (optional)
      transactionId - transactionId (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsTemplateResponse>

    • retrieveTransactionsByExternalLoanId

      @GET("v1/loans/external-id/{loanExternalId}/transactions") retrofit2.Call<GetLoansLoanIdTransactionsResponse> retrieveTransactionsByExternalLoanId(@Path("loanExternalId") String loanExternalId, @Query("excludedTypes") List<TransactionType> excludedTypes, @Query("page") Integer page, @Query("size") Integer size, @Query("sort") String sort, @HeaderMap Map<String,String> headers)
      Retrieve Transactions Retrieves transactions of a loan
      Parameters:
      loanExternalId - loanId (required)
      excludedTypes - excludedTypes (optional)
      page - page (optional)
      size - size (optional)
      sort - sort (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsResponse>

    • retrieveTransactionsByLoanId

      @GET("v1/loans/{loanId}/transactions") retrofit2.Call<GetLoansLoanIdTransactionsResponse> retrieveTransactionsByLoanId(@Path("loanId") Long loanId, @Query("excludedTypes") List<TransactionType> excludedTypes, @Query("page") Integer page, @Query("size") Integer size, @Query("sort") String sort, @HeaderMap Map<String,String> headers)
      Retrieve Transactions Retrieves transactions of a loan
      Parameters:
      loanId - loanId (required)
      excludedTypes - excludedTypes (optional)
      page - page (optional)
      size - size (optional)
      sort - sort (optional)
      Returns:
      Call<GetLoansLoanIdTransactionsResponse>

    • undoWaiveCharge

      @Headers("Content-Type:application/json") @PUT("v1/loans/{loanId}/transactions/{transactionId}") retrofit2.Call<PutChargeTransactionChangesResponse> undoWaiveCharge(@Path("loanId") Long loanId, @Path("transactionId") Long transactionId, @Body PutChargeTransactionChangesRequest putChargeTransactionChangesRequest, @HeaderMap Map<String,String> headers)
      Undo a Waive Charge Transaction Undo a Waive Charge Transaction
      Parameters:
      loanId - loanId (required)
      transactionId - transactionId (required)
      putChargeTransactionChangesRequest - (required)
      Returns:
      Call<PutChargeTransactionChangesResponse>

    • undoWaiveCharge1

      @Headers("Content-Type:application/json") @PUT("v1/loans/{loanId}/transactions/external-id/{transactionExternalId}") retrofit2.Call<PutChargeTransactionChangesResponse> undoWaiveCharge1(@Path("loanId") Long loanId, @Path("transactionExternalId") String transactionExternalId, @Body PutChargeTransactionChangesRequest putChargeTransactionChangesRequest, @HeaderMap Map<String,String> headers)
      Undo a Waive Charge Transaction Undo a Waive Charge Transaction
      Parameters:
      loanId - loanId (required)
      transactionExternalId - transactionExternalId (required)
      putChargeTransactionChangesRequest - (required)
      Returns:
      Call<PutChargeTransactionChangesResponse>

    • undoWaiveCharge2

      @Headers("Content-Type:application/json") @PUT("v1/loans/external-id/{loanExternalId}/transactions/{transactionId}") retrofit2.Call<PutChargeTransactionChangesResponse> undoWaiveCharge2(@Path("loanExternalId") String loanExternalId, @Path("transactionId") Long transactionId, @Body PutChargeTransactionChangesRequest putChargeTransactionChangesRequest, @HeaderMap Map<String,String> headers)
      Undo a Waive Charge Transaction Undo a Waive Charge Transaction
      Parameters:
      loanExternalId - loanExternalId (required)
      transactionId - transactionId (required)
      putChargeTransactionChangesRequest - (required)
      Returns:
      Call<PutChargeTransactionChangesResponse>

    • undoWaiveCharge3

      @Headers("Content-Type:application/json") @PUT("v1/loans/external-id/{loanExternalId}/transactions/external-id/{transactionExternalId}") retrofit2.Call<PutChargeTransactionChangesResponse> undoWaiveCharge3(@Path("loanExternalId") String loanExternalId, @Path("transactionExternalId") String transactionExternalId, @Body PutChargeTransactionChangesRequest putChargeTransactionChangesRequest, @HeaderMap Map<String,String> headers)
      Undo a Waive Charge Transaction Undo a Waive Charge Transaction
      Parameters:
      loanExternalId - loanExternalId (required)
      transactionExternalId - transactionExternalId (required)
      putChargeTransactionChangesRequest - (required)
      Returns:
      Call<PutChargeTransactionChangesResponse>