de.adorsys.ledgers.middleware.rest.resource

Interface AccountRestAPI

public interface AccountRestAPI

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCOUNT_ID
static String	BASE_PATH
static String	DATE_FROM_QUERY_PARAM
static String	DATE_TO_QUERY_PARAM
static String	IBAN_QUERY_PARAM
static String	LOCAL_DATE_YYYY_MM_DD_FORMAT
static String	THE_ID_OF_THE_DEPOSIT_ACCOUNT_CANNOT_BE_EMPTY
static String	THE_ID_OF_THE_TRANSACTION_CANNOT_BE_EMPTY
static String	TRANSACTION_ID

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<Void>	createDepositAccount(AccountDetailsTO accountDetailsTO)
org.springframework.http.ResponseEntity<Void>	depositCash(String accountId, AmountTO amount)
org.springframework.http.ResponseEntity<Boolean>	fundsConfirmation(FundsConfirmationRequestTO request)
org.springframework.http.ResponseEntity<AccountDetailsTO>	getAccountDetailsByIban(String iban)
org.springframework.http.ResponseEntity<AccountDetailsTO>	getAccountDetailsById(String accountId)
org.springframework.http.ResponseEntity<List<AccountBalanceTO>>	getBalances(String accountId)
org.springframework.http.ResponseEntity<List<AccountDetailsTO>>	getListOfAccounts() Return the list of accounts linked with the current customer.
org.springframework.http.ResponseEntity<List<TransactionTO>>	getTransactionByDates(String accountId, LocalDate dateFrom, LocalDate dateTo)
org.springframework.http.ResponseEntity<TransactionTO>	getTransactionById(String accountId, String transactionId)

Field Detail

BASE_PATH

static final String BASE_PATH

See Also:

Constant Field Values

IBAN_QUERY_PARAM

static final String IBAN_QUERY_PARAM

See Also:

Constant Field Values

LOCAL_DATE_YYYY_MM_DD_FORMAT

static final String LOCAL_DATE_YYYY_MM_DD_FORMAT

See Also:

Constant Field Values

DATE_TO_QUERY_PARAM

static final String DATE_TO_QUERY_PARAM

See Also:

Constant Field Values

DATE_FROM_QUERY_PARAM

static final String DATE_FROM_QUERY_PARAM

See Also:

Constant Field Values

ACCOUNT_ID

static final String ACCOUNT_ID

See Also:

Constant Field Values

TRANSACTION_ID

static final String TRANSACTION_ID

See Also:

Constant Field Values

THE_ID_OF_THE_DEPOSIT_ACCOUNT_CANNOT_BE_EMPTY

static final String THE_ID_OF_THE_DEPOSIT_ACCOUNT_CANNOT_BE_EMPTY

See Also:

Constant Field Values

THE_ID_OF_THE_TRANSACTION_CANNOT_BE_EMPTY

static final String THE_ID_OF_THE_TRANSACTION_CANNOT_BE_EMPTY

See Also:

Constant Field Values

Method Detail

getListOfAccounts

@GetMapping
org.springframework.http.ResponseEntity<List<AccountDetailsTO>> getListOfAccounts()
                                                                                       throws ForbiddenRestException

Return the list of accounts linked with the current customer.

Returns:

: the list of accounts linked with the current customer.

Throws:

ForbiddenRestException

createDepositAccount

@PostMapping
org.springframework.http.ResponseEntity<Void> createDepositAccount(@RequestBody
                                                                                AccountDetailsTO accountDetailsTO)
                                                                         throws ForbiddenRestException,
                                                                                ConflictRestException

Throws:

ForbiddenRestException

ConflictRestException

getAccountDetailsById

@GetMapping(value="/{accountId}")
org.springframework.http.ResponseEntity<AccountDetailsTO> getAccountDetailsById(@PathVariable(name="accountId")
                                                                                                                  String accountId)
                                                                                                           throws NotFoundRestException,
                                                                                                                  ForbiddenRestException

Throws:

NotFoundRestException

ForbiddenRestException

getBalances

@GetMapping(value="/{accountId}/balances")
org.springframework.http.ResponseEntity<List<AccountBalanceTO>> getBalances(@PathVariable(name="accountId")
                                                                                                                       String accountId)
                                                                                                                throws NotFoundRestException,
                                                                                                                       ForbiddenRestException

Throws:

NotFoundRestException

ForbiddenRestException

getTransactionByDates

@GetMapping(path="/{accountId}/transactions",
            params={"dateFrom","dateTo"})
org.springframework.http.ResponseEntity<List<TransactionTO>> getTransactionByDates(@PathVariable(name="accountId")
                                                                                                                                                                           String accountId,
                                                                                                                                                                           @RequestParam(name="dateFrom") @Nullable @DateTimeFormat(pattern="yyyy-MM-dd")
                                                                                                                                                                           LocalDate dateFrom,
                                                                                                                                                                           @RequestParam(name="dateTo") @Nullable @DateTimeFormat(pattern="yyyy-MM-dd")
                                                                                                                                                                           LocalDate dateTo)
                                                                                                                                                                    throws NotFoundRestException,
                                                                                                                                                                           ForbiddenRestException

Throws:

NotFoundRestException

ForbiddenRestException

getTransactionById

@GetMapping(value="/{accountId}/transactions/{transactionId}")
org.springframework.http.ResponseEntity<TransactionTO> getTransactionById(@PathVariable(name="accountId")
                                                                                                                                         String accountId,
                                                                                                                                         @PathVariable(name="transactionId")
                                                                                                                                         String transactionId)
                                                                                                                                  throws NotFoundRestException,
                                                                                                                                         ForbiddenRestException

Throws:

NotFoundRestException

ForbiddenRestException

getAccountDetailsByIban

@GetMapping(path="/query",
            params="iban")
org.springframework.http.ResponseEntity<AccountDetailsTO> getAccountDetailsByIban(@RequestParam(name="iban")
                                                                                                                                        String iban)
                                                                                                                                 throws NotFoundRestException,
                                                                                                                                        ForbiddenRestException

Parameters:

iban - : the iban

Returns:

: account details

Throws:

NotFoundRestException

ForbiddenRestException

fundsConfirmation

@PostMapping(value="/funds-confirmation")
org.springframework.http.ResponseEntity<Boolean> fundsConfirmation(@RequestBody
                                                                                                             FundsConfirmationRequestTO request)
                                                                                                      throws NotFoundRestException,
                                                                                                             ForbiddenRestException

Throws:

NotFoundRestException

ForbiddenRestException

depositCash

@PostMapping(value="/{accountId}/cash")
org.springframework.http.ResponseEntity<Void> depositCash(@PathVariable(name="accountId")
                                                                                                  String accountId,
                                                                                                  @RequestBody
                                                                                                  AmountTO amount)