Package de.adorsys.psd2.sandbox.tpp.rest.api.resource

Interface TppAccountsRestApi

  • public interface TppAccountsRestApi

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String BASE_PATH  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.springframework.http.ResponseEntity<AccountReport> accountReport​(String accountId)
      Returns an account report by its ID if it belong to the same branch as STAFF user.
      org.springframework.http.ResponseEntity<Void> createAccount​(String userId, DepositAccount account)  
      org.springframework.http.ResponseEntity<Void> depositCash​(String accountId, de.adorsys.ledgers.middleware.api.domain.payment.AmountTO amount)
      Returns a single account by its ID if it belong to the same branch as STAFF user.
      org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> downloadAccountTemplate()  
      org.springframework.http.ResponseEntity<de.adorsys.ledgers.middleware.api.domain.account.AccountDetailsTO> getAccountDetailsByIban​(String iban)  
      org.springframework.http.ResponseEntity<List<de.adorsys.ledgers.middleware.api.domain.account.AccountDetailsTO>> getAllAccounts()
      Returns the list of accounts that belong to the same branch as STAFF user.
      org.springframework.http.ResponseEntity<de.adorsys.ledgers.util.domain.CustomPageImpl<de.adorsys.ledgers.middleware.api.domain.account.AccountDetailsTO>> getAllAccounts​(String queryParam, int page, int size)
      Returns the list of accounts that belong to the same branch as STAFF user, paged view.
      org.springframework.http.ResponseEntity<de.adorsys.ledgers.middleware.api.domain.account.AccountDetailsTO> getSingleAccount​(String accountId)
      Returns a single account by its ID if it belong to the same branch as STAFF user.
      org.springframework.http.ResponseEntity<Void> updateAccountAccess​(AccountAccess accountAccess)  

    • Method Detail

      • createAccount

        @PostMapping
org.springframework.http.ResponseEntity<Void> createAccount​(@RequestParam("userId")
                                                            String userId,
                                                            @RequestBody
                                                            DepositAccount account)

      • updateAccountAccess

        @PutMapping("/access")
org.springframework.http.ResponseEntity<Void> updateAccountAccess​(@RequestBody
                                                                  AccountAccess accountAccess)

      • getAllAccounts

        @GetMapping
org.springframework.http.ResponseEntity<List<de.adorsys.ledgers.middleware.api.domain.account.AccountDetailsTO>> getAllAccounts()
        Returns the list of accounts that belong to the same branch as STAFF user.
        Returns:
        list of accounts that belongs to the same branch as staff user.

      • getAllAccounts

        @GetMapping("/page")
org.springframework.http.ResponseEntity<de.adorsys.ledgers.util.domain.CustomPageImpl<de.adorsys.ledgers.middleware.api.domain.account.AccountDetailsTO>> getAllAccounts​(@RequestParam(required=false,defaultValue="")
                                                                                                                                                                         String queryParam,
                                                                                                                                                                         @RequestParam(required=false,defaultValue="0")
                                                                                                                                                                         int page,
                                                                                                                                                                         @RequestParam(required=false,defaultValue="25")
                                                                                                                                                                         int size)
        Returns the list of accounts that belong to the same branch as STAFF user, paged view.
        Returns:
        list of accounts that belongs to the same branch as staff user.

      • getAccountDetailsByIban

        @GetMapping(path="/details")
org.springframework.http.ResponseEntity<de.adorsys.ledgers.middleware.api.domain.account.AccountDetailsTO> getAccountDetailsByIban​(@RequestParam
                                                                                                                                   String iban)
        Parameters:
        iban - : the iban
        Returns:
        : account details

      • getSingleAccount

        @GetMapping("/{accountId}")
org.springframework.http.ResponseEntity<de.adorsys.ledgers.middleware.api.domain.account.AccountDetailsTO> getSingleAccount​(@PathVariable("accountId")
                                                                                                                            String accountId)
        Returns a single account by its ID if it belong to the same branch as STAFF user.
        Returns:
        single account by its ID if it belong to the same branch as STAFF user.

      • accountReport

        @GetMapping("/report/{accountId}")
org.springframework.http.ResponseEntity<AccountReport> accountReport​(@PathVariable("accountId")
                                                                     String accountId)
        Returns an account report by its ID if it belong to the same branch as STAFF user.
        Returns:
        single account report by its ID if it belong to the same branch as STAFF user.

      • depositCash

        @PostMapping("/{accountId}/deposit-cash")
org.springframework.http.ResponseEntity<Void> depositCash​(@PathVariable("accountId")
                                                          String accountId,
                                                          @RequestBody
                                                          de.adorsys.ledgers.middleware.api.domain.payment.AmountTO amount)
        Returns a single account by its ID if it belong to the same branch as STAFF user.
        Returns:
        single account by its ID if it belong to the same branch as STAFF user.

      • downloadAccountTemplate

        @GetMapping("/example")
org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> downloadAccountTemplate()