PolishAPI

AIS

deleteConsent

Removes consent

Removes consent


/v1.0/accounts/v1.0/deleteConsent

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/accounts/v1.0/deleteConsent"
import .*;
import .auth.*;
import .model.*;
import .api.AISApi;

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

public class AISApiExample {

    public static void main(String[] args) {
        
        AISApi apiInstance = new AISApi();
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        DeleteConsentRequest deleteConsentRequest = ; // DeleteConsentRequest | Data for delete Consent Request
        try {
            apiInstance.deleteConsent(acceptEncoding, acceptLanguage, acceptCharset, deleteConsentRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#deleteConsent");
            e.printStackTrace();
        }
    }
}
import .api.AISApi;

public class AISApiExample {

    public static void main(String[] args) {
        AISApi apiInstance = new AISApi();
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        DeleteConsentRequest deleteConsentRequest = ; // DeleteConsentRequest | Data for delete Consent Request
        try {
            apiInstance.deleteConsent(acceptEncoding, acceptLanguage, acceptCharset, deleteConsentRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#deleteConsent");
            e.printStackTrace();
        }
    }
}
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
DeleteConsentRequest *deleteConsentRequest = ; // Data for delete Consent Request

AISApi *apiInstance = [[AISApi alloc] init];

// Removes consent
[apiInstance deleteConsentWith:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    deleteConsentRequest:deleteConsentRequest
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');

var api = new PolishApi.AISApi()

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var deleteConsentRequest = ; // {DeleteConsentRequest} Data for delete Consent Request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteConsent(acceptEncoding, acceptLanguage, acceptCharset, deleteConsentRequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class deleteConsentExample
    {
        public void main()
        {
            
            var apiInstance = new AISApi();
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var deleteConsentRequest = new DeleteConsentRequest(); // DeleteConsentRequest | Data for delete Consent Request

            try
            {
                // Removes consent
                apiInstance.deleteConsent(acceptEncoding, acceptLanguage, acceptCharset, deleteConsentRequest);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AISApi.deleteConsent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AISApi();
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$deleteConsentRequest = ; // DeleteConsentRequest | Data for delete Consent Request

try {
    $api_instance->deleteConsent($acceptEncoding, $acceptLanguage, $acceptCharset, $deleteConsentRequest);
} catch (Exception $e) {
    echo 'Exception when calling AISApi->deleteConsent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::AISApi;

my $api_instance = ::AISApi->new();
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $deleteConsentRequest = ::Object::DeleteConsentRequest->new(); # DeleteConsentRequest | Data for delete Consent Request

eval { 
    $api_instance->deleteConsent(acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, deleteConsentRequest => $deleteConsentRequest);
};
if ($@) {
    warn "Exception when calling AISApi->deleteConsent: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = .AISApi()
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
deleteConsentRequest =  # DeleteConsentRequest | Data for delete Consent Request

try: 
    # Removes consent
    api_instance.delete_consent(acceptEncoding, acceptLanguage, acceptCharset, deleteConsentRequest)
except ApiException as e:
    print("Exception when calling AISApi->deleteConsent: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
Body parameters
Name Description
deleteConsentRequest *
{

Klasa zapytania o usunięcie zgody na dostęp do AIS

Required: consentId
consentId:
string

Identyfikator zgody / Consent ID

}

Responses

Status: 200 - Success

Name Type Format Description
Content-Encoding String Gzip, deflate

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

getAccount

Get detailed information about user payment account

User identification based on access token


/v1.0/accounts/v1.0/getAccount

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/accounts/v1.0/getAccount"
import .*;
import .auth.*;
import .model.*;
import .api.AISApi;

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

public class AISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        AccountInfoRequest getAccountRequest = ; // AccountInfoRequest | Data for Account Request
        try {
            AccountResponse result = apiInstance.getAccount(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getAccountRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getAccount");
            e.printStackTrace();
        }
    }
}
import .api.AISApi;

public class AISApiExample {

    public static void main(String[] args) {
        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        AccountInfoRequest getAccountRequest = ; // AccountInfoRequest | Data for Account Request
        try {
            AccountResponse result = apiInstance.getAccount(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getAccountRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
AccountInfoRequest *getAccountRequest = ; // Data for Account Request

AISApi *apiInstance = [[AISApi alloc] init];

// Get detailed information about user payment account
[apiInstance getAccountWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    getAccountRequest:getAccountRequest
              completionHandler: ^(AccountResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.AISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var getAccountRequest = ; // {AccountInfoRequest} Data for Account Request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccount(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getAccountRequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class getAccountExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var getAccountRequest = new AccountInfoRequest(); // AccountInfoRequest | Data for Account Request

            try
            {
                // Get detailed information about user payment account
                AccountResponse result = apiInstance.getAccount(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getAccountRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AISApi.getAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$getAccountRequest = ; // AccountInfoRequest | Data for Account Request

try {
    $result = $api_instance->getAccount($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $getAccountRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AISApi->getAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::AISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::AISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $getAccountRequest = ::Object::AccountInfoRequest->new(); # AccountInfoRequest | Data for Account Request

eval { 
    my $result = $api_instance->getAccount(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, getAccountRequest => $getAccountRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AISApi->getAccount: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .AISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
getAccountRequest =  # AccountInfoRequest | Data for Account Request

try: 
    # Get detailed information about user payment account
    api_response = api_instance.get_account(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getAccountRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AISApi->getAccount: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
getAccountRequest *
{

Klasa zapytania o pojedynczy rachunek / Account Information Request Class

Required: accountNumber,requestHeader
requestHeader:
{

Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class

Required: token
isDirectPsu:
token:
tppId:
sendDate:
ipAddress:
userAgent:
requestId:
}
accountNumber:
string

Numer rachunku / Account number

}

Responses

Status: 200 - Success

{

Klasa odpowiedzi na zapytania o konto PSU / PSU's Account Response Class

Required: responseHeader
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
account:
{

Klasa informacji o koncie / Account Information Class

Required: accountNumber,nameAddress
accountNumber:
string

Numer rachunku / Account number

nameAddress:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
address:
}
accountType:
{

Klasa zawierająca dane elementu/pozycji słownika / Dictionary Item Class

code:
description:
}
accountTypeName:
string maxLength:32

Nazwa typu rachunku (definiowana przez Bank) / Account's type name (defined by ASPSP)

accountNameClient:
string maxLength:32

Nazwa konta ustawiona przez klienta / Account name set by the client

currency:
string maxLength:3

Waluta rachunku / Currency

availableBalance:
string

Dostępne środki - po wykonaniu transakcji / Available funds

bookingBalance:
string

Saldo księgowe rachunku - po wykonaniu transakcji / Book balance of the account

bank:
{

Klasa zawierająca dane banku / Bank Data Class

bicOrSwift:
name:
address:
}
auxData:
{

Klasa mapy / Map (Dictionary) class

}
}
}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

getAccounts

Get information about all user's payment account

User identification based on access token


/v1.0/accounts/v1.0/getAccounts

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/accounts/v1.0/getAccounts"
import .*;
import .auth.*;
import .model.*;
import .api.AISApi;

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

public class AISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        AccountsRequest getAccountsRequest = ; // AccountsRequest | Data for Accounts Request
        try {
            AccountsResponse result = apiInstance.getAccounts(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getAccountsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getAccounts");
            e.printStackTrace();
        }
    }
}
import .api.AISApi;

public class AISApiExample {

    public static void main(String[] args) {
        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        AccountsRequest getAccountsRequest = ; // AccountsRequest | Data for Accounts Request
        try {
            AccountsResponse result = apiInstance.getAccounts(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getAccountsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getAccounts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
AccountsRequest *getAccountsRequest = ; // Data for Accounts Request

AISApi *apiInstance = [[AISApi alloc] init];

// Get information about all user's payment account
[apiInstance getAccountsWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    getAccountsRequest:getAccountsRequest
              completionHandler: ^(AccountsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.AISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var getAccountsRequest = ; // {AccountsRequest} Data for Accounts Request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccounts(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getAccountsRequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class getAccountsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var getAccountsRequest = new AccountsRequest(); // AccountsRequest | Data for Accounts Request

            try
            {
                // Get information about all user's payment account
                AccountsResponse result = apiInstance.getAccounts(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getAccountsRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AISApi.getAccounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$getAccountsRequest = ; // AccountsRequest | Data for Accounts Request

try {
    $result = $api_instance->getAccounts($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $getAccountsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AISApi->getAccounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::AISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::AISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $getAccountsRequest = ::Object::AccountsRequest->new(); # AccountsRequest | Data for Accounts Request

eval { 
    my $result = $api_instance->getAccounts(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, getAccountsRequest => $getAccountsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AISApi->getAccounts: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .AISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
getAccountsRequest =  # AccountsRequest | Data for Accounts Request

try: 
    # Get information about all user's payment account
    api_response = api_instance.get_accounts(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getAccountsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AISApi->getAccounts: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
getAccountsRequest *
{

Klasa zapytania o rachunki / Accounts Request Class

Required: requestHeader
requestHeader:
{

Klasa zawierająca informacje o PSU / PSU Information Class

requestId:
userAgent:
ipAddress:
sendDate:
tppId:
}
isDirectPsu:
boolean

Znacznik informujący czy request jest przesłany bezpośrednio przez PSU / Is request sent by PSU directly

pageId:
string

Używane w celu stronicowania danych: numer rachunku rozpoczynający stronę / Account number beginning the page (paging info)

perPage:
number (int32)

Używane w celu stronicowania danych: wielkość strony danych / Page size (paging info)

}

Responses

Status: 200 - Success

{

Klasa odpowiedzi na zapytania o wiele kont PSU / PSU's Multiple Accounts Response Class

Required: responseHeader
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
accounts:
[
{

Klasa informacji o koncie / Account Information Class

Required: accountNumber,accountType,accountTypeName
accountNumber:
string

Numer rachunku (częściowo zamaskowany) / Account number (partly masked)

accountTypeName:
string

Nazwa typu rachunku / Account type name

accountType:
string

Typ rachunku / Account type

}
]
pageInfo:
{

Klasa zawierająca dane pozwalajace na korzystanie z mechanizmu stronicowania / Paging Information Class

previousPage:
string

Użyte w celu stronicowania danych: poprzednia strona (np: numer konta lub transakcji rozpoczynający poprzednią stronę) / Previous page

nextPage:
string

Użyte w celu stronicowania danych: następna strona (np: numer konta lub transakcji rozpoczynający następną stronę) / Next page

}
}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

getHolds

Get list of user's holded operations


/v1.0/accounts/v1.0/getHolds

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/accounts/v1.0/getHolds"
import .*;
import .auth.*;
import .model.*;
import .api.AISApi;

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

public class AISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        TransactionHoldRequest getHoldsRequest = ; // TransactionHoldRequest | Data for hold Request
        try {
            TransactionHoldInfoResponse result = apiInstance.getHolds(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getHoldsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getHolds");
            e.printStackTrace();
        }
    }
}
import .api.AISApi;

public class AISApiExample {

    public static void main(String[] args) {
        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        TransactionHoldRequest getHoldsRequest = ; // TransactionHoldRequest | Data for hold Request
        try {
            TransactionHoldInfoResponse result = apiInstance.getHolds(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getHoldsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getHolds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
TransactionHoldRequest *getHoldsRequest = ; // Data for hold Request

AISApi *apiInstance = [[AISApi alloc] init];

// Get list of user's holded operations
[apiInstance getHoldsWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    getHoldsRequest:getHoldsRequest
              completionHandler: ^(TransactionHoldInfoResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.AISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var getHoldsRequest = ; // {TransactionHoldRequest} Data for hold Request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHolds(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getHoldsRequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class getHoldsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var getHoldsRequest = new TransactionHoldRequest(); // TransactionHoldRequest | Data for hold Request

            try
            {
                // Get list of user's holded operations
                TransactionHoldInfoResponse result = apiInstance.getHolds(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getHoldsRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AISApi.getHolds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$getHoldsRequest = ; // TransactionHoldRequest | Data for hold Request

try {
    $result = $api_instance->getHolds($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $getHoldsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AISApi->getHolds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::AISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::AISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $getHoldsRequest = ::Object::TransactionHoldRequest->new(); # TransactionHoldRequest | Data for hold Request

eval { 
    my $result = $api_instance->getHolds(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, getHoldsRequest => $getHoldsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AISApi->getHolds: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .AISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
getHoldsRequest =  # TransactionHoldRequest | Data for hold Request

try: 
    # Get list of user's holded operations
    api_response = api_instance.get_holds(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getHoldsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AISApi->getHolds: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
getHoldsRequest *
{

Klasa zapytania o transakcje / Transaction Information Request Class

Required: accountNumber,requestHeader
type:
string

Element filtru: transakcji / Filter element

Enum: DEBIT
requestHeader:
{

Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class

Required: token
isDirectPsu:
token:
tppId:
sendDate:
ipAddress:
userAgent:
requestId:
}
accountNumber:
string

Numer rachunku / Account number

transactionIdFrom:
string maxLength:64

Element filtru: transacje od podanego identyfikatora transakcji / Filter element

transactionDateFrom:
string (date)

Element filtru: data transakcji od, YYYY-MM-DD / Filter element

transactionDateTo:
string (date)

Element filtru: data transakcji do, YYYY-MM-DD / Filter element

bookingDateFrom:
string (date)

Element filtru: data księgowania od, YYYY-MM-DD / Filter element

bookingDateTo:
string (date)

Element filtru: data księgowania do, YYYY-MM-DD / Filter element

minAmount:
string

Element filtru: kwota od / Filter element

Pattern: ^\d*\.\d{2}$
maxAmount:
string

Element filtru: kwota do / Filter element

Pattern: ^\d*\.\d{2}$
pageId:
string

Używane w celu stronicowania danych: numer transakcji rozpoczynający stronę / Transaction number beginning the page (paging info)

perPage:
number (int32)

Używane w celu stronicowania danych: wielkość strony danych / Page size (paging info)

}

Responses

Status: 200 - Success

{

Klasa odpowiedzi zawierająca listę transakcji zawieszonych / Hold Transaction Information Response Class

Required: responseHeader
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
transactions:
[
{

Klasa opisująca oczekującą transakcję płatniczą

Required: amount,description,recipient,sender,transactionId,transactionType
recipient:
{

Klasa zawierająca dane nadawcy/odbiorcy używana w żądaniach AIS / AIS Sender Recipient Data Class

Required: accountNumber
accountNumber:
string

Numer konta odbiorcy / Account number

accountMassPayment:
string

Numer wirtualny rachunku odbiorcy w formacie IBAN / Virtual account name

bank:
{

Klasa zawierająca dane banku używana w żądaniach AIS / AIS Bank Data Class

bicOrSwift:
string maxLength:11

Numer BIC/SWIFT Banku / BIC/SWIFT number

name:
string maxLength:70

Nazwa Banku / Bank's name

code:
string maxLength:10

Kod Banku, dla przelewów zagranicznych / Bank's code

countryCode:
string maxLength:3

Kod kraju 3166-1 / Country code

address:
[

Klasa zawierająca dane adresu pocztowego / Postal address Class

string maxLength:35
]
}
nameAddress:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
string maxLength:140

Nazwa / Name

address:
[ (1..3)
string maxLength:35
]
}
}
sender:
{

Klasa zawierająca dane nadawcy/odbiorcy używana w żądaniach AIS / AIS Sender Recipient Data Class

Required: accountNumber
accountNumber:
string

Numer konta odbiorcy / Account number

accountMassPayment:
string

Numer wirtualny rachunku odbiorcy w formacie IBAN / Virtual account name

bank:
{

Klasa zawierająca dane banku używana w żądaniach AIS / AIS Bank Data Class

bicOrSwift:
string maxLength:11

Numer BIC/SWIFT Banku / BIC/SWIFT number

name:
string maxLength:70

Nazwa Banku / Bank's name

code:
string maxLength:10

Kod Banku, dla przelewów zagranicznych / Bank's code

countryCode:
string maxLength:3

Kod kraju 3166-1 / Country code

address:
[

Klasa zawierająca dane adresu pocztowego / Postal address Class

string maxLength:35
]
}
nameAddress:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
string maxLength:140

Nazwa / Name

address:
[ (1..3)
string maxLength:35
]
}
}
initiator:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
string maxLength:140

Nazwa / Name

address:
[ (1..3)
string maxLength:35
]
}
holdExpirationDate:
string (datetime)

Data ważności blokady

auxData:
{

Klasa mapy / Map (Dictionary) class

}
tradeDate:
string (date)

Data operacji, YYYY-MM-DDThh:mm:ss[.mmm] / Date of the operation

transactionType:
string maxLength:100

Typ transakcji / Transaction type

description:
string maxLength:140

Tytuł transakcji / Description of the transaction

currency:
string maxLength:3

Kod ISO waluty transakcji / Currency (ISO)

amount:
string

Kwota transakcji / Amount of the transaction

Pattern: ^\d*\.\d{2}$
transactionId:
string maxLength:64

ID transakcji nadany przez ASPSP / Transaction ID (ASPSP)

type:
string

Typ transakcji uznanie/obciążenie / Transaction type (credit/debit)

Enum: DEBIT
}
]
pageInfo:
{

Klasa zawierająca dane pozwalajace na korzystanie z mechanizmu stronicowania / Paging Information Class

previousPage:
string

Użyte w celu stronicowania danych: poprzednia strona (np: numer konta lub transakcji rozpoczynający poprzednią stronę) / Previous page

nextPage:
string

Użyte w celu stronicowania danych: następna strona (np: numer konta lub transakcji rozpoczynający następną stronę) / Next page

}
}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

getTransactionDetail

Get detailed information about user's single transaction


/v1.0/accounts/v1.0/getTransactionDetail

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/accounts/v1.0/getTransactionDetail"
import .*;
import .auth.*;
import .model.*;
import .api.AISApi;

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

public class AISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        TransactionDetailRequest getTransationDetailRequest = ; // TransactionDetailRequest | Data for transation detail Request
        try {
            TransactionDetailResponse result = apiInstance.getTransactionDetail(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransationDetailRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getTransactionDetail");
            e.printStackTrace();
        }
    }
}
import .api.AISApi;

public class AISApiExample {

    public static void main(String[] args) {
        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        TransactionDetailRequest getTransationDetailRequest = ; // TransactionDetailRequest | Data for transation detail Request
        try {
            TransactionDetailResponse result = apiInstance.getTransactionDetail(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransationDetailRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getTransactionDetail");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
TransactionDetailRequest *getTransationDetailRequest = ; // Data for transation detail Request

AISApi *apiInstance = [[AISApi alloc] init];

// Get detailed information about user's single transaction
[apiInstance getTransactionDetailWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    getTransationDetailRequest:getTransationDetailRequest
              completionHandler: ^(TransactionDetailResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.AISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var getTransationDetailRequest = ; // {TransactionDetailRequest} Data for transation detail Request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransactionDetail(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransationDetailRequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class getTransactionDetailExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var getTransationDetailRequest = new TransactionDetailRequest(); // TransactionDetailRequest | Data for transation detail Request

            try
            {
                // Get detailed information about user's single transaction
                TransactionDetailResponse result = apiInstance.getTransactionDetail(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransationDetailRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AISApi.getTransactionDetail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$getTransationDetailRequest = ; // TransactionDetailRequest | Data for transation detail Request

try {
    $result = $api_instance->getTransactionDetail($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $getTransationDetailRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AISApi->getTransactionDetail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::AISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::AISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $getTransationDetailRequest = ::Object::TransactionDetailRequest->new(); # TransactionDetailRequest | Data for transation detail Request

eval { 
    my $result = $api_instance->getTransactionDetail(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, getTransationDetailRequest => $getTransationDetailRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AISApi->getTransactionDetail: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .AISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
getTransationDetailRequest =  # TransactionDetailRequest | Data for transation detail Request

try: 
    # Get detailed information about user's single transaction
    api_response = api_instance.get_transaction_detail(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransationDetailRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AISApi->getTransactionDetail: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
getTransationDetailRequest *
{

Klasa zapytania o pojedynczą transakcję / Transaction Detail Request Class

Required: requestHeader,transactionId
requestHeader:
{

Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class

Required: token
isDirectPsu:
token:
tppId:
sendDate:
ipAddress:
userAgent:
requestId:
}
transactionId:
string maxLength:64

ID transakcji / Transaction ID

accountNumber:
string maxLength:34

Numer konta nadawcy / Sender account number

bookingDate:
string (date)

Data zaksięgowania operacji, YYYY-MM-DD / Transaction booking date

}

Responses

Status: 200 - Success

{

Klasa odpowiedzi na zapytanie o transakcję / Transaction Detail Response Class

Required: baseInfo,responseHeader
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
baseInfo:
{

Klasa opisująca zaksięgowaną transakcję płatniczą

Required: amount,description,recipient,sender,transactionId,transactionType
postTransactionBalance:
string

Saldo rachunku po transakcji

bookingDate:
string (date)

Data księgowania, YYYY-MM-DDThh:mm:ss[.mmm]

recipient:
{

Klasa zawierająca dane nadawcy/odbiorcy używana w żądaniach AIS / AIS Sender Recipient Data Class

Required: accountNumber
accountNumber:
accountMassPayment:
bank:
nameAddress:
}
sender:
{

Klasa zawierająca dane nadawcy/odbiorcy używana w żądaniach AIS / AIS Sender Recipient Data Class

Required: accountNumber
accountNumber:
accountMassPayment:
bank:
nameAddress:
}
initiator:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
address:
}
transactionStatus:
{

Klasa zawierająca dane elementu/pozycji słownika / Dictionary Item Class

code:
description:
}
transactionId:
string maxLength:64

ID transakcji nadany przez ASPSP / Transaction ID (ASPSP)

amount:
string

Kwota transakcji / Amount of the transaction

Pattern: ^\d*\.\d{2}$
currency:
string maxLength:3

Kod ISO waluty transakcji / Currency (ISO)

description:
string maxLength:140

Tytuł transakcji / Description of the transaction

transactionType:
string maxLength:100

Typ transakcji / Transaction type

tradeDate:
string (date)

Data operacji, YYYY-MM-DDThh:mm:ss[.mmm] / Date of the operation

auxData:
{

Klasa mapy / Map (Dictionary) class

}
type:
string

Typ transakcji uznanie/obciążenie / Transaction type (credit/debit)

Enum: CREDIT, DEBIT
}
zusInfo:
{

Klasa informacji danych dla przelewu do ZUS / ZUS Transfer Information Class

payerInfo:
{

Klasa informacji o płatniku do ZUS i US / Tax Payor Information Class

payorId:
payorIdType:
}
contributionType:
string maxLength:1

Typ wpłaty / Payment type

periodId:
string maxLength:2

Numer okresu / Period number

year:
number (int32)

Rok okresu / Period year

paymentTypeId:
string maxLength:1

Identyfikator typu płatności / Payment type ID

}
usInfo:
{

Klasa informacji danych dla przelewu podatkowego do Urzędu Skarbowego lub Izby Celnej / Tax Transfer

Required: formCode,payerInfo,periodId,periodType,year
payerInfo:
{

Klasa informacji o płatniku do ZUS i US / Tax Payor Information Class

payorId:
payorIdType:
}
formCode:
string maxLength:7

Symbol formularza Urzędu Skarbowego lub Izby Celnej / Tax authority form symbol

periodId:
string maxLength:7

Numer okresu / Period number

periodType:
string maxLength:7

Typ okresu / Period type

year:
number (int32)

Rok okresu / Period year

obligationId:
string maxLength:40

Identyfikator zobowiązania, z którego wynika należność podatku np. decyzja, tytuł wykonawczy, postanowienie / Obligation ID

}
cardInfo:
{

Klasa reprezentująca informacje o karcie w ramach transakcji / Transaction Card Information Class

cardHolder:
string

Właściciel karty / Card holder

cardNumber:
string

Numer karty / Card number

}
currencyDate:
string (date)

Data kursu waluty, YYYY-MM-DDThh:mm:ss[.mmm] / Date of the currency exchange rate

transactionRate:
[
{

Klasa zawierająca kursy przewalutowań / Currency rate

rate:
number (double)

Kursy przewalutowania / Currency exchange rate

fromCurrency:
string maxLength:3

Waluta rachunku, kod ISO / from Currency, ISO code

toCurrency:
string maxLength:3

Waluta rachunku, kod ISO / to Currency, ISO code

}
]
baseCurrency:
string maxLength:3

Waluta oryginalna transakcji, kod ISO / Currency of the transaction, ISO code

amountBaseCurrency:
string

Kwota w oryginalnej walucie / Amount of the transaction

Pattern: ^\d*\.\d{2}$
usedPaymentInstrumentId:
string maxLength:32

Unikalny identyfikator instrumentu płatniczego, za którego pomocą wykonano transakcję / Payment Instrument ID

tppTransactionId:
string maxLength:64

Unikalny identyfikator transakcji po stronie TPP / Transaction ID (TPP)

tppName:
string maxLength:32

Nazwa TPP / TPP name

rejectionReason:
string maxLength:140

Przyczyna odrzucenia / Reason for rejection

holdExpirationDate:
string (datetime)

Data ważności blokady

}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

getTransactionsDone

Get list of user done transactions


/v1.0/accounts/v1.0/getTransactionsDone

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/accounts/v1.0/getTransactionsDone"
import .*;
import .auth.*;
import .model.*;
import .api.AISApi;

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

public class AISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        TransactionInfoRequest getTransactionsDoneRequest = ; // TransactionInfoRequest | Data for Transactions Done Request
        try {
            TransactionsDoneInfoResponse result = apiInstance.getTransactionsDone(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsDoneRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getTransactionsDone");
            e.printStackTrace();
        }
    }
}
import .api.AISApi;

public class AISApiExample {

    public static void main(String[] args) {
        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        TransactionInfoRequest getTransactionsDoneRequest = ; // TransactionInfoRequest | Data for Transactions Done Request
        try {
            TransactionsDoneInfoResponse result = apiInstance.getTransactionsDone(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsDoneRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getTransactionsDone");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
TransactionInfoRequest *getTransactionsDoneRequest = ; // Data for Transactions Done Request

AISApi *apiInstance = [[AISApi alloc] init];

// Get list of user done transactions
[apiInstance getTransactionsDoneWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    getTransactionsDoneRequest:getTransactionsDoneRequest
              completionHandler: ^(TransactionsDoneInfoResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.AISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var getTransactionsDoneRequest = ; // {TransactionInfoRequest} Data for Transactions Done Request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransactionsDone(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsDoneRequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class getTransactionsDoneExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var getTransactionsDoneRequest = new TransactionInfoRequest(); // TransactionInfoRequest | Data for Transactions Done Request

            try
            {
                // Get list of user done transactions
                TransactionsDoneInfoResponse result = apiInstance.getTransactionsDone(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsDoneRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AISApi.getTransactionsDone: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$getTransactionsDoneRequest = ; // TransactionInfoRequest | Data for Transactions Done Request

try {
    $result = $api_instance->getTransactionsDone($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $getTransactionsDoneRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AISApi->getTransactionsDone: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::AISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::AISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $getTransactionsDoneRequest = ::Object::TransactionInfoRequest->new(); # TransactionInfoRequest | Data for Transactions Done Request

eval { 
    my $result = $api_instance->getTransactionsDone(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, getTransactionsDoneRequest => $getTransactionsDoneRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AISApi->getTransactionsDone: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .AISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
getTransactionsDoneRequest =  # TransactionInfoRequest | Data for Transactions Done Request

try: 
    # Get list of user done transactions
    api_response = api_instance.get_transactions_done(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsDoneRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AISApi->getTransactionsDone: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
getTransactionsDoneRequest *
{

Klasa zapytania o transakcje / Transaction Information Request Class

Required: accountNumber,requestHeader
type:
string

Element filtru: transakcji / Filter element

Enum: CREDIT, DEBIT
perPage:
number (int32)

Używane w celu stronicowania danych: wielkość strony danych / Page size (paging info)

pageId:
string

Używane w celu stronicowania danych: numer transakcji rozpoczynający stronę / Transaction number beginning the page (paging info)

maxAmount:
string

Element filtru: kwota do / Filter element

Pattern: ^\d*\.\d{2}$
minAmount:
string

Element filtru: kwota od / Filter element

Pattern: ^\d*\.\d{2}$
bookingDateTo:
string (date)

Element filtru: data księgowania do, YYYY-MM-DD / Filter element

bookingDateFrom:
string (date)

Element filtru: data księgowania od, YYYY-MM-DD / Filter element

transactionDateTo:
string (date)

Element filtru: data transakcji do, YYYY-MM-DD / Filter element

transactionDateFrom:
string (date)

Element filtru: data transakcji od, YYYY-MM-DD / Filter element

transactionIdFrom:
string maxLength:64

Element filtru: transacje od podanego identyfikatora transakcji / Filter element

accountNumber:
string

Numer rachunku / Account number

requestHeader:
{

Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class

Required: token
isDirectPsu:
token:
tppId:
sendDate:
ipAddress:
userAgent:
requestId:
}
}

Responses

Status: 200 - Success

{

Klasa odpowiedzi zawierająca listę transakcji done / Done Transaction Information Response Class

Required: responseHeader
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
transactions:
[
{

Klasa opisująca zaksięgowaną transakcję płatniczą

Required: amount,description,recipient,sender,transactionId,transactionType
postTransactionBalance:
string

Saldo rachunku po transakcji

bookingDate:
string (date)

Data księgowania, YYYY-MM-DDThh:mm:ss[.mmm]

recipient:
{

Klasa zawierająca dane nadawcy/odbiorcy używana w żądaniach AIS / AIS Sender Recipient Data Class

Required: accountNumber
accountNumber:
string

Numer konta odbiorcy / Account number

accountMassPayment:
string

Numer wirtualny rachunku odbiorcy w formacie IBAN / Virtual account name

bank:
{

Klasa zawierająca dane banku używana w żądaniach AIS / AIS Bank Data Class

bicOrSwift:
string maxLength:11

Numer BIC/SWIFT Banku / BIC/SWIFT number

name:
string maxLength:70

Nazwa Banku / Bank's name

code:
string maxLength:10

Kod Banku, dla przelewów zagranicznych / Bank's code

countryCode:
string maxLength:3

Kod kraju 3166-1 / Country code

address:
[

Klasa zawierająca dane adresu pocztowego / Postal address Class

string maxLength:35
]
}
nameAddress:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
string maxLength:140

Nazwa / Name

address:
[ (1..3)
string maxLength:35
]
}
}
sender:
{

Klasa zawierająca dane nadawcy/odbiorcy używana w żądaniach AIS / AIS Sender Recipient Data Class

Required: accountNumber
accountNumber:
string

Numer konta odbiorcy / Account number

accountMassPayment:
string

Numer wirtualny rachunku odbiorcy w formacie IBAN / Virtual account name

bank:
{

Klasa zawierająca dane banku używana w żądaniach AIS / AIS Bank Data Class

bicOrSwift:
string maxLength:11

Numer BIC/SWIFT Banku / BIC/SWIFT number

name:
string maxLength:70

Nazwa Banku / Bank's name

code:
string maxLength:10

Kod Banku, dla przelewów zagranicznych / Bank's code

countryCode:
string maxLength:3

Kod kraju 3166-1 / Country code

address:
[

Klasa zawierająca dane adresu pocztowego / Postal address Class

string maxLength:35
]
}
nameAddress:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
string maxLength:140

Nazwa / Name

address:
[ (1..3)
string maxLength:35
]
}
}
initiator:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
string maxLength:140

Nazwa / Name

address:
[ (1..3)
string maxLength:35
]
}
transactionStatus:
{

Klasa zawierająca dane elementu/pozycji słownika / Dictionary Item Class

code:
string

Kod pozycji słownika / Code

description:
string

Opis pozycji słownika / Description

}
transactionId:
string maxLength:64

ID transakcji nadany przez ASPSP / Transaction ID (ASPSP)

amount:
string

Kwota transakcji / Amount of the transaction

Pattern: ^\d*\.\d{2}$
currency:
string maxLength:3

Kod ISO waluty transakcji / Currency (ISO)

description:
string maxLength:140

Tytuł transakcji / Description of the transaction

transactionType:
string maxLength:100

Typ transakcji / Transaction type

tradeDate:
string (date)

Data operacji, YYYY-MM-DDThh:mm:ss[.mmm] / Date of the operation

auxData:
{

Klasa mapy / Map (Dictionary) class

}
type:
string

Typ transakcji uznanie/obciążenie / Transaction type (credit/debit)

Enum: CREDIT, DEBIT
}
]
pageInfo:
{

Klasa zawierająca dane pozwalajace na korzystanie z mechanizmu stronicowania / Paging Information Class

previousPage:
string

Użyte w celu stronicowania danych: poprzednia strona (np: numer konta lub transakcji rozpoczynający poprzednią stronę) / Previous page

nextPage:
string

Użyte w celu stronicowania danych: następna strona (np: numer konta lub transakcji rozpoczynający następną stronę) / Next page

}
}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

getTransactionsPending

Get list of user's pending transactions


/v1.0/accounts/v1.0/getTransactionsPending

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/accounts/v1.0/getTransactionsPending"
import .*;
import .auth.*;
import .model.*;
import .api.AISApi;

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

public class AISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        TransactionInfoRequest getTransactionsPendingRequest = ; // TransactionInfoRequest | Data for Transactions Pending Request
        try {
            TransactionPendingInfoResponse result = apiInstance.getTransactionsPending(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsPendingRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getTransactionsPending");
            e.printStackTrace();
        }
    }
}
import .api.AISApi;

public class AISApiExample {

    public static void main(String[] args) {
        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        TransactionInfoRequest getTransactionsPendingRequest = ; // TransactionInfoRequest | Data for Transactions Pending Request
        try {
            TransactionPendingInfoResponse result = apiInstance.getTransactionsPending(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsPendingRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getTransactionsPending");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
TransactionInfoRequest *getTransactionsPendingRequest = ; // Data for Transactions Pending Request

AISApi *apiInstance = [[AISApi alloc] init];

// Get list of user's pending transactions
[apiInstance getTransactionsPendingWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    getTransactionsPendingRequest:getTransactionsPendingRequest
              completionHandler: ^(TransactionPendingInfoResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.AISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var getTransactionsPendingRequest = ; // {TransactionInfoRequest} Data for Transactions Pending Request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransactionsPending(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsPendingRequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class getTransactionsPendingExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var getTransactionsPendingRequest = new TransactionInfoRequest(); // TransactionInfoRequest | Data for Transactions Pending Request

            try
            {
                // Get list of user's pending transactions
                TransactionPendingInfoResponse result = apiInstance.getTransactionsPending(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsPendingRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AISApi.getTransactionsPending: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$getTransactionsPendingRequest = ; // TransactionInfoRequest | Data for Transactions Pending Request

try {
    $result = $api_instance->getTransactionsPending($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $getTransactionsPendingRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AISApi->getTransactionsPending: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::AISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::AISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $getTransactionsPendingRequest = ::Object::TransactionInfoRequest->new(); # TransactionInfoRequest | Data for Transactions Pending Request

eval { 
    my $result = $api_instance->getTransactionsPending(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, getTransactionsPendingRequest => $getTransactionsPendingRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AISApi->getTransactionsPending: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .AISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
getTransactionsPendingRequest =  # TransactionInfoRequest | Data for Transactions Pending Request

try: 
    # Get list of user's pending transactions
    api_response = api_instance.get_transactions_pending(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsPendingRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AISApi->getTransactionsPending: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
getTransactionsPendingRequest *
{

Klasa zapytania o transakcje / Transaction Information Request Class

Required: accountNumber,requestHeader
type:
string

Element filtru: transakcji / Filter element

Enum: CREDIT, DEBIT
perPage:
number (int32)

Używane w celu stronicowania danych: wielkość strony danych / Page size (paging info)

pageId:
string

Używane w celu stronicowania danych: numer transakcji rozpoczynający stronę / Transaction number beginning the page (paging info)

maxAmount:
string

Element filtru: kwota do / Filter element

Pattern: ^\d*\.\d{2}$
minAmount:
string

Element filtru: kwota od / Filter element

Pattern: ^\d*\.\d{2}$
bookingDateTo:
string (date)

Element filtru: data księgowania do, YYYY-MM-DD / Filter element

bookingDateFrom:
string (date)

Element filtru: data księgowania od, YYYY-MM-DD / Filter element

transactionDateTo:
string (date)

Element filtru: data transakcji do, YYYY-MM-DD / Filter element

transactionDateFrom:
string (date)

Element filtru: data transakcji od, YYYY-MM-DD / Filter element

transactionIdFrom:
string maxLength:64

Element filtru: transacje od podanego identyfikatora transakcji / Filter element

accountNumber:
string

Numer rachunku / Account number

requestHeader:
{

Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class

Required: token
isDirectPsu:
token:
tppId:
sendDate:
ipAddress:
userAgent:
requestId:
}
}

Responses

Status: 200 - Success

{

Klasa odpowiedzi zawierająca listę transakcji pending / Pending Transaction Information Response Class

Required: responseHeader
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
transactions:
[
{

Klasa opisująca oczekującą transakcję płatniczą. Jest to transakcja niezaksięgowana, niemodyfikowalna, wpływającej na dostępne środki (saldo dostępne).

Required: amount,description,transactionId,transactionType
recipient:
{

Klasa zawierająca dane nadawcy/odbiorcy używana w żądaniach AIS / AIS Sender Recipient Data Class

Required: accountNumber
accountNumber:
string

Numer konta odbiorcy / Account number

accountMassPayment:
string

Numer wirtualny rachunku odbiorcy w formacie IBAN / Virtual account name

bank:
{

Klasa zawierająca dane banku używana w żądaniach AIS / AIS Bank Data Class

bicOrSwift:
string maxLength:11

Numer BIC/SWIFT Banku / BIC/SWIFT number

name:
string maxLength:70

Nazwa Banku / Bank's name

code:
string maxLength:10

Kod Banku, dla przelewów zagranicznych / Bank's code

countryCode:
string maxLength:3

Kod kraju 3166-1 / Country code

address:
[

Klasa zawierająca dane adresu pocztowego / Postal address Class

string maxLength:35
]
}
nameAddress:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
string maxLength:140

Nazwa / Name

address:
[ (1..3)
string maxLength:35
]
}
}
sender:
{

Klasa zawierająca dane nadawcy/odbiorcy używana w żądaniach AIS / AIS Sender Recipient Data Class

Required: accountNumber
accountNumber:
string

Numer konta odbiorcy / Account number

accountMassPayment:
string

Numer wirtualny rachunku odbiorcy w formacie IBAN / Virtual account name

bank:
{

Klasa zawierająca dane banku używana w żądaniach AIS / AIS Bank Data Class

bicOrSwift:
string maxLength:11

Numer BIC/SWIFT Banku / BIC/SWIFT number

name:
string maxLength:70

Nazwa Banku / Bank's name

code:
string maxLength:10

Kod Banku, dla przelewów zagranicznych / Bank's code

countryCode:
string maxLength:3

Kod kraju 3166-1 / Country code

address:
[

Klasa zawierająca dane adresu pocztowego / Postal address Class

string maxLength:35
]
}
nameAddress:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
string maxLength:140

Nazwa / Name

address:
[ (1..3)
string maxLength:35
]
}
}
initiator:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
string maxLength:140

Nazwa / Name

address:
[ (1..3)
string maxLength:35
]
}
transactionId:
string maxLength:64

ID transakcji nadany przez ASPSP / Transaction ID (ASPSP)

amount:
string

Kwota transakcji / Amount of the transaction

Pattern: ^\d*\.\d{2}$
currency:
string maxLength:3

Kod ISO waluty transakcji / Currency (ISO)

description:
string maxLength:140

Tytuł transakcji / Description of the transaction

transactionType:
string maxLength:100

Typ transakcji / Transaction type

tradeDate:
string (date)

Data operacji, YYYY-MM-DDThh:mm:ss[.mmm] / Date of the operation

auxData:
{

Klasa mapy / Map (Dictionary) class

}
type:
string

Typ transakcji uznanie/obciążenie / Transaction type (credit/debit)

Enum: CREDIT, DEBIT
}
]
pageInfo:
{

Klasa zawierająca dane pozwalajace na korzystanie z mechanizmu stronicowania / Paging Information Class

previousPage:
string

Użyte w celu stronicowania danych: poprzednia strona (np: numer konta lub transakcji rozpoczynający poprzednią stronę) / Previous page

nextPage:
string

Użyte w celu stronicowania danych: następna strona (np: numer konta lub transakcji rozpoczynający następną stronę) / Next page

}
}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

getTransactionsRejected

Get list of user's rejected transactions


/v1.0/accounts/v1.0/getTransactionsRejected

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/accounts/v1.0/getTransactionsRejected"
import .*;
import .auth.*;
import .model.*;
import .api.AISApi;

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

public class AISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        TransactionInfoRequest getTransactionsRejectedRequest = ; // TransactionInfoRequest | Data for Transactions Rejected Request
        try {
            TransactionRejectedInfoResponse result = apiInstance.getTransactionsRejected(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsRejectedRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getTransactionsRejected");
            e.printStackTrace();
        }
    }
}
import .api.AISApi;

public class AISApiExample {

    public static void main(String[] args) {
        AISApi apiInstance = new AISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        TransactionInfoRequest getTransactionsRejectedRequest = ; // TransactionInfoRequest | Data for Transactions Rejected Request
        try {
            TransactionRejectedInfoResponse result = apiInstance.getTransactionsRejected(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsRejectedRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AISApi#getTransactionsRejected");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
TransactionInfoRequest *getTransactionsRejectedRequest = ; // Data for Transactions Rejected Request

AISApi *apiInstance = [[AISApi alloc] init];

// Get list of user's rejected transactions
[apiInstance getTransactionsRejectedWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    getTransactionsRejectedRequest:getTransactionsRejectedRequest
              completionHandler: ^(TransactionRejectedInfoResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.AISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var getTransactionsRejectedRequest = ; // {TransactionInfoRequest} Data for Transactions Rejected Request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransactionsRejected(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsRejectedRequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class getTransactionsRejectedExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var getTransactionsRejectedRequest = new TransactionInfoRequest(); // TransactionInfoRequest | Data for Transactions Rejected Request

            try
            {
                // Get list of user's rejected transactions
                TransactionRejectedInfoResponse result = apiInstance.getTransactionsRejected(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsRejectedRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AISApi.getTransactionsRejected: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$getTransactionsRejectedRequest = ; // TransactionInfoRequest | Data for Transactions Rejected Request

try {
    $result = $api_instance->getTransactionsRejected($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $getTransactionsRejectedRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AISApi->getTransactionsRejected: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::AISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::AISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $getTransactionsRejectedRequest = ::Object::TransactionInfoRequest->new(); # TransactionInfoRequest | Data for Transactions Rejected Request

eval { 
    my $result = $api_instance->getTransactionsRejected(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, getTransactionsRejectedRequest => $getTransactionsRejectedRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AISApi->getTransactionsRejected: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .AISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
getTransactionsRejectedRequest =  # TransactionInfoRequest | Data for Transactions Rejected Request

try: 
    # Get list of user's rejected transactions
    api_response = api_instance.get_transactions_rejected(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, getTransactionsRejectedRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AISApi->getTransactionsRejected: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
getTransactionsRejectedRequest *
{

Klasa zapytania o transakcje / Transaction Information Request Class

Required: accountNumber,requestHeader
type:
string

Element filtru: transakcji / Filter element

Enum: CREDIT, DEBIT
perPage:
number (int32)

Używane w celu stronicowania danych: wielkość strony danych / Page size (paging info)

pageId:
string

Używane w celu stronicowania danych: numer transakcji rozpoczynający stronę / Transaction number beginning the page (paging info)

maxAmount:
string

Element filtru: kwota do / Filter element

Pattern: ^\d*\.\d{2}$
minAmount:
string

Element filtru: kwota od / Filter element

Pattern: ^\d*\.\d{2}$
bookingDateTo:
string (date)

Element filtru: data księgowania do, YYYY-MM-DD / Filter element

bookingDateFrom:
string (date)

Element filtru: data księgowania od, YYYY-MM-DD / Filter element

transactionDateTo:
string (date)

Element filtru: data transakcji do, YYYY-MM-DD / Filter element

transactionDateFrom:
string (date)

Element filtru: data transakcji od, YYYY-MM-DD / Filter element

transactionIdFrom:
string maxLength:64

Element filtru: transacje od podanego identyfikatora transakcji / Filter element

accountNumber:
string

Numer rachunku / Account number

requestHeader:
{

Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class

Required: token
isDirectPsu:
token:
tppId:
sendDate:
ipAddress:
userAgent:
requestId:
}
}

Responses

Status: 200 - Success

{

Klasa odpowiedzi zawierająca listę transakcji rejected / Rejected Transaction Information Response Class

Required: responseHeader
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
transactions:
[
{

Klasa opisująca odrzuconą transakcję płatniczą

Required: amount,description,recipient,sender,transactionId,transactionType
rejectionDate:
string (date)

Data odrzucenia, YYYY-MM-DDThh:mm:ss[.mmm]

rejectionReason:
string maxLength:140

Powod odrzucenia

recipient:
{

Klasa zawierająca dane nadawcy/odbiorcy używana w żądaniach AIS / AIS Sender Recipient Data Class

Required: accountNumber
accountNumber:
string

Numer konta odbiorcy / Account number

accountMassPayment:
string

Numer wirtualny rachunku odbiorcy w formacie IBAN / Virtual account name

bank:
{

Klasa zawierająca dane banku używana w żądaniach AIS / AIS Bank Data Class

bicOrSwift:
string maxLength:11

Numer BIC/SWIFT Banku / BIC/SWIFT number

name:
string maxLength:70

Nazwa Banku / Bank's name

code:
string maxLength:10

Kod Banku, dla przelewów zagranicznych / Bank's code

countryCode:
string maxLength:3

Kod kraju 3166-1 / Country code

address:
[

Klasa zawierająca dane adresu pocztowego / Postal address Class

string maxLength:35
]
}
nameAddress:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
string maxLength:140

Nazwa / Name

address:
[ (1..3)
string maxLength:35
]
}
}
sender:
{

Klasa zawierająca dane nadawcy/odbiorcy używana w żądaniach AIS / AIS Sender Recipient Data Class

Required: accountNumber
accountNumber:
string

Numer konta odbiorcy / Account number

accountMassPayment:
string

Numer wirtualny rachunku odbiorcy w formacie IBAN / Virtual account name

bank:
{

Klasa zawierająca dane banku używana w żądaniach AIS / AIS Bank Data Class

bicOrSwift:
string maxLength:11

Numer BIC/SWIFT Banku / BIC/SWIFT number

name:
string maxLength:70

Nazwa Banku / Bank's name

code:
string maxLength:10

Kod Banku, dla przelewów zagranicznych / Bank's code

countryCode:
string maxLength:3

Kod kraju 3166-1 / Country code

address:
[

Klasa zawierająca dane adresu pocztowego / Postal address Class

string maxLength:35
]
}
nameAddress:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
string maxLength:140

Nazwa / Name

address:
[ (1..3)
string maxLength:35
]
}
}
initiator:
{

Klasa zawierająca dane nazwy i adresu w postaci czterech linii danych / Simple name and postal address Class

Required: name
name:
string maxLength:140

Nazwa / Name

address:
[ (1..3)
string maxLength:35
]
}
auxData:
{

Klasa mapy / Map (Dictionary) class

}
tradeDate:
string (date)

Data operacji, YYYY-MM-DDThh:mm:ss[.mmm] / Date of the operation

transactionType:
string maxLength:100

Typ transakcji / Transaction type

description:
string maxLength:140

Tytuł transakcji / Description of the transaction

currency:
string maxLength:3

Kod ISO waluty transakcji / Currency (ISO)

amount:
string

Kwota transakcji / Amount of the transaction

Pattern: ^\d*\.\d{2}$
transactionId:
string maxLength:64

ID transakcji nadany przez ASPSP / Transaction ID (ASPSP)

type:
string

Typ transakcji uznanie/obciążenie / Transaction type (credit/debit)

Enum: CREDIT, DEBIT
}
]
pageInfo:
{

Klasa zawierająca dane pozwalajace na korzystanie z mechanizmu stronicowania / Paging Information Class

previousPage:
string

Użyte w celu stronicowania danych: poprzednia strona (np: numer konta lub transakcji rozpoczynający poprzednią stronę) / Previous page

nextPage:
string

Użyte w celu stronicowania danych: następna strona (np: numer konta lub transakcji rozpoczynający następną stronę) / Next page

}
}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

CAF

getConfirmationOfFunds

Confirmation of the availability of funds

Confirming the availability on the payers account of the amount necessary to execute the payment transaction, as defined in Art. 65 PSD2.


/v1.0/confirmation/v1.0/getConfirmationOfFunds

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/confirmation/v1.0/getConfirmationOfFunds"
import .*;
import .auth.*;
import .model.*;
import .api.CAFApi;

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

public class CAFApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        CAFApi apiInstance = new CAFApi();
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        ConfirmationOfFundsRequest confirmationOfFundsRequest = ; // ConfirmationOfFundsRequest | Object with amount to check
        try {
            ConfirmationOfFundsResponse result = apiInstance.getConfirmationOfFunds(acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, confirmationOfFundsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CAFApi#getConfirmationOfFunds");
            e.printStackTrace();
        }
    }
}
import .api.CAFApi;

public class CAFApiExample {

    public static void main(String[] args) {
        CAFApi apiInstance = new CAFApi();
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        ConfirmationOfFundsRequest confirmationOfFundsRequest = ; // ConfirmationOfFundsRequest | Object with amount to check
        try {
            ConfirmationOfFundsResponse result = apiInstance.getConfirmationOfFunds(acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, confirmationOfFundsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CAFApi#getConfirmationOfFunds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
ConfirmationOfFundsRequest *confirmationOfFundsRequest = ; // Object with amount to check

CAFApi *apiInstance = [[CAFApi alloc] init];

// Confirmation of the availability of funds
[apiInstance getConfirmationOfFundsWith:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    confirmationOfFundsRequest:confirmationOfFundsRequest
              completionHandler: ^(ConfirmationOfFundsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.CAFApi()

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var confirmationOfFundsRequest = ; // {ConfirmationOfFundsRequest} Object with amount to check


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConfirmationOfFunds(acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, confirmationOfFundsRequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class getConfirmationOfFundsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CAFApi();
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var confirmationOfFundsRequest = new ConfirmationOfFundsRequest(); // ConfirmationOfFundsRequest | Object with amount to check

            try
            {
                // Confirmation of the availability of funds
                ConfirmationOfFundsResponse result = apiInstance.getConfirmationOfFunds(acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, confirmationOfFundsRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CAFApi.getConfirmationOfFunds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\CAFApi();
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$confirmationOfFundsRequest = ; // ConfirmationOfFundsRequest | Object with amount to check

try {
    $result = $api_instance->getConfirmationOfFunds($acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $confirmationOfFundsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CAFApi->getConfirmationOfFunds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::CAFApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::CAFApi->new();
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $confirmationOfFundsRequest = ::Object::ConfirmationOfFundsRequest->new(); # ConfirmationOfFundsRequest | Object with amount to check

eval { 
    my $result = $api_instance->getConfirmationOfFunds(acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, confirmationOfFundsRequest => $confirmationOfFundsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CAFApi->getConfirmationOfFunds: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .CAFApi()
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
confirmationOfFundsRequest =  # ConfirmationOfFundsRequest | Object with amount to check

try: 
    # Confirmation of the availability of funds
    api_response = api_instance.get_confirmation_of_funds(acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, confirmationOfFundsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CAFApi->getConfirmationOfFunds: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
confirmationOfFundsRequest *
{

Klasa zapytania o dostępne środki płatnicze na rachunku / Confirmation of Funds Request Class

Required: accountNumber,amount,currency,requestHeader
requestHeader:
{

Klasa zawierająca informacje o PSU / PSU Information Class

requestId:
userAgent:
ipAddress:
sendDate:
tppId:
}
accountNumber:
string maxLength:34

Numer konta / Account number

amount:
string

Wielkość środków której dotyczy zaptanie / Amount of the transaction

Pattern: ^\d*\.\d{2}$
currency:
string maxLength:3

Kod ISO Waluty (waluta transakcji) / Currency of transaction (ISO)

}

Responses

Status: 200 - Success

{

Klasa odpowiedzi na zapytanie o dostępne środki płatnicze na rachunku / Confirmation of Funds Response Class

Required: fundsAvailable,responseHeader
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
fundsAvailable:
boolean

Status - Czy środki są dostępne / Status - are funds available

}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

PIS

domestic

Initiate domestic transfer


/v1.0/payments/v1.0/domestic

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/payments/v1.0/domestic"
import .*;
import .auth.*;
import .model.*;
import .api.PISApi;

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

public class PISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        PISApi apiInstance = new PISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        PaymentDomesticRequest domesticRequest = ; // PaymentDomesticRequest | Data for domestic transfer
        try {
            AddPaymentResponse result = apiInstance.domestic(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, domesticRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PISApi#domestic");
            e.printStackTrace();
        }
    }
}
import .api.PISApi;

public class PISApiExample {

    public static void main(String[] args) {
        PISApi apiInstance = new PISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        PaymentDomesticRequest domesticRequest = ; // PaymentDomesticRequest | Data for domestic transfer
        try {
            AddPaymentResponse result = apiInstance.domestic(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, domesticRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PISApi#domestic");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
PaymentDomesticRequest *domesticRequest = ; // Data for domestic transfer

PISApi *apiInstance = [[PISApi alloc] init];

// Initiate domestic transfer
[apiInstance domesticWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    domesticRequest:domesticRequest
              completionHandler: ^(AddPaymentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.PISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var domesticRequest = ; // {PaymentDomesticRequest} Data for domestic transfer


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.domestic(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, domesticRequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class domesticExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var domesticRequest = new PaymentDomesticRequest(); // PaymentDomesticRequest | Data for domestic transfer

            try
            {
                // Initiate domestic transfer
                AddPaymentResponse result = apiInstance.domestic(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, domesticRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PISApi.domestic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$domesticRequest = ; // PaymentDomesticRequest | Data for domestic transfer

try {
    $result = $api_instance->domestic($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $domesticRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PISApi->domestic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::PISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::PISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $domesticRequest = ::Object::PaymentDomesticRequest->new(); # PaymentDomesticRequest | Data for domestic transfer

eval { 
    my $result = $api_instance->domestic(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, domesticRequest => $domesticRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PISApi->domestic: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .PISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
domesticRequest =  # PaymentDomesticRequest | Data for domestic transfer

try: 
    # Initiate domestic transfer
    api_response = api_instance.domestic(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, domesticRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PISApi->domestic: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
domesticRequest *
{

Klasa zlecenia przelewu krajowego / Domestic Transfer Request Class

Required: deliveryMode,recipient,requestHeader,sender,tppTransactionId,transferData
requestHeader:
{

Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class

Required: token
apiKey:
callbackURL:
token:
tppId:
sendDate:
ipAddress:
userAgent:
requestId:
}
recipient:
{

Klasa zawierająca dane odbiorcy używana w żądaniach PIS / PIS Recipient Data Class

Required: accountNumber,name
accountNumber:
name:
address:
}
sender:
{

Klasa zawierająca dane nadawcy używana w żądaniach PIS / PIS Sender Data Class

Required: accountNumber
accountNumber:
name:
}
transferData:
{

Klasa zawierająca dane przelewu / Transfer Data Class

Required: amount,description
currency:
amount:
description:
}
tppTransactionId:
string maxLength:64

ID transakcji nadany przez TPP / Transaction ID (TPP)

deliveryMode:
string

Tryb pilności / Urgency mode

Enum: ExpressD0, StandardD1
system:
string

Droga jaką przelew ma być rozliczony / The way the transfer should be settled

Enum: Elixir, ExpressElixir, Sorbnet, BlueCash, Internal
hold:
boolean

Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded

}

Responses

Status: 200 - Success

{

Klasa odpowiedzi zlecenia płatności / Payment Add Response Class

Required: detailedStatus,generalStatus,responseHeader,transactionId
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
transactionId:
string

Identyfiaktor płatności / Transaction ID

generalStatus:
string

Słownik statusów płatnośći

Enum: submitted, cancelled, pending, done, rejected
detailedStatus:
string

Status płatności / Detailed payment status

}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

EEA

Initiate SEPA foreign transfers


/v1.0/payments/v1.0/EEA

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/payments/v1.0/EEA"
import .*;
import .auth.*;
import .model.*;
import .api.PISApi;

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

public class PISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        PISApi apiInstance = new PISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        PaymentEEARequest eEARequest = ; // PaymentEEARequest | Data for SEPA foreign transfer
        try {
            AddPaymentResponse result = apiInstance.eEA(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, eEARequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PISApi#eEA");
            e.printStackTrace();
        }
    }
}
import .api.PISApi;

public class PISApiExample {

    public static void main(String[] args) {
        PISApi apiInstance = new PISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        PaymentEEARequest eEARequest = ; // PaymentEEARequest | Data for SEPA foreign transfer
        try {
            AddPaymentResponse result = apiInstance.eEA(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, eEARequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PISApi#eEA");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
PaymentEEARequest *eEARequest = ; // Data for SEPA foreign transfer

PISApi *apiInstance = [[PISApi alloc] init];

// Initiate SEPA foreign transfers
[apiInstance eEAWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    eEARequest:eEARequest
              completionHandler: ^(AddPaymentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.PISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var eEARequest = ; // {PaymentEEARequest} Data for SEPA foreign transfer


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.eEA(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, eEARequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class eEAExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var eEARequest = new PaymentEEARequest(); // PaymentEEARequest | Data for SEPA foreign transfer

            try
            {
                // Initiate SEPA foreign transfers
                AddPaymentResponse result = apiInstance.eEA(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, eEARequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PISApi.eEA: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$eEARequest = ; // PaymentEEARequest | Data for SEPA foreign transfer

try {
    $result = $api_instance->eEA($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $eEARequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PISApi->eEA: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::PISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::PISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $eEARequest = ::Object::PaymentEEARequest->new(); # PaymentEEARequest | Data for SEPA foreign transfer

eval { 
    my $result = $api_instance->eEA(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, eEARequest => $eEARequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PISApi->eEA: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .PISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
eEARequest =  # PaymentEEARequest | Data for SEPA foreign transfer

try: 
    # Initiate SEPA foreign transfers
    api_response = api_instance.e_ea(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, eEARequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PISApi->eEA: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
eEARequest *
{

Klasa zlecenia przelewu zagranicznego SEPA / EEA Transfer Request Class

Required: deliveryMode,recipient,requestHeader,sender,tppTransactionId,transferData
requestHeader:
{

Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class

Required: token
apiKey:
callbackURL:
token:
tppId:
sendDate:
ipAddress:
userAgent:
requestId:
}
recipient:
{

Klasa zawierająca dane odbiorcy używana w żądaniach PIS dla operacji zagranicznych / PIS foreign Recipient Data Class

Required: accountNumber,name
accountNumber:
name:
address:
}
sender:
{

Klasa zawierająca dane nadawcy używana w żądaniach PIS / PIS Sender Data Class

Required: accountNumber
accountNumber:
name:
}
transferData:
{

Klasa zawierająca dane przelewu / Transfer Data Class

Required: amount,description
currency:
amount:
description:
}
tppTransactionId:
string maxLength:64

ID transakcji nadany przez TPP / Transaction ID (TPP)

deliveryMode:
string

Tryb pilności / Urgency mode

Enum: ExpressD0, StandardD1
system:
string

Droga jaką przelew ma być rozliczony / The way the transfer should be settled

Enum: SEPA, InstantSEPA, Target
hold:
boolean

Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded

}

Responses

Status: 200 - Success

{

Klasa odpowiedzi zlecenia płatności / Payment Add Response Class

Required: detailedStatus,generalStatus,responseHeader,transactionId
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
transactionId:
string

Identyfiaktor płatności / Transaction ID

generalStatus:
string

Słownik statusów płatnośći

Enum: submitted, cancelled, pending, done, rejected
detailedStatus:
string

Status płatności / Detailed payment status

}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

getMultiplePayments

Get the status of multiple payments


/v1.0/payments/v1.0/getMultiplePayments

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/payments/v1.0/getMultiplePayments"
import .*;
import .auth.*;
import .model.*;
import .api.PISApi;

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

public class PISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        PISApi apiInstance = new PISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        PaymentsRequest payments = ; // PaymentsRequest | Payments ID list
        try {
            PaymentsResponse result = apiInstance.getMultiplePayments(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, payments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PISApi#getMultiplePayments");
            e.printStackTrace();
        }
    }
}
import .api.PISApi;

public class PISApiExample {

    public static void main(String[] args) {
        PISApi apiInstance = new PISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        PaymentsRequest payments = ; // PaymentsRequest | Payments ID list
        try {
            PaymentsResponse result = apiInstance.getMultiplePayments(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, payments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PISApi#getMultiplePayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
PaymentsRequest *payments = ; // Payments ID list

PISApi *apiInstance = [[PISApi alloc] init];

// Get the status of multiple payments
[apiInstance getMultiplePaymentsWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    payments:payments
              completionHandler: ^(PaymentsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.PISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var payments = ; // {PaymentsRequest} Payments ID list


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMultiplePayments(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, payments, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class getMultiplePaymentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var payments = new PaymentsRequest(); // PaymentsRequest | Payments ID list

            try
            {
                // Get the status of multiple payments
                PaymentsResponse result = apiInstance.getMultiplePayments(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, payments);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PISApi.getMultiplePayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$payments = ; // PaymentsRequest | Payments ID list

try {
    $result = $api_instance->getMultiplePayments($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $payments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PISApi->getMultiplePayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::PISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::PISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $payments = ::Object::PaymentsRequest->new(); # PaymentsRequest | Payments ID list

eval { 
    my $result = $api_instance->getMultiplePayments(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, payments => $payments);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PISApi->getMultiplePayments: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .PISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
payments =  # PaymentsRequest | Payments ID list

try: 
    # Get the status of multiple payments
    api_response = api_instance.get_multiple_payments(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, payments)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PISApi->getMultiplePayments: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
payments *
{

Klasa zapytania o statusy wielu płatności / Payments Request Class

Required: paymentsId,requestHeader
requestHeader:
{

Klasa zawierająca informacje o PSU / PSU Information Class

requestId:
userAgent:
ipAddress:
sendDate:
tppId:
}
paymentsId:
[
string
]
}

Responses

Status: 200 - Success

{

Klasa odpowiedzi na pytanie o wiele płatności

Required: responseHeader
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
payments:
[
{

Klasa informacji o płatności / Payment Information Class

Required: detailedStatus,generalStatus,transactionId
transactionId:
string

Identyfiaktor płatności / Transaction ID

generalStatus:
string

Słownik statusów płatnośći

Enum: submitted, cancelled, pending, done, rejected
detailedStatus:
string

Szczegółowy status płatności / Detailed payment status

}
]
}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

getPayment

Get the status of payment


/v1.0/payments/v1.0/getPayment

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/payments/v1.0/getPayment"
import .*;
import .auth.*;
import .model.*;
import .api.PISApi;

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

public class PISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        PISApi apiInstance = new PISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        PaymentRequest payment = ; // PaymentRequest | Payment ID
        try {
            GetPaymentResponse result = apiInstance.getPayment(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, payment);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PISApi#getPayment");
            e.printStackTrace();
        }
    }
}
import .api.PISApi;

public class PISApiExample {

    public static void main(String[] args) {
        PISApi apiInstance = new PISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        PaymentRequest payment = ; // PaymentRequest | Payment ID
        try {
            GetPaymentResponse result = apiInstance.getPayment(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, payment);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PISApi#getPayment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
PaymentRequest *payment = ; // Payment ID

PISApi *apiInstance = [[PISApi alloc] init];

// Get the status of payment
[apiInstance getPaymentWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    payment:payment
              completionHandler: ^(GetPaymentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.PISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var payment = ; // {PaymentRequest} Payment ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPayment(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, payment, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class getPaymentExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var payment = new PaymentRequest(); // PaymentRequest | Payment ID

            try
            {
                // Get the status of payment
                GetPaymentResponse result = apiInstance.getPayment(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, payment);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PISApi.getPayment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$payment = ; // PaymentRequest | Payment ID

try {
    $result = $api_instance->getPayment($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $payment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PISApi->getPayment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::PISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::PISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $payment = ::Object::PaymentRequest->new(); # PaymentRequest | Payment ID

eval { 
    my $result = $api_instance->getPayment(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, payment => $payment);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PISApi->getPayment: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .PISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
payment =  # PaymentRequest | Payment ID

try: 
    # Get the status of payment
    api_response = api_instance.get_payment(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, payment)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PISApi->getPayment: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
payment *
{

Klasa zapytania o status płatności / Payment Request Class

Required: requestHeader,transactionId
requestHeader:
{

Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class

Required: token
token:
requestId:
userAgent:
ipAddress:
sendDate:
tppId:
}
transactionId:
string maxLength:14

Identyfikator płatności / Transaction ID

}

Responses

Status: 200 - Success

{

Klasa odpowiedzi na pytanie o płatność / Payment Get Response Class

Required: detailedStatus,generalStatus,responseHeader,transactionId
detailedStatus:
string

Szczegółowy status płatności / Detailed payment status

generalStatus:
string

Słownik statusów płatnośći

Enum: submitted, cancelled, pending, done, rejected
transactionId:
string

Identyfiaktor płatności / Transaction ID

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

nonEEA

Initiate non SEPA foreign transfers


/v1.0/payments/v1.0/nonEEA

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/payments/v1.0/nonEEA"
import .*;
import .auth.*;
import .model.*;
import .api.PISApi;

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

public class PISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        PISApi apiInstance = new PISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        PaymentNonEEARequest nonEEARequest = ; // PaymentNonEEARequest | Data for non SEPA foreign transfer
        try {
            AddPaymentResponse result = apiInstance.nonEEA(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, nonEEARequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PISApi#nonEEA");
            e.printStackTrace();
        }
    }
}
import .api.PISApi;

public class PISApiExample {

    public static void main(String[] args) {
        PISApi apiInstance = new PISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        PaymentNonEEARequest nonEEARequest = ; // PaymentNonEEARequest | Data for non SEPA foreign transfer
        try {
            AddPaymentResponse result = apiInstance.nonEEA(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, nonEEARequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PISApi#nonEEA");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
PaymentNonEEARequest *nonEEARequest = ; // Data for non SEPA foreign transfer

PISApi *apiInstance = [[PISApi alloc] init];

// Initiate non SEPA foreign transfers
[apiInstance nonEEAWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    nonEEARequest:nonEEARequest
              completionHandler: ^(AddPaymentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.PISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var nonEEARequest = ; // {PaymentNonEEARequest} Data for non SEPA foreign transfer


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.nonEEA(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, nonEEARequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class nonEEAExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var nonEEARequest = new PaymentNonEEARequest(); // PaymentNonEEARequest | Data for non SEPA foreign transfer

            try
            {
                // Initiate non SEPA foreign transfers
                AddPaymentResponse result = apiInstance.nonEEA(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, nonEEARequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PISApi.nonEEA: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$nonEEARequest = ; // PaymentNonEEARequest | Data for non SEPA foreign transfer

try {
    $result = $api_instance->nonEEA($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $nonEEARequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PISApi->nonEEA: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::PISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::PISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $nonEEARequest = ::Object::PaymentNonEEARequest->new(); # PaymentNonEEARequest | Data for non SEPA foreign transfer

eval { 
    my $result = $api_instance->nonEEA(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, nonEEARequest => $nonEEARequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PISApi->nonEEA: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .PISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
nonEEARequest =  # PaymentNonEEARequest | Data for non SEPA foreign transfer

try: 
    # Initiate non SEPA foreign transfers
    api_response = api_instance.non_eea(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, nonEEARequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PISApi->nonEEA: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
nonEEARequest *
{

Klasa zlecenia przelewu zagranicznego innego niż SEPA / NonEEA Transfer Request Class

Required: deliveryMode,recipient,recipientBank,requestHeader,sender,tppTransactionId,transferData
requestHeader:
{

Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class

Required: token
apiKey:
callbackURL:
token:
tppId:
sendDate:
ipAddress:
userAgent:
requestId:
}
recipient:
{

Klasa zawierająca dane odbiorcy używana w żądaniach PIS dla operacji zagranicznych / PIS foreign Recipient Data Class

Required: accountNumber,name
accountNumber:
name:
address:
}
recipientBank:
{

Klasa zawierająca dane banku używana w żądaniach AIS / AIS Bank Data Class

bicOrSwift:
name:
code:
countryCode:
address:
}
sender:
{

Klasa zawierająca dane nadawcy używana w żądaniach PIS / PIS Sender Data Class

Required: accountNumber
accountNumber:
name:
}
transferData:
{

Klasa zawierająca dane przelewu / Transfer Data Class

Required: amount,currency,description
currency:
description:
amount:
}
transferCharges:
string maxLength:3

Klauzula kosztowa / The cost clause

tppTransactionId:
string maxLength:64

ID transakcji nadany przez TPP / Transaction ID (TPP)

deliveryMode:
string

Tryb pilności / Urgency mode

Enum: ExpressD0, UrgentD1, StandardD2
system:
string

Droga jaką przelew ma być rozliczony / The way the transfer should be settled

Enum: Swift
hold:
boolean

Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded

}

Responses

Status: 200 - Success

{

Klasa odpowiedzi zlecenia płatności / Payment Add Response Class

Required: detailedStatus,generalStatus,responseHeader,transactionId
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
transactionId:
string

Identyfiaktor płatności / Transaction ID

generalStatus:
string

Słownik statusów płatnośći

Enum: submitted, cancelled, pending, done, rejected
detailedStatus:
string

Status płatności / Detailed payment status

}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

tax

Initiate tax transfer


/v1.0/payments/v1.0/tax

Usage and SDK Samples

curl -X POST "https://localhost:443/v1.0/payments/v1.0/tax"
import .*;
import .auth.*;
import .model.*;
import .api.PISApi;

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

public class PISApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: xs2a_auth
        OAuth xs2a_auth = (OAuth) defaultClient.getAuthentication("xs2a_auth");
        xs2a_auth.setAccessToken("YOUR ACCESS TOKEN");

        PISApi apiInstance = new PISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        PaymentTaxRequest taxRequest = ; // PaymentTaxRequest | Data for tax transfer
        try {
            AddPaymentResponse result = apiInstance.tax(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, taxRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PISApi#tax");
            e.printStackTrace();
        }
    }
}
import .api.PISApi;

public class PISApiExample {

    public static void main(String[] args) {
        PISApi apiInstance = new PISApi();
        String authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
        String acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
        String acceptLanguage = acceptLanguage_example; // String | Prefered language of response
        String acceptCharset = acceptCharset_example; // String | UTF-8
        String xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
        PaymentTaxRequest taxRequest = ; // PaymentTaxRequest | Data for tax transfer
        try {
            AddPaymentResponse result = apiInstance.tax(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, taxRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PISApi#tax");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: xs2a_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
String *acceptEncoding = acceptEncoding_example; // Gzip, deflate
String *acceptLanguage = acceptLanguage_example; // Prefered language of response
String *acceptCharset = acceptCharset_example; // UTF-8
String *xJWSSIGNATURE = xJWSSIGNATURE_example; // Detached JWS signature of the body of the payload
PaymentTaxRequest *taxRequest = ; // Data for tax transfer

PISApi *apiInstance = [[PISApi alloc] init];

// Initiate tax transfer
[apiInstance taxWith:authorization
    acceptEncoding:acceptEncoding
    acceptLanguage:acceptLanguage
    acceptCharset:acceptCharset
    xJWSSIGNATURE:xJWSSIGNATURE
    taxRequest:taxRequest
              completionHandler: ^(AddPaymentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PolishApi = require('polish_api');
var defaultClient = PolishApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: xs2a_auth
var xs2a_auth = defaultClient.authentications['xs2a_auth'];
xs2a_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new PolishApi.PISApi()

var authorization = authorization_example; // {String} The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.

var acceptEncoding = acceptEncoding_example; // {String} Gzip, deflate

var acceptLanguage = acceptLanguage_example; // {String} Prefered language of response

var acceptCharset = acceptCharset_example; // {String} UTF-8

var xJWSSIGNATURE = xJWSSIGNATURE_example; // {String} Detached JWS signature of the body of the payload

var taxRequest = ; // {PaymentTaxRequest} Data for tax transfer


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.tax(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, taxRequest, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class taxExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: xs2a_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PISApi();
            var authorization = authorization_example;  // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
            var acceptEncoding = acceptEncoding_example;  // String | Gzip, deflate
            var acceptLanguage = acceptLanguage_example;  // String | Prefered language of response
            var acceptCharset = acceptCharset_example;  // String | UTF-8
            var xJWSSIGNATURE = xJWSSIGNATURE_example;  // String | Detached JWS signature of the body of the payload
            var taxRequest = new PaymentTaxRequest(); // PaymentTaxRequest | Data for tax transfer

            try
            {
                // Initiate tax transfer
                AddPaymentResponse result = apiInstance.tax(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, taxRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PISApi.tax: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: xs2a_auth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PISApi();
$authorization = authorization_example; // String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
$acceptEncoding = acceptEncoding_example; // String | Gzip, deflate
$acceptLanguage = acceptLanguage_example; // String | Prefered language of response
$acceptCharset = acceptCharset_example; // String | UTF-8
$xJWSSIGNATURE = xJWSSIGNATURE_example; // String | Detached JWS signature of the body of the payload
$taxRequest = ; // PaymentTaxRequest | Data for tax transfer

try {
    $result = $api_instance->tax($authorization, $acceptEncoding, $acceptLanguage, $acceptCharset, $xJWSSIGNATURE, $taxRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PISApi->tax: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::PISApi;

# Configure OAuth2 access token for authorization: xs2a_auth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::PISApi->new();
my $authorization = authorization_example; # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
my $acceptEncoding = acceptEncoding_example; # String | Gzip, deflate
my $acceptLanguage = acceptLanguage_example; # String | Prefered language of response
my $acceptCharset = acceptCharset_example; # String | UTF-8
my $xJWSSIGNATURE = xJWSSIGNATURE_example; # String | Detached JWS signature of the body of the payload
my $taxRequest = ::Object::PaymentTaxRequest->new(); # PaymentTaxRequest | Data for tax transfer

eval { 
    my $result = $api_instance->tax(authorization => $authorization, acceptEncoding => $acceptEncoding, acceptLanguage => $acceptLanguage, acceptCharset => $acceptCharset, xJWSSIGNATURE => $xJWSSIGNATURE, taxRequest => $taxRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PISApi->tax: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: xs2a_auth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .PISApi()
authorization = authorization_example # String | The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
acceptEncoding = acceptEncoding_example # String | Gzip, deflate
acceptLanguage = acceptLanguage_example # String | Prefered language of response
acceptCharset = acceptCharset_example # String | UTF-8
xJWSSIGNATURE = xJWSSIGNATURE_example # String | Detached JWS signature of the body of the payload
taxRequest =  # PaymentTaxRequest | Data for tax transfer

try: 
    # Initiate tax transfer
    api_response = api_instance.tax(authorization, acceptEncoding, acceptLanguage, acceptCharset, xJWSSIGNATURE, taxRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PISApi->tax: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
The value of the Authorization header should consist of 'type' + 'credentials', where for the approach using the 'type' token should be 'Bearer'.
Required
Accept-Encoding*
String
Gzip, deflate
Required
Accept-Language*
String
Prefered language of response
Required
Accept-Charset*
String
UTF-8
Required
X-JWS-SIGNATURE*
String
Detached JWS signature of the body of the payload
Required
Body parameters
Name Description
taxRequest *
{

Klasa zlecenia przelewu podatkowego / Tax Transfer Request Class

Required: deliveryMode,recipient,requestHeader,sender,tppTransactionId,transferData
requestHeader:
{

Klasa zawierająca informacje o PSU and callback URL / PSU and callback URL Information Class

Required: token
apiKey:
callbackURL:
token:
tppId:
sendDate:
ipAddress:
userAgent:
requestId:
}
recipient:
{

Klasa zawierająca dane odbiorcy używana w żądaniach PIS dla operacji podatkowych / PIS Tax Recipient Data Class

Required: accountNumber,address
accountNumber:
address:
}
sender:
{

Klasa zawierająca dane nadawcy używana w żądaniach PIS / PIS Sender Data Class

Required: accountNumber
accountNumber:
name:
}
transferData:
{

Klasa zawierająca dane przelewu / Transfer Data Class

Required: amount,currency,description
currency:
description:
amount:
}
usInfo:
{

Klasa informacji danych dla przelewu podatkowego do Urzędu Skarbowego lub Izby Celnej / Tax Transfer

Required: formCode,payerInfo,periodId,periodType,year
payerInfo:
formCode:
periodId:
periodType:
year:
obligationId:
}
tppTransactionId:
string maxLength:64

ID transakcji nadany przez TPP / Transaction ID (TPP)

deliveryMode:
string

Tryb pilności / Urgency mode

Enum: ExpressD0, StandardD1
system:
string

Droga jaką przelew ma być rozliczony / The way the transfer should be settled

Enum: Elixir, ExpressElixir
hold:
boolean

Czy założyć blokadę (w przypadku np. zlecenia przelewu w dniu wolnym) / Indicates if payment should be holded

}

Responses

Status: 200 - Success

{

Klasa odpowiedzi zlecenia płatności / Payment Add Response Class

Required: detailedStatus,generalStatus,responseHeader,transactionId
responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
transactionId:
string

Identyfiaktor płatności / Transaction ID

generalStatus:
string

Słownik statusów płatnośći

Enum: submitted, cancelled, pending, done, rejected
detailedStatus:
string

Status płatności / Detailed payment status

}
Name Type Format Description
Content-Encoding String Gzip, deflate
X-JWS-SIGNATURE String Detached JWS signature of the body of the response

Status: 400 - Bad request

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 401 - Authorization header not found

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 403 - Access denied

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 422 - Unprocessable entity

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 429 - Request limit for the requested service exceeded

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Status: 500 - An unexpected error occured

{

Klasa zawierająca informacje o zwracanym błędzie / Error class

responseHeader:
{

Klasa zawierająca zwrotne metadane / Metadata Class

requestId:
string

Identyfikator żądania / Request ID

sendDate:
string (datetime)

Data odpowiedzi, format: 2017-11-24T14:13:05.424Z / Send date

}
code:
string

Kod błędu / Error code

message:
string

Opis błędu / Error message

}

Generated 2018-04-17T15:03:23.808+02:00