de.adorsys.psd2.consent.api

Interface PisCommonPaymentApi

@RequestMapping(path="api/v1/pis/common-payments")
public interface PisCommonPaymentApi

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<CreateAuthorisationResponse>	createAuthorisation(String paymentId, CreateAuthorisationRequest request)
org.springframework.http.ResponseEntity<CreateAuthorisationResponse>	createAuthorisationCancellation(String paymentId, CreateAuthorisationRequest request)
org.springframework.http.ResponseEntity<de.adorsys.psd2.consent.api.pis.CreatePisCommonPaymentResponse>	createCommonPayment(PisPaymentInfo request)
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.authorisation.Authorisation>	getAuthorisation(String authorisationId)
org.springframework.http.ResponseEntity<List<String>>	getAuthorisationCancellation(String authorisationId)
org.springframework.http.ResponseEntity<List<String>>	getAuthorisations(String paymentId)
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.sca.AuthorisationScaApproachResponse>	getAuthorisationScaApproach(String authorisationId)
org.springframework.http.ResponseEntity<List<String>>	getAuthorisationsCancellation(String paymentId)
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.sca.ScaStatus>	getAuthorisationScaStatus(String paymentId, String authorisationId)
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.sca.AuthorisationScaApproachResponse>	getCancellationAuthorisationScaApproach(String authorisationId)
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.sca.ScaStatus>	getCancellationAuthorisationScaStatus(String paymentId, String authorisationId)
org.springframework.http.ResponseEntity<PisCommonPaymentResponse>	getCommonPaymentById(String paymentId)
org.springframework.http.ResponseEntity<PisCommonPaymentDataStatusResponse>	getPisCommonPaymentStatusById(String paymentId)
org.springframework.http.ResponseEntity<Boolean>	isAuthenticationMethodDecoupled(String authorisationId, String authenticationMethodId)
org.springframework.http.ResponseEntity<Void>	saveAuthenticationMethods(String authorisationId, List<CmsScaMethod> methods)
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.authorisation.Authorisation>	updateAuthorisation(String authorisationId, UpdateAuthorisationRequest request)
org.springframework.http.ResponseEntity<Void>	updateAuthorisationStatus(String authorisationId, String authorisationStatus)
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.authorisation.Authorisation>	updateCancellationAuthorisation(String authorisationId, UpdateAuthorisationRequest request)
org.springframework.http.ResponseEntity<Void>	updateCommonPaymentStatus(String paymentId, String status)
org.springframework.http.ResponseEntity<Boolean>	updateMultilevelScaRequired(String paymentId, boolean multilevelSca)
org.springframework.http.ResponseEntity<Boolean>	updateScaApproach(String authorisationId, de.adorsys.psd2.xs2a.core.profile.ScaApproach scaApproach)

Method Detail

createCommonPayment

@PostMapping(path="/")
org.springframework.http.ResponseEntity<de.adorsys.psd2.consent.api.pis.CreatePisCommonPaymentResponse> createCommonPayment(@RequestBody
                                                                                                                                                   PisPaymentInfo request)

getPisCommonPaymentStatusById

@GetMapping(path="/{payment-id}/status")
org.springframework.http.ResponseEntity<PisCommonPaymentDataStatusResponse> getPisCommonPaymentStatusById(@PathVariable(value="payment-id")
                                                                                                                                                   String paymentId)

getCommonPaymentById

@GetMapping(path="/{payment-id}")
org.springframework.http.ResponseEntity<PisCommonPaymentResponse> getCommonPaymentById(@PathVariable(value="payment-id")
                                                                                                                         String paymentId)

updateCommonPaymentStatus

@PutMapping(path="/{payment-id}/status/{status}")
org.springframework.http.ResponseEntity<Void> updateCommonPaymentStatus(@PathVariable(value="payment-id")
                                                                                                                          String paymentId,
                                                                                                                          @PathVariable(value="status")
                                                                                                                          String status)

createAuthorisation

@PostMapping(path="/{payment-id}/authorisations")
org.springframework.http.ResponseEntity<CreateAuthorisationResponse> createAuthorisation(@PathVariable(value="payment-id")
                                                                                                                                           String paymentId,
                                                                                                                                           @RequestBody
                                                                                                                                           CreateAuthorisationRequest request)

createAuthorisationCancellation

@PostMapping(path="/{payment-id}/cancellation-authorisations")
org.springframework.http.ResponseEntity<CreateAuthorisationResponse> createAuthorisationCancellation(@PathVariable(value="payment-id")
                                                                                                                                                                    String paymentId,
                                                                                                                                                                    @RequestBody
                                                                                                                                                                    CreateAuthorisationRequest request)

updateAuthorisation

@PutMapping(path="/authorisations/{authorisation-id}")
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.authorisation.Authorisation> updateAuthorisation(@PathVariable(value="authorisation-id")
                                                                                                                                                                          String authorisationId,
                                                                                                                                                                          @RequestBody
                                                                                                                                                                          UpdateAuthorisationRequest request)

updateAuthorisationStatus

@PutMapping(path="authorisations/{authorisation-id}/status/{status}")
org.springframework.http.ResponseEntity<Void> updateAuthorisationStatus(@PathVariable(value="authorisation-id")
                                                                                                                                              String authorisationId,
                                                                                                                                              @PathVariable(value="status")
                                                                                                                                              String authorisationStatus)

getAuthorisation

@GetMapping(path="/authorisations/{authorisation-id}")
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.authorisation.Authorisation> getAuthorisation(@PathVariable(value="authorisation-id")
                                                                                                                                                                       String authorisationId)

getAuthorisationScaStatus

@GetMapping(path="/{payment-id}/authorisations/{authorisation-id}/status")
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.sca.ScaStatus> getAuthorisationScaStatus(@PathVariable(value="payment-id")
                                                                                                                                                                                      String paymentId,
                                                                                                                                                                                      @PathVariable(value="authorisation-id")
                                                                                                                                                                                      String authorisationId)

updateCancellationAuthorisation

@PutMapping(path="/cancellation-authorisations/{authorisation-id}")
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.authorisation.Authorisation> updateCancellationAuthorisation(@PathVariable(value="authorisation-id")
                                                                                                                                                                                                   String authorisationId,
                                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                                   UpdateAuthorisationRequest request)

getAuthorisationCancellation

@GetMapping(path="/cancellation-authorisations/{authorisation-id}")
org.springframework.http.ResponseEntity<List<String>> getAuthorisationCancellation(@PathVariable(value="authorisation-id")
                                                                                                                                                       String authorisationId)

getAuthorisationsCancellation

@GetMapping(path="/{payment-id}/cancellation-authorisations")
org.springframework.http.ResponseEntity<List<String>> getAuthorisationsCancellation(@PathVariable(value="payment-id")
                                                                                                                                                  String paymentId)

getCancellationAuthorisationScaStatus

@GetMapping(path="/{payment-id}/cancellation-authorisations/{authorisation-id}/status")
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.sca.ScaStatus> getCancellationAuthorisationScaStatus(@PathVariable(value="payment-id")
                                                                                                                                                                                                               String paymentId,
                                                                                                                                                                                                               @PathVariable(value="authorisation-id")
                                                                                                                                                                                                               String authorisationId)

getAuthorisations

@GetMapping(path="/{payment-id}/authorisations")
org.springframework.http.ResponseEntity<List<String>> getAuthorisations(@PathVariable(value="payment-id")
                                                                                                                         String paymentId)

isAuthenticationMethodDecoupled

@GetMapping(path="/authorisations/{authorisation-id}/authentication-methods/{authentication-method-id}")
org.springframework.http.ResponseEntity<Boolean> isAuthenticationMethodDecoupled(@PathVariable(value="authorisation-id")
                                                                                                                                                                                          String authorisationId,
                                                                                                                                                                                          @PathVariable(value="authentication-method-id")
                                                                                                                                                                                          String authenticationMethodId)

saveAuthenticationMethods

@PostMapping(path="/authorisations/{authorisation-id}/authentication-methods")
org.springframework.http.ResponseEntity<Void> saveAuthenticationMethods(@PathVariable(value="authorisation-id")
                                                                                                                                                       String authorisationId,
                                                                                                                                                       @RequestBody
                                                                                                                                                       List<CmsScaMethod> methods)

updateScaApproach

@PutMapping(path="/authorisations/{authorisation-id}/sca-approach/{sca-approach}")
org.springframework.http.ResponseEntity<Boolean> updateScaApproach(@PathVariable(value="authorisation-id")
                                                                                                                                                      String authorisationId,
                                                                                                                                                      @PathVariable(value="sca-approach")
                                                                                                                                                      de.adorsys.psd2.xs2a.core.profile.ScaApproach scaApproach)

getAuthorisationScaApproach

@GetMapping(path="/authorisations/{authorisation-id}/sca-approach")
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.sca.AuthorisationScaApproachResponse> getAuthorisationScaApproach(@PathVariable(value="authorisation-id")
                                                                                                                                                                                                        String authorisationId)

getCancellationAuthorisationScaApproach

@GetMapping(path="/cancellation-authorisations/{authorisation-id}/sca-approach")
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.sca.AuthorisationScaApproachResponse> getCancellationAuthorisationScaApproach(@PathVariable(value="authorisation-id")
                                                                                                                                                                                                                                 String authorisationId)

updateMultilevelScaRequired

@PutMapping(path="/{payment-id}/multilevel-sca")
org.springframework.http.ResponseEntity<Boolean> updateMultilevelScaRequired(@PathVariable(name="payment-id")
                                                                                                                              String paymentId,
                                                                                                                              @RequestParam(value="multilevel-sca",defaultValue="false")
                                                                                                                              boolean multilevelSca)