27
API.BANKING – Technical Documentation Str. Semilunei nr. 4-6, Sector 2 Bucuresti p. +40374 469 932 [email protected] www.librabank.ro

API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

  • Upload
    others

  • View
    7

  • Download
    0

Embed Size (px)

Citation preview

Page 1: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

API.BANKING – Technical Documentation

Str. Semilunei nr. 4-6, Sector 2 Bucuresti

p. +40374 469 932

[email protected] www.librabank.ro

Page 2: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

Table of Contents

I. Versions .................................................................................................................. 2

II. Glossary .................................................................................................................. 2

III. WSO2 ...................................................................................................................... 3

Store

Generate Token

ACCOUNTS_API

ACCOUNTS_DUMMY_API

PAYMENTS_API

PAYMENTS_DUMMY_API

Page 3: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

Versions

Date Version Name Descriere schimbari Tracked changes

19.11.2018 V1.0 Bogdan Golumbeanu

First documentation version NO

20.11.2018 v1.1 Vicentiu Berneanu

added supplementary explanations YES

11.12.2018 V1.2 Bogdan Golumbeanu

Add CUSTOMERS documentation YES

20.03.2019 v1.3 Bogdan Golumbeanu

Update ACCOUNT API and PAYMENTS API

YES

Glossary

Term Definition

Store The portal where the store user can manage the APIs

Store user The user configured in the store by Libra Internet Bank

Client Libra Internet Bank customer

Token Secret key used to access an API

API REST/SOAP service

Page 4: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

WSO2

Store

The Libra Internet Bank APIs can be found at https://api.librabank.ro/store. The API list is accesible in the

store based on credentials provided by us or the TPP can use the sign-up page:

https://api.librabank.ro/store/site/pages/sign-up.jag

.

Generate Token

In order to consume the APIs the cosumer application needs to generate an access token.

This can be generated using ConsumerKey and ConsumerSecret that our store users can obtain from the

store. Below is a curl command that generates an access token.

curl -k -d "grant_type=password&username={username}&password={password}&scope=default"

-H "Authorization: Basic {Base64(consumerKey:consumerSecret)}"

https://api.librabank.ro:8243/token

Parameter description:

1. ConsumerKey: A secret key that our store user posesses

2. ConsumerSecret: A secret password that our store user posesses

3. Password: The Libra Internet Bank client password configured on our server

4. Username: The Libra Internet Bank client configured on our server

5. {Base64(consumerKey:consumerSecret)}

The Base64 encoding of the consumer key and password

In the Store, the token can be generated/regenerated from Applications menu and selecting the

DefaultApplication . The API Console tab contain the form for token request:

Page 5: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

The token received is used by adding to header requests as parameter:

Authorization: Bearer {token}

The responses from API’s are in JSON format as it can be seen in dummy API’s.

Page 6: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

ACCOUNTS_API

This API returns information about Libra Internet Bank client’s personal accounts. If a store user wants to

access Libra Internet Bank other clients accounts this is also possible under our security profiles.

The API endpoints are:

When the TPP has multiple customers asigned

1. Get client accounts details:

https://api.librabank.ro:8243/1.0/ACCOUNTS_API/{CustomerCode}/accounts

2. Get client’s specific account details:

https://api.librabank.ro:8243/1.0/ACCOUNTS_API/{CustomerCode}/accounts/{IBAN}

3. Get client’s specific account statement:

https://api.librabank.ro:8243/1.0/ACCOUNTS_API/{CustomerCode}/accounts/{IBAN}/transactions

?FromDate={FromDate}&ToDate={ToDate}&FromAmount={FromAmount}&ToAmount={ToAmoun

t}&Description={Description}

When the TPP has just personal customer accounts asigned

1. Get client accounts details:

https://api.librabank.ro:8243/1.0/ACCOUNTS_API/Accounts

2. Get client’s specific account details:

https://api.librabank.ro:8243/1.0/ACCOUNTS_API/{IBAN}

3. Get client’s specific account statement:

https://api.librabank.ro:8243/1.0/ACCOUNTS_API/{IBAN}/transactions?FromDate={FromDate}&T

oDate={ToDate}&FromAmount={FromAmount}&ToAmount={ToAmount}&Description={Descriptio

n}

Parameters description:

Page 7: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

CustomerCode: Libra Internet Bank client id

Description: Optional, a description of the purpose of the request

IBAN: Client’s account IBAN

FromAmount : Not implemented

ToAmount : Not implemented

X-Request-ID: Header parameter. Unique identification of request.

PSU-ID: Header parameter. Client identification of PSU.

PSU-IP-Address: Header parameter. corresponding HTTP request IP Address field

between PSU and TPP.

Possible responses:

Page 8: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 9: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 10: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 11: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 12: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

In the Store the API can be accessed from APIS menu and then ACCOUNTS_API .

Each API can be tested using the API Console tab:

Page 13: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 14: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 15: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

ACCOUNTS_DUMMY_API

This API follow the ACCOUNTS_API structure and it is for testing purposes.

In the Store the API can be accessed from APIS menu and then ACCOUNTS_DUMMY_API .

Page 16: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

PAYMENTS_API

This API give possibility of TPP to make payments from the accounts that they own.

The current API endpoints are:

Make RON payment inter-banking and intra-banking:

https://api.librabank.ro:8243/1.0/{payment-service}/{payment-product}/{paymentId}

It is accessible through POST method and use the following parameters:

o InstructedAmount : The value wanted for transfer. Required parameter;

o DebtorAccount : Debtor account. Required parameter;

o CreditorAccount : Creditor account. Required parameter;

o CreditorName : Creditor name. Required parameter;

o Description : Description. Required parameter.

o Payment-service: Path parameter. Possible value at this moment: payments

o Payment-product: Path parameter. Possible value at this moment: RON-Transfer

o X-Request-ID: Header parameter. Unique identification of request.

o PSU-ID: Header parameter. Client identification of PSU.

o PSU-IP-Address: Header parameter. corresponding HTTP request IP Address field

between PSU and TPP.

Possible responses:

Page 17: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 18: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 19: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 20: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 21: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

Get RON payment status:

https://api.librabank.ro:8243/1.0/{payment-service}/{payment-product}/{paymentId}/Status

It is accessible through GET method and use the following parameter:

o TransactionCode : Transaction code. Required parameter.

o Payment-service: Path parameter. Possible value at this moment: payments

o Payment-product: Path parameter. Possible value at this moment: RON-Transfer

o X-Request-ID: Header parameter. Unique identification of request.

o PSU-ID: Header parameter. Client identification of PSU.

o PSU-IP-Address: Header parameter. corresponding HTTP request IP Address field

between PSU and TPP.

Possible responses:

Page 22: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 23: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 24: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 25: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a
Page 26: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

In the Store the API can be accessed from APIS menu and then PAYMENTS_API .

Each API can be tested using the API Console tab:

Page 27: API.BANKING – Technical Documentation Internet Bank API - Technical... · ACCOUNTS_API This API returns information about Libra Internet Bank client’s personal accounts. If a

PAYMENTS_DUMMY_API

This API follow the PAYMENTS_API structure and it is for testing purposes.

In the Store the API can be accessed from APIS menu and then PAYMENTS_DUMMY_API .