Package de.adorsys.ledgers.oba.rest.api.resource.oba

Interface ObaAisApi

public interface ObaAisApi

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_PATH
static String	DATE_FROM_QUERY_PARAM
static String	DATE_TO_QUERY_PARAM
static String	LOCAL_DATE_YYYY_MM_DD_FORMAT

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<de.adorsys.ledgers.middleware.api.domain.account.AccountDetailsTO>	account(String accountId)
org.springframework.http.ResponseEntity<List<de.adorsys.ledgers.middleware.api.domain.account.AccountDetailsTO>>	accounts(String userLogin)
org.springframework.http.ResponseEntity<List<de.adorsys.ledgers.middleware.api.domain.payment.PaymentTO>>	getPendingPeriodicPayments()
org.springframework.http.ResponseEntity<List<de.adorsys.ledgers.middleware.api.domain.account.TransactionTO>>	transactions(String accountId, LocalDate dateFrom, LocalDate dateTo)
org.springframework.http.ResponseEntity<de.adorsys.ledgers.util.domain.CustomPageImpl<de.adorsys.ledgers.middleware.api.domain.account.TransactionTO>>	transactions(String accountId, LocalDate dateFrom, LocalDate dateTo, int page, int size)

Field Detail

BASE_PATH

static final String BASE_PATH

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

Method Detail

accounts

@GetMapping(path="/accounts/{userLogin}")
org.springframework.http.ResponseEntity<List<de.adorsys.ledgers.middleware.api.domain.account.AccountDetailsTO>> accounts(@PathVariable("userLogin")
                                                                                                                          String userLogin)

Parameters:

userLogin - login of current user

Returns:

List of accounts for user

account

@GetMapping(path="/account/{accountId}")
org.springframework.http.ResponseEntity<de.adorsys.ledgers.middleware.api.domain.account.AccountDetailsTO> account(@PathVariable(name="accountId")
                                                                                                                   String accountId)

Parameters:

accountId - selected account id

Returns:

account details for queried account

transactions

@GetMapping(path="/transactions/{accountId}")
org.springframework.http.ResponseEntity<List<de.adorsys.ledgers.middleware.api.domain.account.TransactionTO>> transactions(@PathVariable(name="accountId")
                                                                                                                           String accountId,
                                                                                                                           @RequestParam(name="dateFrom",required=false) @DateTimeFormat(pattern="yyyy-MM-dd")
                                                                                                                           LocalDate dateFrom,
                                                                                                                           @RequestParam(name="dateTo",required=false) @DateTimeFormat(pattern="yyyy-MM-dd")
                                                                                                                           LocalDate dateTo)

Parameters:

accountId - selected accounts id

dateFrom - date from which the user requests to see transactions

dateTo - date until which user requests to see transactions

Returns:

List of transactions for account

transactions

@GetMapping(path="/transactions/{accountId}/page")
org.springframework.http.ResponseEntity<de.adorsys.ledgers.util.domain.CustomPageImpl<de.adorsys.ledgers.middleware.api.domain.account.TransactionTO>> transactions(@PathVariable(name="accountId")
                                                                                                                                                                    String accountId,
                                                                                                                                                                    @RequestParam(name="dateFrom",required=false) @DateTimeFormat(pattern="yyyy-MM-dd")
                                                                                                                                                                    LocalDate dateFrom,
                                                                                                                                                                    @RequestParam(name="dateTo",required=false) @DateTimeFormat(pattern="yyyy-MM-dd")
                                                                                                                                                                    LocalDate dateTo,
                                                                                                                                                                    @RequestParam(required=false,defaultValue="0")
                                                                                                                                                                    int page,
                                                                                                                                                                    @RequestParam(required=false,defaultValue="25")
                                                                                                                                                                    int size)

Parameters:

accountId - selected accounts id

dateFrom - date from which the user requests to see transactions

dateTo - date until which user requests to see transactions

Returns:

List of transactions for account

getPendingPeriodicPayments

@GetMapping(path="/payments")
org.springframework.http.ResponseEntity<List<de.adorsys.ledgers.middleware.api.domain.payment.PaymentTO>> getPendingPeriodicPayments()

Returns:

List of pending periodic payments