NAV Navbar
Priora logo

Getting Started

Registration & API Keys

Generate RSA key pair

openssl genrsa -out private.pem 2048
openssl rsa -pubout -in private.pem -out public.pem
  1. Go to 7167983120 and input your bank’s name, your email, and password.
  2. Confirm your email address.
  3. Provide your business details, such as legal name, address, and phone number.
  4. Read and agree to Terms of Service.

After successful registration you may proceed to configure your Provider account.

  1. Go to your connection details tab and save your app_id and app_secret. Please note that you may generate a new app_secret at any moment.
  2. Provide the URL of your Connector implementation. This will be used to forward client requests to your bank.
  3. Generate public/private key pair.
  4. Go to your profile security tab and paste your public key there. This key will be used to validate requests that come to Priora from your Connector instance.

Definitions

Term Definition
AISP Account Information Service Provider. A Client application that allows a Customer to list account and holder information.
Client A 3rd party financial application.
Connector Proxy interface before Bank’s Core API.
Customer A bank account holder.
PISP Payment Initiation Service Provider. A Client application that allows a Customer to initiate payments on their behalf.
Provider Any registered bank or financial institution.
Session Any activity that is forwarded by Priora to Connector on behalf of a Customer.
Scopes A set of permissions granted to a Client application.

Configure authorization types

In order to be able to authorize Customers, Bank should provide information regarding authorization types supported by Connector. This can be done via 3184184646.

Authorization Types Tab

Proceed to adding a new authorization type by clicking Add button. Please, make sure that code field is unique in terms of authorization types supported by your bank as it will be used by Priora to identify said authorization type.

New Test Authorization Type Form

The form will contain 3 fields.

Field Example Meaning
Code login_password This field will be used by third party applications to communicate selected authorization type to Priora.
Display name Login & Password This field will be used by third party applications to present in Customer User Interface. Note that this field may be in any language, depending on Provider’s country.
Instruction Use web-banking credentials. This field will be used by third party application to prompt Customers with a hint on how to proceed with authorization.

After submitting this form you will be able to add both required and interactive fields as well as modify freshly added authorization type.

844-801-0634

You will have to proceed by adding either a required or MFA(Interactive) field.

Add Fields

Both forms contain the same set of fields.

Field Meaning
Code Used by third party applications to wrap values provided by Customer that will be sent to Connector.
Display name Used by third party applications as a placeholder for said field.
Type Used by third party applications to determine required HTML input type for said field.
Optional Used by third party applications to determine whether the field is optional or not.

Configure payment templates

To be able to carry out payments payment templates should be configured first. A payment template is a structure that corresponds to a payment type supported by the bank. These templates will be exposed to TPPs.

Payment Templates

Any template can be switched between enabled and disabled states, which toggles its visibility to TPPs. In addition, a template may be removed. This action keeps the template for reference purpose, but marks it as removed permanently, rendering it unusable further on.

Each template contains three properties which are mandatory for configuration.

Field Meaning
Description Human readable description that will be shown to Customers.
Payment type Unique template identifier which will be forwarded to your Connector along with required payment attributes.
Default Should be ticked if a specific template should be selected by default.

After a template has been created payment attributes may be attached to said template.

Payment Attributes

A payment attributes should have name, label, type configured, along with possible values and whether it is optional or not.

Field Meaning
Name Unique attribute identifier, will be used by TPPs to wrap values.
Label A human readable name, will be used by TPPs to show it to Customer.
Optional States whether the attribute is optional.
Type Type of attribute, may be text, number, dropdown.
Values Optional field, allows predefining possible values, only works with dropdown type.

Order in which attributes should appear may be selected on template configuration page.

Request signature

Priora public key

  

All requests that are either forwarded by or originated on Priora will be signed using Priora’s public key in the form of a JSON Web Token containing exp and data claims. Data may include original request parameters that were sent to Priora by Client applications. This is done to ensure that no Man-in-the-Middle attacks have occurred during request life cycle and that no data was tampered on its way from Client to Priora to Connector. In seldom cases along parameters encoded into JWT there will be regular HTTP parameters.

Data claim may contain request parameters from Priora as well as original request parameters in form of another JWT signed with Client application’s private key.

Original request parameters

Description

All requests that are forwarded by Priora are signed by Client applications. In order to decode the client_jwt, Connector has to perform the following request to obtain client’s public key. The client_id is present in HTTP_CLIENT_ID header along with HTTP_AUTHORIZATION header.

Verb and Path

GET api/connectors/v1/clients/info?client_id=123

Headers

Name Type Description
HTTP_APP_ID string Provider’s app_id from connection details tab.
HTTP_APP_SECRET string Provider’s app_secret from connection details tab
HTTP_AUTHORIZATION string A JSON Web Token containing exp and payload, signed using Provider’s private key and preceded by grant type Bearer.

Reponse

Example of response

  {
    "name": "client_name",
    "scopes": ["accounts", "transactions", "kyc"],
    "public_key": "client_public_key"
  }
Field Type Description
name string Represents Client name.
scopes array Represents scopes allowed to Client.
public_key string Will be used for verifying Client JWT.

Callback errors

During any request or flow originating either on Client or Priora side a number of errors may appear. In order to standardize errors while still giving some degree of freedom in explaining an error callback parameters should include both error_class and error_message. Error message serves the purpose of communicating the issue to the End-Customer, whereas error class should be used by Clients in order to be able to handle various scenarios.

Contents of the error_message are entirely up to the Provider, they may even be localized. However, values sent within error_class parameter should be from the standardized list. This list may and will be extended over time.

Error Class Meaning
InvalidAuthorizationType Authorization type specified in request is not supported for specified type of operation.
TokenNotFound Token specified in request does not exist or cannot be retrieved.
InvalidCredentials During authorization process a wrong set of credentials has been supplied. This class applies to MFA values as well.
AuthorizationMissing Authorization header is missing.
InvalidPaymentAttributes Attributes supplied for a payment order are not supported.
UnknownConfirmationFlow Confirmation flow used for a payment cannot be found or is not supported.
InvalidAttributeValue Value supplied under specified attribute name is invalid.
InvalidPaymentAccount Account specified as source for a payment order cannot be used by current Customer to carry out payments.
InsufficientFunds There are not enough funds to carry out a payment for a specified source.
InvalidConfirmationCode Confirmation code supplied for a payment does not match the expected one.
InvalidPaymentType Payment type specified in request is not supported.

API Endpoints

In order to receive callbacks as well as Client request forwards, Connector must implement all of the following endpoints. These should respond to and with JSON payloads.

Endpoint Verb Purpose
/api/priora/v1/tokens/create POST Create a new token instance to gather bank data
/api/priora/v1/tokens/confirm POST Confirm an existing token
/api/priora/v1/tokens/revoke POST Revoke an existing token, rendering it unusable further on
/api/priora/v1/tokens/cancel POST Cancel a token before confirmation
/api/priora/v1/tokens/refresh POST Refresh an expired access token
/api/priora/v1/payments/show GET Get all information related to a payment, be it one in progress, or long executed
/api/priora/v1/payments/create POST Initiate a payment request that requires confirmation
/api/priora/v1/payments/confirm POST Confirm an existing payment request
/api/priora/v1/payments/cancel POST Cancel a payment before confirmation
/api/priora/v1/kyc GET Returns holder information associated with Customer
/api/priora/v1/accounts GET Returns Customer’s accounts
/api/priora/v1/transactions GET Returns Customer’s transactions within the scope of an account

Access Token Scopes

Type Description
payments grants application right to initiate payments on User’s behalf
accounts grants application access to User’s accounts within specific Bank
transactions grants application access to transactions listed under specific account
kyc grants application access to view User’s KYC data
sign_in used to identify User on Priora

Tokens

Create

Description

This endpoint is used to create an access token with a set of access rights, named scopes. As a result, Connector should send a callback to Priora with result of the operation, be it success, fail or request for additional steps.

Path

/api/priora/v1/tokens/create

Verb

POST

Headers

Name Type Description
Authorization string A JSON Web Token containing exp and data claims, signed using Priora private key and preceded by grant type Bearer.
Client-Id string Client application identifier. This header serves to identify request origin, and consequently public key that should be used for original request verification.

Unpacked Authorization

Example of unpacked Authorization header

{
  "data": {
    "session_secret": "c8cd1d553e4c68b0_1510323410",
    "original_request": {
      "provider_code": "demobank",
      "credentials": {
        "login": "test",
        "password": "test",
        "authorization_type": "login_password_confirmation"
      },
      "scopes": ["accounts", "transactions", "kyc"],
      "public_key": "-----BEGIN PUBLIC KEY-----
                    MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzP1HQdGp2Q9rGMg0ExWW
                    MhnH7/03dEe74WK8bxzCG5zX7WorpI9ue2+4WryAw3Sz5uGlxmIopMOdR6fFGj+D
                    7d0VUlCGM37XQA5MXdA437yi5mjL7vp/vuWB/c/EzHvp6d+8G0DE93AMT6mTmFbt
                    YFDYlemaCay8Hq4c7tQvU4kbj3QWRAldV76SvcT7J/HH+ZN4si611lHM7C2PVfmR
                    o2KAR6Ou3S/y4LkTCBxo5p+Cb6Sa4AY4xaVCVLy4LNgMFlpNpxKpdP0EQYMBEV9b
                    e+rl3nemlwXHILKB2HqS2rh3AQ/juIlw+5EAu1powgR3/VXIMFoYw10XQbR6/0z
                    BwIDAQAB
                    -----END PUBLIC KEY-----"
    }
  },
  "exp": ...
}

To unpack Authorization header, Connector has first to verify Priora signature using its public key, then verify original request. To verify original request please use one of the following.

Scopes Algorithm Key
other RS256 Client application public key.
Field Type Description
session_secret string Represents Priora session identifier.
original_request object May include client_jwt key or a set key-value pairs representing original request parameters.
credentials object Wraps Customer credentials, it is used for both first(e.g. login, password) and second factors(e.g. one time password). Contents may vary depending on authorization types supported by your Bank.
authorization_type string Specifies authorization type that was used for token creation.
scopes array Specifies set of permissions that will be attributed to the access token.

Confirm

Description

This endpoint is used for processing additional interactive steps in the process of access token creation. As a result, Connector should send a callback to Priora with result of the operation, be it success, fail or request for additional steps.

Path

/api/priora/v1/tokens/confirm

Verb

POST

Headers

Name Type Description
Authorization string A JSON Web Token containing exp and data claims, signed using Priora private key and preceded by grant type Bearer.
Client-Id string Client application identifier. This header serves to identify request origin, and consequently public key that should be used for original request verification.

Unpacked Authorization

Example of unpacked Authorization header

{
  "data": {
    "session_secret": "c8cd1d553e4c68b0_1510323410",
    "original_request": {
      "credentials": {
        "confirmation_code": "9937fe"
      }
    }
  },
  "exp": ...
}

To unpack Authorization header, Connector has first to verify Priora signature using its public key, then verify original request. To verify original request please use one of the following.

Scopes Algorithm Key
other RS256 Client application public key.
Field Type Description
session_secret string Represents Priora session identifier.
original_request object May include client_jwt key or a set key-value pairs representing original request parameters.
credentials object Wraps Customer credentials, it is used for both first(e.g. login, password) and second factors(e.g. one time password). Contents may vary depending on authorization types supported by your Bank.

Revoke

Description

This endpoint is used to revoke an already existing and active access token. As a result, Connector should send a call back to Priora.

Path

/api/priora/v1/tokens/revoke

Verb

POST

Headers

Name Type Description
Authorization string A JSON Web Token containing exp and data claims, signed using Priora private key and preceded by grant type Bearer.
Access-Token string An access token with a set of permissions. Required permissions for this action are either accounts or payments, the former resulting in a list of all available accounts and the latter in a list of accounts available for payment initiation.

Unpacked Authorization

To unpack Authorization header, Connector has first to verify Priora signature using its public key, then verify original request. To verify original request please use one of the following.

Scopes Algorithm Key
other RS256 Client application public key.

Callbacks

Actions create and confirm must result into any of the following callbacks to Priora.

Headers

All callbacks should contain App-Id, App-Secret, and Authorization headers.

Success

Success callback should be used when all required verification steps have been passed, and therefore access token may be granted.

Request

POST /priora.saltedge.com/api/connectors/v1/sessions/success

Signature and parameters

HTTP parameters as well as JWT payload wrapped in data key

{
  "extra": {},
  "user_id": "9",
  "token": "EDPsX9hWE0cakRhBhB8F6XWu69MU5R8cG0h7HzuYcdU",
  "token_expires_at": "2017-12-12T14:46:50.000Z",
  "session_secret": "5155726ffcc689ca_1510584410"
}
Parameter Type Description
extra object Extra details that should be persisted into session.
user_id string Customer identifier on Connector side. Used to map Priora customers to Connector ones.
token string Access token that will be used to access Bank data.
token_expires_at string Token expiry date.
refresh_token string Optional token which can be used to refresh an expired access token.
session_secret string Session identifier on Priora.

Update

Update callback may be called multiple times in order to request multiple steps of authorization or to send other updates to Priora session.

Request

POST /priora.saltedge.com/api/connectors/v1/sessions/update

Signature and parameters

HTTP parameters as well as JWT payload wrapped in data key

{
  "extra": {
    "authorization_type_code": "sms_pin",
    "mfa_field_code": "sms_pincode"
  },
  "user_id": "9",
  "status": "waiting_confirmation_code",
  "session_secret": "5155726ffcc689ca_1510584410"
}
Parameter Type Description
extra object Extra details that should be persisted into session.
authorization_type_code string Specifies authorization type that is currently used for token creation/confirmation.
mfa_field_code string Specifies interactive field that Customer should be prompted with.
user_id string Customer identifier on Connector side. Used to map Priora customers to Connector ones.
status string Conveys current status of the operation.
session_secret string Session identifier on Priora.

Fail

Fail callback should be used when authorization process has been compromised for any reason: broken request, invalid credentials, etc.

Request

POST /priora.saltedge.com/api/connectors/v1/sessions/fail

Signature and parameters

HTTP parameters as well as JWT payload wrapped in data key

{
  "extra": {},
  "error_message": "There is no user in our system that matches supplied username and password.",
  "error_class": "InvalidCredentials",
  "session_secret": "c3f129cd0c986925_1510584579"
}
Parameter Type Description
extra object Extra details that should be persisted into session.
error_message string Conveys the reason of failure in human readable text.
error_class string Class of failure.
session_secret string Session identifier on Priora.

Cancel

Description

This endpoint is used to cancel any access token that is in the process of enrollment, meaning it has not been confirmed yet.

Path

/api/priora/v1/tokens/cancel

Verb

POST

Headers

Name Type Description
Authorization string A JSON Web Token containing exp and data claims, signed using Priora private key and preceded by grant type Bearer.
Access-Token string An access token with a set of permissions.

Unpacked Authorization

Unpacked Authorization

{
  "data": {
    "session_secret": "c3f129cd0c986925_1510584579"
  }
  "exp": ...
}

To unpack Authorization header, Connector has first to verify Priora signature using its public key, then verify original request. To verify original request please use one of the following.

Scopes Algorithm Key
other RS256 Client application public key.

Refresh

Description

This endpoint is used to refresh an active access token. As a result, Connector should send a direct json response that contains a new access token and time when it expires.

Path

/api/priora/v1/tokens/refresh

Verb

POST

Headers

Name Type Description
Authorization string A JSON Web Token containing exp and data claims, signed using Priora private key and preceded by grant type Bearer.
Refresh-Token string A refresh token which is issued together with access token and, later on, is used to request a refresh of an expired access token.
{ "data": {
    "token": "ky98J36vVgVD4iIwWEcArT1kIsXQhSFbwatZmYvF_y4",
    "expires_at": "2018-02-02T13:01:08.000Z"
  }
}

Unpacked Authorization

To unpack Authorization header, Connector has first to verify Priora signature using its public key, then verify original request. To verify original request please use one of the following.

Scopes Algorithm Key
other RS256 Client application public key.

Payments

Show

Description

This endpoint is used to fetch all data relevant to a payment including fees, status and other. Response of this action should contain a corresponding payment object in JSON format.

Path

/api/priora/v1/payments/show

Verb

GET

Headers

Name Type Description
Authorization string A JSON Web Token containing exp and data claims, signed using Priora private key and preceded by grant type Bearer.
Access-Token string An access token with a set of permissions. Required permission for this action is payments.

Unpacked Authorization

Example of unpacked Authorization

{
  "data": {
    "payment_id": 193,
  },
  "exp": ...
}
Parameter Type Description
payment_id integer Payment identifier on Connector side.

Response

Example of response

{
  "data": {
    "id": 193,
    "total": 12.5522,
    "amount": 12.11,
    "description": "water",
    "currency_code": "EUR",
    "status": "confirmed",
    "fees": [
      {
        "code": "operational",
        "amount": 0.2,
        "description": "Transfer fee.",
        "currency_code": "EUR"
      },
      {
        "code": "service",
        "amount": 0.2422,
        "description": "Service usage fee.",
        "currency_code": "EUR"
      }
      ],
    "extra": {},
    "iban_from": "DE12345678123456781233",
    "iban_to": "DE12345678123456781232",
    "priora_payment_id": 119
  }
}
Attribute Description
id Payment identifier on Connector.
total Total amount paid.
amount Amount specified in payment.
description Payment description.
currency_code Payment currency.
status Status of payment.
fees List of all fees applied to given payment.
extra Any information deemed relevant to given payment.
iban_from Payment origin account.
iban_to Payment destination account.
priora_payment_id Identifier of the corresponding payment on Priora side.

Create

Description

This endpoint is used to create a payment. As a result, Connector should send a callback to Priora with result of the operation, be it success, fail or request for additional steps.

Path

/api/priora/v1/payments/create

Verb

POST

Headers

Name Type Description
Authorization string A JSON Web Token containing exp and data claims, signed using Priora private key and preceded by grant type Bearer.
Access-Token string An access token with a set of permissions. Required permission for this action is payments.
Client-Id string Client application identifier on Priora. Should be used to get public key for Authorization header validation.

Unpacked Authorization

Example of unpacked Authorization

{
  "data": {
    "priora_payment_id": 119,
    "payment_type": "transfer",
    "original_request": {
      "payment_attributes": {
        "iban_from": "DE12345678123456781233",
        "iban_to": "DE12345678123456781232",
        "amount": "12.11",
        "currency_code": "EUR",
        "description": "water",
        "information": ""
      },
      "template_id": "3",
      "provider_code": "demobank",
      "extra": {},
      "force_sca": true / optional
    }
  },
  "exp": ...
}
Parameter Type Description
priora_payment_id integer Identifier of the corresponding payment on Priora side.
payment_type string Specifies the type of payment associated with a preregistered template.
original_request object Original parameters coming from Client application.
payment_attributes object Required payment attributes.
template_id string Payment template identifier on Priora side.
provider_code string Bank identifier on Priora side.
extra object Any additional information deemed relevant to a payment.
force_sca boolean Whether to disregard exemptions and force Strong Customer Authentication (SCA) as a required step to make a payment.

Confirm

Description

This endpoint is used for processing additional interactive steps in the process of payment creation. As a result, Connector should send a callback to Priora with result of the operation, be it success, fail or request for additional steps.

Path

/api/priora/v1/payments/confirm

Verb

POST

Headers

Name Type Description
Authorization string A JSON Web Token containing exp and data claims, signed using Priora private key and preceded by grant type Bearer.
Access-Token string An access token with a set of permissions. Required permission for this action is payments.
Client-Id string Client application identifier on Priora. Should be used to get public key for Authorization header validation.

Unpacked Authorization

Example of unpacked Authorization

{
  "data": {
    "priora_payment_id": 120,
    "payment_id": "194",
    "original_request": {
      "credentials": {
        "confirmation_code": "123abc"
      }
    }
  },
  "exp": ...
}
Parameter Type Description
priora_payment_id integer Identifier of the corresponding payment on Priora side.
payment_id string Payment identifier on Connector side.
original_request object Original parameters coming from Client application.
credentials object Present if payment has to be confirmed via confirmation code.

Callbacks

Actions create and confirm must result into any of the following callbacks to Priora.

Headers

All callbacks should contain App-Id, App-Secret, and Authorization headers.

Success

Success callback should be used when all verification procedures have passed and the payment has been carried out.

Request

POST /priora.saltedge.com/api/connectors/v1/payments/success

Signature and parameters

HTTP parameters as well as JWT payload wrapped in data key

{
  "extra": {},
  "priora_payment_id": 123,
  "payment_id": "195"
}

Parameter Type Description
extra object Extra details that should be persisted into session.
payment_id string Payment identifier on Connector side. Used to map Priora payments to Connector ones.
priora_payment_id integer Payment identifier on Priora.

Update

Update callback may be called multiple times in order to request multiple steps of authorization or to send other updates to Priora session.

Request

POST /priora.saltedge.com/api/connectors/v1/payments/update

Signature and parameters

HTTP parameters as well as JWT payload wrapped in data key

{
  "extra": {},
  "payment_id": "195",
  "status": "waiting_confirmation_code",
  "confirmation_code": "fd8e50",
  "priora_payment_id": 121
}

Parameter Type Description
extra object Extra details that should be persisted into session.
payment_id string Payment identifier on Connector side. Used to map Priora payments to Connector ones.
priora_payment_id integer Payment identifier on Priora.
status string Current status of the payment.

Fail

Fail callback should be used when authorization process has been compromised for any reason: broken request, invalid credentials, etc.

Request

POST /priora.saltedge.com/api/connectors/v1/payments/fail

Signature and parameters

HTTP parameters as well as JWT payload wrapped in data key

{
  "extra": {},
  "error_message": "Amount cannot be negative.",
  "error_class": "InvalidAttributeValue",
  "priora_payment_id": 122,
  "payment_id": "195" / optional
}
Parameter Type Description
extra object Extra details that should be persisted into session.
error_message string Conveys the reason of failure in human readable text.
error_class string Class of failure.
payment_id string Payment identifier on Connector side. Used to map Priora payments to Connector ones. This field is optional.
priora_payment_id string Payment identifier on Priora.

Cancel

Description

This endpoint is used to cancel any payment that is in the process of creation, meaning it has not been confirmed yet.

Path

/api/priora/v1/payments/cancel

Verb

POST

Headers

Name Type Description
Authorization string A JSON Web Token containing exp and data claims, signed using Priora private key and preceded by grant type Bearer.
Access-Token string An access token with a set of permissions. Required permissions for this action is payments.

Unpacked Authorization

Unpacked Authorization

{
  "data": {
    "payment_id": "125"
  }
  "exp": ...
}

To unpack Authorization header, Connector has first to verify Priora signature using its public key, then verify original request. To verify original request please use one of the following.

Scopes Algorithm Key
other RS256 Client application public key.

Know Your Customer(KYC)

Show

Description

This endpoint is used to extract Customer’s personal data. Response should contain a JSON object representing a Customer.

Path

/api/priora/v1/kyc

Verb

GET

Params

None

Headers

Name Type Description
Authorization string A JSON Web Token containing exp and data claims, signed using Priora private key and preceded by grant type Bearer.
Access-Token string An access token with a set of permissions. Required permission for this action is kyc.

Response

Example response

{
  "data": {
    "name": "John Smith",
    "email": "test@example.com",
    "phone": "xxx-xxx-5409",
    "address": "1600 Amphitheatre Parkway, Mountain View, CA, USA",
    "date_of_birth": "1985-12-12"
  }
}

Contains information about Customer.

Attribute Type Description
name string Customer’s full name.
email string Customer’s email.
phone string Customer’s phone number.
address string Customer’s address.
date_of_birth string Customer’s date of birth.

Accounts

List

Description

This endpoint is used to fetch list of accounts belonging to a Customer and all relevant information about them. Accounts available for making payments will be flagged accordingly.

Path

/api/priora/v1/accounts

Verb

GET

Params

None

Headers

Name Type Description
Authorization string A JSON Web Token containing exp and data claims, signed using Priora private key and preceded by grant type Bearer.
Access-Token string An access token with a set of permissions. Required permissions for this action are either accounts or payments, the former resulting in a list of all available accounts and the latter in a list of accounts available for payment initiation.

Response

Example response

{
  "data": [
    {
      "id": "29",
      "name": "Visa",
      "number": "321123",
      "currency_code": "EUR",
      "sort_code": "11-22-33",
      "iban": "DE12345678123456781231",
      "nature": "credit_card",
      "payment_account": true,
      "balance": "1234.1",
      "available_amount": "8765.9",
      "credit_limit": "10000.0",
      "extra": { "credit_limit": "3420.0" }
    },
    {
      "id": "30",
      "name": "MasterCard",
      "number": "554444",
      "currency_code": "EUR",
      "sort_code": "22-33-44",
      "iban": "DE12345678123456781232",
      "nature": "credit_card",
      "payment_account": true,
      "balance": "1843.0",
      "credit_limit": "2500.0",
      "available_amount": "657.0",
      "extra": {}
    },
    {
      "id": "31",
      "name": "Checking account",
      "number": "643645",
      "currency_code": "EUR",
      "sort_code": "33-44-55",
      "iban": "DE12345678123456781233",
      "nature": "credit_card",
      "payment_account": true,
      "balance": "243.1",
      "available_amount": "1756.9",
      "credit_limit": "2000.0",
      "extra": {}
    },
    {
      "id": "35",
      "name": "Saving Account",
      "number": "543626",
      "currency_code": "EUR",
      "sort_code": "66-77-88",
      "iban": null,
      "nature": "savings",
      "credit_limit": null,
      "payment_account": false,
      "balance": "1240.2",
      "available_amount": "1240.2",
      "extra": {}
    }
  ]
}

Array of all accounts available to Customer.

Attribute Type Description
id string Account identifier on Connector.
name string Human readable account name.
number string Account number within Bank’s ecosystem.
currency_code string Account’s currency in ISO 4217.
sort_code string Bank codes used in British and Irish banking systems.
iban string International Bank Account Number.
nature string Type of account.
payment_account boolean Flag representing whether account can be used to initiate payments.
balance string Account balance.
available_amount string Amount available on account.
credit_limit string Is the maximum amount of credit available on account.
extra object Any information Connector deems relevant to any account.

Transactions

List

Description

This endpoint is used to fetch all transactions related to a bank account.

Path

/api/priora/v1/transactions

Verb

GET

Params

Parameter Type Description
account_id string Specifies account for which transactions should be returned.
from_date string Specifies the starting date in ISO 8601: “yyyy-mm-dd” format, from which transactions should be fetched.
to_date string Specifies the ending date in ISO 8601: “yyyy-mm-dd” format, to which transactions should be fetched. This value will always be the today’s date by default.

Headers

Name Type Description
Authorization string A JSON Web Token containing exp and data claims, signed using Priora private key and preceded by grant type Bearer.
Access-Token string An access token with a set of permissions. Required permission for this action is transactions.

Authorization

Unpacked Authorization example

{
  "data": {
    "account_id": "29",
    "from_date": "2018-06-10",
    "to_date": "2018-09-10"
  },
  "exp": ...
}

Parameter Type Description
account_id string Specifies account for which transactions should be returned.

Response

Example response

{
  "data": [
    {
      "id": "42",
      "account_id": "29",
      "currency_code": "EUR",
      "amount": "-12.0",
      "description": "ADOBE CREATIVE Debit IRELAND ON 28 FEB BDC",
      "made_on": "2018-06-10",
      "status": "posted",
      "extra": {
        "original_amount": "-14",
        "original_currency_code": "USD"
      },
      "fees":{}
    },
    {
      "id": "43",
      "account_id": "29",
      "currency_code": "EUR",
      "amount": "-9.25",
      "description": "ADOBE PHOTOGPHY Debit IRELAND",
      "made_on": "2018-07-30",
      "status": "posted",
      "extra": {
        "original_amount": "-10",
        "original_currency_code": "USD"
      },
      "fees":{}
    },
    {
      "id": "53",
      "account_id": "29",
      "currency_code": "EUR",
      "amount": "-1.2125",
      "description": "test",
      "made_on": "2018-09-10",
      "status": "posted",
      "extra": {},
      "fees": {}
    }
  ]
}

Contains information about transactions related to a specific account.

Attribute Type Description
id string Transaction identifier on Connector side.
account_id string Identifier of account to which transaction belongs.
currency_code string Transaction currency code.
amount string Transaction amount.
description string Transaction description.
made_on string Date on which transaction was initialized.
status string Transaction status.
extra object Any information deemed relevant to transaction.
fees object Fees associated with transaction.