Auth API

Authorisation API

oauth/token


/api/v1/oauth/token

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//api/v1/oauth/token?request="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthorisationApi;

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

public class AuthorisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AuthorisationApi apiInstance = new AuthorisationApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        request request = ; // request | 
        try {
            inline_response_200 result = apiInstance.apiV1OauthTokenPost(xRequestID, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationApi#apiV1OauthTokenPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthorisationApi;

public class AuthorisationApiExample {

    public static void main(String[] args) {
        AuthorisationApi apiInstance = new AuthorisationApi();
        String xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
        request request = ; // request | 
        try {
            inline_response_200 result = apiInstance.apiV1OauthTokenPost(xRequestID, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationApi#apiV1OauthTokenPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xRequestID = xRequestID_example; // ID of the request, unique to the call, as determined by the initiating party.
request *request = ; // 

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

[apiInstance apiV1OauthTokenPostWith:xRequestID
    request:request
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AuthApi = require('auth_api');
var defaultClient = AuthApi.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AuthApi.AuthorisationApi()
var xRequestID = xRequestID_example; // {{String}} ID of the request, unique to the call, as determined by the initiating party.
var request = ; // {{request}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiV1OauthTokenPost(xRequestID, request, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiV1OauthTokenPostExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AuthorisationApi();
            var xRequestID = xRequestID_example;  // String | ID of the request, unique to the call, as determined by the initiating party.
            var request = new request(); // request | 

            try
            {
                inline_response_200 result = apiInstance.apiV1OauthTokenPost(xRequestID, request);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthorisationApi.apiV1OauthTokenPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAuthorisationApi();
$xRequestID = xRequestID_example; // String | ID of the request, unique to the call, as determined by the initiating party.
$request = ; // request | 

try {
    $result = $api_instance->apiV1OauthTokenPost($xRequestID, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthorisationApi->apiV1OauthTokenPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthorisationApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthorisationApi->new();
my $xRequestID = xRequestID_example; # String | ID of the request, unique to the call, as determined by the initiating party.
my $request = ; # request | 

eval { 
    my $result = $api_instance->apiV1OauthTokenPost(xRequestID => $xRequestID, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthorisationApi->apiV1OauthTokenPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthorisationApi()
xRequestID = xRequestID_example # String | ID of the request, unique to the call, as determined by the initiating party.
request =  # request | 

try: 
    api_response = api_instance.api_v1_oauth_token_post(xRequestID, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorisationApi->apiV1OauthTokenPost: %s\n" % e)

Parameters

Header parameters
Name Description
X-Request-ID*
String
ID of the request, unique to the call, as determined by the initiating party.
Required
Query parameters
Name Description
request*
request
Required

Responses

Status: 200 - OK


oauth/authorise


/api/v1/oauth/authorise

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: */*"\
"//api/v1/oauth/authorise?response_type=&bic=&client_id=&scope=&state=&redirect_uri=&code_challenge_method=&code_challenge="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthorisationApi;

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

public class AuthorisationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        AuthorisationApi apiInstance = new AuthorisationApi();
        String bic = bic_example; // String | 
        String clientId = clientId_example; // String | 
        String scope = scope_example; // String | Available scopes: accounts consents account.lists payments funds.confirmations
        String state = state_example; // String | 
        String redirectUri = redirectUri_example; // String | 
        String codeChallenge = codeChallenge_example; // String | 
        String responseType = responseType_example; // String | 
        String codeChallengeMethod = codeChallengeMethod_example; // String | 
        try {
            apiInstance.authorise(bic, clientId, scope, state, redirectUri, codeChallenge, responseType, codeChallengeMethod);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationApi#authorise");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthorisationApi;

public class AuthorisationApiExample {

    public static void main(String[] args) {
        AuthorisationApi apiInstance = new AuthorisationApi();
        String bic = bic_example; // String | 
        String clientId = clientId_example; // String | 
        String scope = scope_example; // String | Available scopes: accounts consents account.lists payments funds.confirmations
        String state = state_example; // String | 
        String redirectUri = redirectUri_example; // String | 
        String codeChallenge = codeChallenge_example; // String | 
        String responseType = responseType_example; // String | 
        String codeChallengeMethod = codeChallengeMethod_example; // String | 
        try {
            apiInstance.authorise(bic, clientId, scope, state, redirectUri, codeChallenge, responseType, codeChallengeMethod);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationApi#authorise");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *bic = bic_example; // 
String *clientId = clientId_example; // 
String *scope = scope_example; // Available scopes: accounts consents account.lists payments funds.confirmations
String *state = state_example; // 
String *redirectUri = redirectUri_example; // 
String *codeChallenge = codeChallenge_example; // 
String *responseType = responseType_example; //  (optional) (default to code)
String *codeChallengeMethod = codeChallengeMethod_example; //  (optional) (default to S256)

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

[apiInstance authoriseWith:bic
    clientId:clientId
    scope:scope
    state:state
    redirectUri:redirectUri
    codeChallenge:codeChallenge
    responseType:responseType
    codeChallengeMethod:codeChallengeMethod
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AuthApi = require('auth_api');
var defaultClient = AuthApi.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new AuthApi.AuthorisationApi()
var bic = bic_example; // {{String}} 
var clientId = clientId_example; // {{String}} 
var scope = scope_example; // {{String}} Available scopes: accounts consents account.lists payments funds.confirmations
var state = state_example; // {{String}} 
var redirectUri = redirectUri_example; // {{String}} 
var codeChallenge = codeChallenge_example; // {{String}} 
var opts = { 
  'responseType': responseType_example, // {{String}} 
  'codeChallengeMethod': codeChallengeMethod_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.authorise(bic, clientId, scope, state, redirectUri, codeChallenge, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class authoriseExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AuthorisationApi();
            var bic = bic_example;  // String | 
            var clientId = clientId_example;  // String | 
            var scope = scope_example;  // String | Available scopes: accounts consents account.lists payments funds.confirmations
            var state = state_example;  // String | 
            var redirectUri = redirectUri_example;  // String | 
            var codeChallenge = codeChallenge_example;  // String | 
            var responseType = responseType_example;  // String |  (optional)  (default to code)
            var codeChallengeMethod = codeChallengeMethod_example;  // String |  (optional)  (default to S256)

            try
            {
                apiInstance.authorise(bic, clientId, scope, state, redirectUri, codeChallenge, responseType, codeChallengeMethod);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthorisationApi.authorise: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAuthorisationApi();
$bic = bic_example; // String | 
$clientId = clientId_example; // String | 
$scope = scope_example; // String | Available scopes: accounts consents account.lists payments funds.confirmations
$state = state_example; // String | 
$redirectUri = redirectUri_example; // String | 
$codeChallenge = codeChallenge_example; // String | 
$responseType = responseType_example; // String | 
$codeChallengeMethod = codeChallengeMethod_example; // String | 

try {
    $api_instance->authorise($bic, $clientId, $scope, $state, $redirectUri, $codeChallenge, $responseType, $codeChallengeMethod);
} catch (Exception $e) {
    echo 'Exception when calling AuthorisationApi->authorise: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthorisationApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthorisationApi->new();
my $bic = bic_example; # String | 
my $clientId = clientId_example; # String | 
my $scope = scope_example; # String | Available scopes: accounts consents account.lists payments funds.confirmations
my $state = state_example; # String | 
my $redirectUri = redirectUri_example; # String | 
my $codeChallenge = codeChallenge_example; # String | 
my $responseType = responseType_example; # String | 
my $codeChallengeMethod = codeChallengeMethod_example; # String | 

eval { 
    $api_instance->authorise(bic => $bic, clientId => $clientId, scope => $scope, state => $state, redirectUri => $redirectUri, codeChallenge => $codeChallenge, responseType => $responseType, codeChallengeMethod => $codeChallengeMethod);
};
if ($@) {
    warn "Exception when calling AuthorisationApi->authorise: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthorisationApi()
bic = bic_example # String | 
clientId = clientId_example # String | 
scope = scope_example # String | Available scopes: accounts consents account.lists payments funds.confirmations
state = state_example # String | 
redirectUri = redirectUri_example # String | 
codeChallenge = codeChallenge_example # String | 
responseType = responseType_example # String |  (optional) (default to code)
codeChallengeMethod = codeChallengeMethod_example # String |  (optional) (default to S256)

try: 
    api_instance.authorise(bic, clientId, scope, state, redirectUri, codeChallenge, responseType=responseType, codeChallengeMethod=codeChallengeMethod)
except ApiException as e:
    print("Exception when calling AuthorisationApi->authorise: %s\n" % e)

Parameters

Query parameters
Name Description
response_type
String
bic*
String
Required
client_id*
String
Required
scope*
String
Available scopes: accounts consents account.lists payments funds.confirmations
Required
state*
String
Required
redirect_uri*
String
Required
code_challenge_method
String
code_challenge*
String
Required

Responses

Status: 302 - Found

Status: 400 - Bad Request

Status: 500 - Internal Server Error