Skip to content

adorsys/xs2a-client-adapter

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

103 Commits
.github/workflows
.github/workflows
 
 
.swagger-codegen
.swagger-codegen
 
 
.travis
.travis
 
 
docs
docs
 
 
gradle/wrapper
gradle/wrapper
 
 
release-scripts @ 0897923
release-scripts @ 0897923
 
 
src/main
src/main
 
 
.gitignore
.gitignore
 
 
.gitmodules
.gitmodules
 
 
.release-scripts-hooks.sh
.release-scripts-hooks.sh
 
 
.swagger-codegen-ignore
.swagger-codegen-ignore
 
 
.travis.yml
.travis.yml
 
 
README.md
README.md
 
 
build.gradle
build.gradle
 
 
build.sbt
build.sbt
 
 
git_push.sh
git_push.sh
 
 
gradle.properties
gradle.properties
 
 
gradlew
gradlew
 
 
gradlew.bat
gradlew.bat
 
 
maven_release_settings.xml
maven_release_settings.xml
 
 
pom.xml
pom.xml
 
 
settings.gradle
settings.gradle
 
 

Repository files navigation

swagger-java-client

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountInformationServiceAisApi;

import java.io.File;
import java.util.*;

public class AccountInformationServiceAisApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BearerAuthOAuth
        HttpBasicAuth BearerAuthOAuth = (HttpBasicAuth) defaultClient.getAuthentication("BearerAuthOAuth");
        BearerAuthOAuth.setUsername("YOUR USERNAME");
        BearerAuthOAuth.setPassword("YOUR PASSWORD");
        
        

        AccountInformationServiceAisApi apiInstance = new AccountInformationServiceAisApi();
        
        UUID xRequestID = Arrays.asList(new UUID()); // UUID | ID of the request, unique to the call, as determined by the initiating party.
        
        Consents body = new Consents(); // Consents | Requestbody for a consents request

        
        String digest = Arrays.asList("digest_example"); // String | Is contained if and only if the \"Signature\" element is contained in the header of the request.
        
        String signature = Arrays.asList("signature_example"); // String | A signature of the request by the TPP on application level. This might be mandated by ASPSP. 
        
        byte[] tpPSignatureCertificate = Arrays.asList(B); // byte[] | The certificate used for signing the request, in base64 encoding.  Must be contained if a signature is contained. 
        
        String PSU_ID = Arrays.asList("PSU_ID_example"); // String | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceeding AIS service in the same session. 
        
        String psUIDType = Arrays.asList("psUIDType_example"); // String | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. 
        
        String psUCorporateID = Arrays.asList("psUCorporateID_example"); // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context. 
        
        String psUCorporateIDType = Arrays.asList("psUCorporateIDType_example"); // String | Might be mandated in the ASPSP's documentation. Only used in a corporate context. 
        
        Boolean tpPRedirectPreferred = Arrays.asList(true); // Boolean | If it equals \"true\", the TPP prefers a redirect over an embedded SCA approach. If it equals \"false\", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. 
        
        String tpPRedirectURI = Arrays.asList("tpPRedirectURI_example"); // String | URI of the TPP, where the transaction flow shall be redirected to after a Redirect.  Mandated for the Redirect SCA Approach (including OAuth2 SCA approach), specifically  when TPP-Redirect-Preferred equals \"true\". It is recommended to always use this header field.  **Remark for Future:**  This field might be changed to mandatory in the next version of the specification. 
        
        String tpPNokRedirectURI = Arrays.asList("tpPNokRedirectURI_example"); // String | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. 
        
        Boolean tpPExplicitAuthorisationPreferred = Arrays.asList(true); // Boolean | If it equals \"true\", the TPP prefers to start the authorisation process separately,  e.g. because of the usage of a signing basket.  This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality.  If it equals \"false\" or if the parameter is not used, there is no preference of the TPP.  This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step,  without using a signing basket. 
        
        String psUIPAddress = Arrays.asList("psUIPAddress_example"); // String | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. 
        
        Object psUIPPort = null; // Object | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. 
        
        String psUAccept = Arrays.asList("psUAccept_example"); // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. 
        
        String psUAcceptCharset = Arrays.asList("psUAcceptCharset_example"); // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. 
        
        String psUAcceptEncoding = Arrays.asList("psUAcceptEncoding_example"); // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. 
        
        String psUAcceptLanguage = Arrays.asList("psUAcceptLanguage_example"); // String | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. 
        
        String psUUserAgent = Arrays.asList("psUUserAgent_example"); // String | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. 
        
        String psUHttpMethod = Arrays.asList("psUHttpMethod_example"); // String | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE 
        
        UUID psUDeviceID = Arrays.asList(new UUID()); // UUID | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device. 
        
        String psUGeoLocation = Arrays.asList("psUGeoLocation_example"); // String | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. 
        
        try {
            apiInstance.createConsent(xRequestID, body, digest, signature, tpPSignatureCertificate, PSU_ID, psUIDType, psUCorporateID, psUCorporateIDType, tpPRedirectPreferred, tpPRedirectURI, tpPNokRedirectURI, tpPExplicitAuthorisationPreferred, psUIPAddress, psUIPPort, psUAccept, psUAcceptCharset, psUAcceptEncoding, psUAcceptLanguage, psUUserAgent, psUHttpMethod, psUDeviceID, psUGeoLocation);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountInformationServiceAisApi#createConsent");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.testbank.com/psd2

Class Method HTTP request Description
AccountInformationServiceAisApi createConsent POST /v1/consents Create consent
AccountInformationServiceAisApi deleteConsent DELETE /v1/consents/{consentId} Delete Consent
AccountInformationServiceAisApi getAccountList GET /v1/accounts Read Account List
AccountInformationServiceAisApi getBalances GET /v1/accounts/{account-id}/balances Read Balance
AccountInformationServiceAisApi getConsentInformation GET /v1/consents/{consentId} Get Consent Request
AccountInformationServiceAisApi getConsentScaStatus GET /v1/consents/{consentId}/authorisations/{authorisationId} Read the SCA status of the consent authorisation.
AccountInformationServiceAisApi getConsentStatus GET /v1/consents/{consentId}/status Consent status request
AccountInformationServiceAisApi getTransactionDetails GET /v1/accounts/{account-id}/transactions/{resourceId} Read Transaction Details
AccountInformationServiceAisApi getTransactionList GET /v1/accounts/{account-id}/transactions/ Read Transaction List
AccountInformationServiceAisApi readAccountDetails GET /v1/accounts/{account-id} Read Account Details
AccountInformationServiceAisApi startConsentAuthorisation POST /v1/consents/{consentId}/authorisations Start the authorisation process for a consent
AccountInformationServiceAisApi updateConsentsPsuData PUT /v1/consents/{consentId}/authorisations/{authorisationId} Update PSU Data for consents
CommonAisAndPisServicesApi getConsentScaStatus GET /v1/consents/{consentId}/authorisations/{authorisationId} Read the SCA status of the consent authorisation.
CommonAisAndPisServicesApi getPaymentCancellationScaStatus GET /v1/{payment-service}/{paymentId}/cancellation-authorisations/{cancellationId} Read the SCA status of the payment cancellation's authorisation.
CommonAisAndPisServicesApi getPaymentInitiationAuthorisation GET /v1/{payment-service}/{paymentId}/authorisations Get Payment Initiation Authorisation Sub-Resources Request
CommonAisAndPisServicesApi getPaymentInitiationAuthorisation_0 GET /v1/signing-baskets/{basketId}/authorisations Get Signing Basket Authorisation Sub-Resources Request
CommonAisAndPisServicesApi getPaymentInitiationScaStatus GET /v1/{payment-service}/{paymentId}/authorisations/{authorisationId} Read the SCA Status of the payment authorisation
CommonAisAndPisServicesApi getSigningBasketScaStatus GET /v1/signing-baskets/{basketId}/authorisations/{authorisationId} Read the SCA status of the signing basket authorisation
CommonAisAndPisServicesApi startConsentAuthorisation POST /v1/consents/{consentId}/authorisations Start the authorisation process for a consent
CommonAisAndPisServicesApi startPaymentAuthorisation POST /v1/{payment-service}/{paymentId}/authorisations Start the authorisation process for a payment initiation
CommonAisAndPisServicesApi startPaymentInitiationCancellationAuthorisation POST /v1/{payment-service}/{paymentId}/cancellation-authorisations Start the authorisation process for the cancellation of the addressed payment
CommonAisAndPisServicesApi startSigningBasketAuthorisation POST /v1/signing-baskets/{basketId}/authorisations Start the authorisation process for a signing basket
CommonAisAndPisServicesApi updateConsentsPsuData PUT /v1/consents/{consentId}/authorisations/{authorisationId} Update PSU Data for consents
CommonAisAndPisServicesApi updatePaymentCancellationPsuData PUT /v1/{payment-service}/{paymentId}/cancellation-authorisations/{cancellationId} Update PSU Data for payment initiation cancellation
CommonAisAndPisServicesApi updatePaymentPsuData PUT /v1/{payment-service}/{paymentId}/authorisations/{authorisationId} Update PSU data for payment initiation
CommonAisAndPisServicesApi updateSigningBasketPsuData PUT /v1/signing-baskets/{basketId}/authorisations/{authorisationId} Update PSU Data for signing basket
ConfirmationOfFundsServiceApi checkAvailabilityOfFunds POST /v1/funds-confirmations Confirmation of Funds Request
PaymentInitiationServicePisApi cancelPayment DELETE /v1/{payment-service}/{paymentId} Payment Cancellation Request
PaymentInitiationServicePisApi getPaymentCancellationScaStatus GET /v1/{payment-service}/{paymentId}/cancellation-authorisations/{cancellationId} Read the SCA status of the payment cancellation's authorisation.
PaymentInitiationServicePisApi getPaymentInformation GET /v1/{payment-service}/{paymentId} Get Payment Information
PaymentInitiationServicePisApi getPaymentInitiationAuthorisation GET /v1/{payment-service}/{paymentId}/authorisations Get Payment Initiation Authorisation Sub-Resources Request
PaymentInitiationServicePisApi getPaymentInitiationAuthorisation_0 GET /v1/consents/{consentId}/authorisations Get Consent Authorisation Sub-Resources Request
PaymentInitiationServicePisApi getPaymentInitiationCancellationAuthorisationInformation GET /v1/{payment-service}/{paymentId}/cancellation-authorisations Will deliver an array of resource identifications to all generated cancellation authorisation sub-resources.
PaymentInitiationServicePisApi getPaymentInitiationScaStatus GET /v1/{payment-service}/{paymentId}/authorisations/{authorisationId} Read the SCA Status of the payment authorisation
PaymentInitiationServicePisApi getPaymentInitiationStatus GET /v1/{payment-service}/{paymentId}/status Payment initiation status request
PaymentInitiationServicePisApi initiatePayment POST /v1/{payment-service}/{payment-product} Payment initiation request
PaymentInitiationServicePisApi startPaymentAuthorisation POST /v1/{payment-service}/{paymentId}/authorisations Start the authorisation process for a payment initiation
PaymentInitiationServicePisApi startPaymentInitiationCancellationAuthorisation POST /v1/{payment-service}/{paymentId}/cancellation-authorisations Start the authorisation process for the cancellation of the addressed payment
PaymentInitiationServicePisApi updatePaymentCancellationPsuData PUT /v1/{payment-service}/{paymentId}/cancellation-authorisations/{cancellationId} Update PSU Data for payment initiation cancellation
PaymentInitiationServicePisApi updatePaymentPsuData PUT /v1/{payment-service}/{paymentId}/authorisations/{authorisationId} Update PSU data for payment initiation
SigningBasketsApi createSigningBasket POST /v1/signing-baskets Create a signing basket resource
SigningBasketsApi getPaymentInitiationAuthorisation GET /v1/signing-baskets/{basketId}/authorisations Get Signing Basket Authorisation Sub-Resources Request
SigningBasketsApi getSigningBasket GET /v1/signing-baskets/{basketId} Returns the content of an signing basket object.
SigningBasketsApi getSigningBasketScaStatus GET /v1/signing-baskets/{basketId}/authorisations/{authorisationId} Read the SCA status of the signing basket authorisation
SigningBasketsApi startSigningBasketAuthorisation POST /v1/signing-baskets/{basketId}/authorisations Start the authorisation process for a signing basket
SigningBasketsApi updateSigningBasketPsuData PUT /v1/signing-baskets/{basketId}/authorisations/{authorisationId} Update PSU Data for signing basket

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

BearerAuthOAuth

  • Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

info@berlin-group.org

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

3 stars

Watchers

9 watching

Forks

1 fork
Report repository

Releases

15 tags

Packages

No packages published

Contributors 2

  •  
  •  

Languages