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

Interface PisCancellationApi

public interface PisCancellationApi

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_PATH

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<PaymentAuthorizeResponse>	authorisePayment(String encryptedPaymentId, String authorisationId, String consentAndaccessTokenCookieString, String authCode) Provides a TAN for the validation of an authorization
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<PaymentAuthorizeResponse>	pisDone(String encryptedPaymentId, String authorisationId, String consentAndAccessTokenCookieString, Boolean forgetConsent, Boolean backToTpp) 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

login

@PostMapping(path="/{encryptedPaymentId}/authorisation/{authorisationId}/login")
org.springframework.http.ResponseEntity<PaymentAuthorizeResponse> login(@PathVariable(value="encryptedPaymentId")
                                                                                                                                                         String encryptedPaymentId,
                                                                                                                                                         @PathVariable(value="authorisationId")
                                                                                                                                                         String authorisationId,
                                                                                                                                                         @RequestParam(value="login")
                                                                                                                                                         String login,
                                                                                                                                                         @RequestParam(value="pin")
                                                                                                                                                         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

selectMethod

@PostMapping(value="/{encryptedPaymentId}/authorisation/{authorisationId}/methods/{scaMethodId}")
org.springframework.http.ResponseEntity<PaymentAuthorizeResponse> selectMethod(@PathVariable(value="encryptedPaymentId")
                                                                                                                                                                                 String encryptedPaymentId,
                                                                                                                                                                                 @PathVariable(value="authorisationId")
                                                                                                                                                                                 String authorisationId,
                                                                                                                                                                                 @PathVariable(value="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

authorisePayment

@PostMapping(path="/{encryptedPaymentId}/authorisation/{authorisationId}/authCode",
             params="authCode")
org.springframework.http.ResponseEntity<PaymentAuthorizeResponse> authorisePayment(@PathVariable(value="encryptedPaymentId")
                                                                                                                                                                                                       String encryptedPaymentId,
                                                                                                                                                                                                       @PathVariable(value="authorisationId")
                                                                                                                                                                                                       String authorisationId,
                                                                                                                                                                                                       @RequestHeader(name="Cookie",required=false)
                                                                                                                                                                                                       String consentAndaccessTokenCookieString,
                                                                                                                                                                                                       @RequestParam(value="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

pisDone

@GetMapping(path="/{encryptedPaymentId}/authorisation/{authorisationId}/done",
            params={"forgetConsent","backToTpp"})
org.springframework.http.ResponseEntity<PaymentAuthorizeResponse> pisDone(@PathVariable(value="encryptedPaymentId")
                                                                                                                                                                                                           String encryptedPaymentId,
                                                                                                                                                                                                           @PathVariable(value="authorisationId")
                                                                                                                                                                                                           String authorisationId,
                                                                                                                                                                                                           @RequestHeader(name="Cookie",required=false)
                                                                                                                                                                                                           String consentAndAccessTokenCookieString,
                                                                                                                                                                                                           @RequestParam(name="forgetConsent",required=false)
                                                                                                                                                                                                           Boolean forgetConsent,
                                                                                                                                                                                                           @RequestParam(name="backToTpp",required=false)
                                                                                                                                                                                                           Boolean backToTpp)

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