```
public interface PISApi
```

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<PaymentAuthorizeResponse>`	`authrizedPayment(String encryptedPaymentId, String authorisationId, String consentAndaccessTokenCookieString, String authCode)`	Provides a TAN for the validation of an authorization
`org.springframework.http.ResponseEntity<PaymentAuthorizeResponse>`	`failPaymentAuthorisation(String encryptedPaymentId, String authorisationId, String cookieString)`	Fails PIS authorisation object by its ID.
`org.springframework.http.ResponseEntity<PaymentAuthorizeResponse>`	`initiatePayment(String encryptedPaymentId, String authorisationId, String consentAndaccessTokenCookieString)`	Calls the consent validation page.
`org.springframework.http.ResponseEntity<PaymentAuthorizeResponse>`	`login(String encryptedPaymentId, String authorisationId, String login, String pin, String consentCookieString)`	Identifies the user by login an pin.
`org.springframework.http.ResponseEntity<AuthorizeResponse>`	`pisAuth(String redirectId, String encryptedPaymentId, String token)`	STEP-P0: payment Entry Point
`org.springframework.http.ResponseEntity<PaymentAuthorizeResponse>`	`pisDone(String encryptedPaymentId, String authorisationId, String consentAndAccessTokenCookieString, boolean isOauth2Integrated, String authConfirmationCode)`	This call provides the server with the opportunity to close this session and redirect the PSU to the TPP or close the application window.
`org.springframework.http.ResponseEntity<PaymentAuthorizeResponse>`	`selectMethod(String encryptedPaymentId, String authorisationId, String scaMethodId, String consentAndaccessTokenCookieString)`	Selects the SCA Method for use.

Field Detail
- BASE_PATH
```
static final String BASE_PATH
```
  See Also:
  
  Constant Field Values

Method Detail

pisAuth

@GetMapping(path="/auth",
            params={"redirectId","encryptedPaymentId"})
org.springframework.http.ResponseEntity<AuthorizeResponse> pisAuth(@RequestParam(name="redirectId")
                                                                   String redirectId,
                                                                   @RequestParam(name="encryptedPaymentId")
                                                                   String encryptedPaymentId,
                                                                   @RequestHeader(name="Authorization",required=false)
                                                                   String token)

STEP-P0: payment Entry Point

Receptions a payment authorization link. Generate an eca-id associated with the login process.

Parameters:: redirectId - the redirect is; encryptedPaymentId - the enc payment idf
Returns:: AuthorizeResponse

login

@PostMapping(path="/{encryptedPaymentId}/authorisation/{authorisationId}/login")
org.springframework.http.ResponseEntity<PaymentAuthorizeResponse> login(@PathVariable("encryptedPaymentId")
                                                                        String encryptedPaymentId,
                                                                        @PathVariable("authorisationId")
                                                                        String authorisationId,
                                                                        @RequestParam(value="login",required=false)
                                                                        String login,
                                                                        @RequestParam(value="pin",required=false)
                                                                        String pin,
                                                                        @RequestHeader(name="Cookie",required=false)
                                                                        String consentCookieString)

Identifies the user by login an pin. Return sca methods information

Parameters:: encryptedPaymentId - the encryptedPaymentId; authorisationId - the auth id; login - the login; pin - the password; consentCookieString - the cosent cookie
Returns:: PaymentAuthorizeResponse

initiatePayment

@PostMapping(path="/{encryptedPaymentId}/authorisation/{authorisationId}/initiate")
org.springframework.http.ResponseEntity<PaymentAuthorizeResponse> initiatePayment(@PathVariable("encryptedPaymentId")
                                                                                  String encryptedPaymentId,
                                                                                  @PathVariable("authorisationId")
                                                                                  String authorisationId,
                                                                                  @RequestHeader(name="Cookie",required=false)
                                                                                  String consentAndaccessTokenCookieString)

Calls the consent validation page.

Parameters:: encryptedPaymentId - the sca id; authorisationId - the auth id; consentAndaccessTokenCookieString - the cosent cookie
Returns:: PaymentAuthorizeResponse

selectMethod

@PostMapping("/{encryptedPaymentId}/authorisation/{authorisationId}/methods/{scaMethodId}")
org.springframework.http.ResponseEntity<PaymentAuthorizeResponse> selectMethod(@PathVariable("encryptedPaymentId")
                                                                               String encryptedPaymentId,
                                                                               @PathVariable("authorisationId")
                                                                               String authorisationId,
                                                                               @PathVariable("scaMethodId")
                                                                               String scaMethodId,
                                                                               @RequestHeader(name="Cookie",required=false)
                                                                               String consentAndaccessTokenCookieString)

Selects the SCA Method for use.

Parameters:: encryptedPaymentId - the sca id; authorisationId - the auth id; scaMethodId - sca; consentAndaccessTokenCookieString - the cosent cookie
Returns:: PaymentAuthorizeResponse

authrizedPayment

@PostMapping(path="/{encryptedPaymentId}/authorisation/{authorisationId}/authCode",
             params="authCode")
org.springframework.http.ResponseEntity<PaymentAuthorizeResponse> authrizedPayment(@PathVariable("encryptedPaymentId")
                                                                                   String encryptedPaymentId,
                                                                                   @PathVariable("authorisationId")
                                                                                   String authorisationId,
                                                                                   @RequestHeader(name="Cookie",required=false)
                                                                                   String consentAndaccessTokenCookieString,
                                                                                   @RequestParam("authCode")
                                                                                   String authCode)

Provides a TAN for the validation of an authorization

Parameters:: encryptedPaymentId - the sca id; authorisationId - the auth id; consentAndaccessTokenCookieString - the cosent cookie; authCode - the auth code
Returns:: PaymentAuthorizeResponse

failPaymentAuthorisation

@DeleteMapping(path="/{encryptedPaymentId}/{authorisationId}")
org.springframework.http.ResponseEntity<PaymentAuthorizeResponse> failPaymentAuthorisation(@PathVariable("encryptedPaymentId")
                                                                                           String encryptedPaymentId,
                                                                                           @PathVariable("authorisationId")
                                                                                           String authorisationId,
                                                                                           @RequestHeader(name="Cookie",required=false)
                                                                                           String cookieString)

Fails PIS authorisation object by its ID.

Parameters:: encryptedPaymentId - ID of Payment
Returns:: true if payment authorisation was found and failed. false otherwise.

pisDone

@GetMapping(path="/{encryptedPaymentId}/authorisation/{authorisationId}/done")
org.springframework.http.ResponseEntity<PaymentAuthorizeResponse> pisDone(@PathVariable("encryptedPaymentId")
                                                                          String encryptedPaymentId,
                                                                          @PathVariable("authorisationId")
                                                                          String authorisationId,
                                                                          @RequestHeader(name="Cookie",required=false)
                                                                          String consentAndAccessTokenCookieString,
                                                                          @RequestParam(name="oauth2",required=false,defaultValue="false")
                                                                          boolean isOauth2Integrated,
                                                                          @RequestParam(name="authConfirmationCode",required=false)
                                                                          String authConfirmationCode)

This call provides the server with the opportunity to close this session and redirect the PSU to the TPP or close the application window.

In any case, the session of the user will be closed and cookies will be deleted.

Parameters:: encryptedPaymentId - ID of Payment; authorisationId - ID of related Payment Authorisation
Returns:: redirect location header with TPP url

Interface PISApi

Field Summary