au.org.consumerdatastandards.holder.api

Interface BankingPayeesApi

All Known Implementing Classes:

BankingPayeesApiController

public interface BankingPayeesApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BankingPayeesApi.ParamPayeeType

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<ResponseBankingPayeeById>	getPayeeDetail(@NotBlank String payeeId, String xCdsClientHeaders, @NotNull java.time.OffsetDateTime xFapiAuthDate, String xFapiCustomerIpAddress, UUID xFapiInteractionId, @Min(value=1L) Integer xMinV, @Min(value=1L) Integer xV)
default Optional<org.springframework.web.context.request.NativeWebRequest>	getRequest()
org.springframework.http.ResponseEntity<ResponseBankingPayeeList>	listPayees(@Min(value=1L) Integer page, @Min(value=1L) Integer pageSize, BankingPayeesApi.ParamPayeeType type, String xCdsClientHeaders, @NotNull java.time.OffsetDateTime xFapiAuthDate, String xFapiCustomerIpAddress, UUID xFapiInteractionId, @Min(value=1L) Integer xMinV, @Min(value=1L) Integer xV)

Method Detail

getRequest

default Optional<org.springframework.web.context.request.NativeWebRequest> getRequest()

getPayeeDetail

@RequestMapping(value="/banking/payees/{payeeId}",
                method=GET)
 @PreAuthorize(value="hasAuthority(\'SCOPE_bank:payees:read\')")
org.springframework.http.ResponseEntity<ResponseBankingPayeeById> getPayeeDetail(@PathVariable(value="payeeId") @NotBlank
                                                                                                                                                                                                                                 @NotBlank String payeeId,
                                                                                                                                                                                                                                 @RequestHeader(value="x-cds-client-headers",required=false)
                                                                                                                                                                                                                                 String xCdsClientHeaders,
                                                                                                                                                                                                                                 @RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME)
                                                                                                                                                                                                                                 @NotNull java.time.OffsetDateTime xFapiAuthDate,
                                                                                                                                                                                                                                 @RequestHeader(value="x-fapi-customer-ip-address",required=false)
                                                                                                                                                                                                                                 String xFapiCustomerIpAddress,
                                                                                                                                                                                                                                 @RequestHeader(value="x-fapi-interaction-id",required=false)
                                                                                                                                                                                                                                 UUID xFapiInteractionId,
                                                                                                                                                                                                                                 @RequestHeader(value="x-min-v",required=false) @Min(value=1L)
                                                                                                                                                                                                                                 @Min(value=1L) Integer xMinV,
                                                                                                                                                                                                                                 @RequestHeader(value="x-v",required=false) @Min(value=1L)
                                                                                                                                                                                                                                 @Min(value=1L) Integer xV)

listPayees

@RequestMapping(value="/banking/payees",
                method=GET)
 @PreAuthorize(value="hasAuthority(\'SCOPE_bank:payees:read\')")
org.springframework.http.ResponseEntity<ResponseBankingPayeeList> listPayees(@RequestParam(value="page",required=false,defaultValue="1") @Min(value=1L)
                                                                                                                                                                                                                   @Min(value=1L) Integer page,
                                                                                                                                                                                                                   @RequestParam(value="page-size",required=false,defaultValue="25") @Min(value=1L)
                                                                                                                                                                                                                   @Min(value=1L) Integer pageSize,
                                                                                                                                                                                                                   @RequestParam(value="type",required=false,defaultValue="ALL")
                                                                                                                                                                                                                   BankingPayeesApi.ParamPayeeType type,
                                                                                                                                                                                                                   @RequestHeader(value="x-cds-client-headers",required=false)
                                                                                                                                                                                                                   String xCdsClientHeaders,
                                                                                                                                                                                                                   @RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME)
                                                                                                                                                                                                                   @NotNull java.time.OffsetDateTime xFapiAuthDate,
                                                                                                                                                                                                                   @RequestHeader(value="x-fapi-customer-ip-address",required=false)
                                                                                                                                                                                                                   String xFapiCustomerIpAddress,
                                                                                                                                                                                                                   @RequestHeader(value="x-fapi-interaction-id",required=false)
                                                                                                                                                                                                                   UUID xFapiInteractionId,
                                                                                                                                                                                                                   @RequestHeader(value="x-min-v",required=false) @Min(value=1L)
                                                                                                                                                                                                                   @Min(value=1L) Integer xMinV,
                                                                                                                                                                                                                   @RequestHeader(value="x-v",required=false) @Min(value=1L)
                                                                                                                                                                                                                   @Min(value=1L) Integer xV)