PSD2 Account Information

Accounts

PSD2 Account Information

A convenient and user-friendly experience so that customers can retrieve their Citibank account information and transaction data through TPP applications. Customers can view the summary of all the accounts to get the basic account information and also view additional accounts and transactions details.

Poland

United Kingdom

Customer clicks on 'Add an account' button on the TPP application

The customer clicks on 'Add an account' button on the TPP application to add the aggregator account.
Zoom In

Customer selects the provider bank on the TPP application as Citibank

The customer selects the provider bank on the TPP application as Citibank.
Zoom In

Customer provides permission to share the account details

The TPP application prompts for customer's permission to share the account details. When the customer clicks on 'Proceed' button, he is redirected to the Citibank application for authentication.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization Code Grant: Retrieve Authorization Code

This API gets invoked by a web browser redirection and requires user interaction. It is used to retrieve an authorization code by redirecting the user to a login page followed by the consent approval page. At the end of this flow, this endpoint returns to the redirect_uri configured for the associated application.

Endpoint

Poland: GET /authCode/oauth2/authorize

UK: GET /authCode/oauth2/authorize

Parameters

PATH

NA

Query

response_type

client_id

scope

countryCode

businessCode

locale

state

redirect_uri

Customer enters the OTP for authentication

The customer enters the OTP received on his mobile number for authentication and clicks on 'Next' button. 
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization Code Grant: Retrieve Access Token

Get an access token issued by calling our token endpoint and passing the authorization code from the previous call. The issued access token will have an expiry, and it will be valid only for the scope for which the consent has been provided by the customer. You can call the APIs by passing this token in Authorization header.

You also get a refresh token that can be used to get a new access token in case the original one expires.

Endpoint

Poland: POST /authCode/oauth2/token/pl/gcb

UK: POST /authCode/oauth2/token/gb/ipb

Parameters

PATH

NA

Query

response_type

client_id

scope

countryCode

businessCode

locale

state

redirect_uri

View Api Callout 2 >
×

Use Case Callout

Retrieve summary of all accounts

Returns a summary of all accounts held by a Citi customer who has authorized your application. If a customer has multiple but similar accounts, e.g. two savings accounts, the accounts will be returned in the array accountGroupSummary.

Endpoint

Poland: GET /v1/accounts

UK: GET /v1/accounts

 

Parameters

PATH

NA

Customer selects the accounts to provide access to the TPP

The customer selects the accounts on Citibank application for which he wants to provide access to the TPP.
Zoom In

Customer read the account related information

The customer may click on 'Info I'm providing' and read the account related information that he is confirming for access to the TPP. No consent is required in Citibank application.
Zoom In

Show transaction in progress screen to the customer

Once the customer clicks on 'Confirm' button on account selection screen, it will show transaction in progress screen on Citibank application from where the customer will be redirected to the TPP application automatically.
Zoom In

Customer gets the acknowledgement with summary of added accounts

The acknowledgement screen is shown on the TPP application with the summary of accounts added by the customer.


The account number shown is unmasked on the TPP application after redirection from the Citibank application since the TPP is registered for AISP only or both AISP and PISP.

Zoom In

Customer clicks on 'View accounts' button on the TPP application

The customer clicks on 'View accounts' button on the TPP application to view the account details of the aggregator account.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve summary of all accounts

Returns a summary of all accounts held by a Citi customer who has authorized your application. If a customer has multiple but similar accounts, e.g. two savings accounts, the accounts will be returned in the array accountGroupSummary.

Endpoint

Poland: GET /v1/accounts

UK: GET /v1/accounts

 

Parameters

PATH

NA

Customers selects the type of account on the TPP application

The customer selects the type of account to view the details on the TPP application.
Zoom In

Customers sees the accounts information for the selected account type

The customers sees the accounts information in brief for the selected account type on the TPP application.

 

The customer can click on any of the available accounts to view the detailed information.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve account details

Returns additional account details than what is provided in the summary of all accounts. To retrieve the details, simply pass the accountId returned to you from the account summary.

Endpoint

Poland: GET /v1/accounts/{accountId}

UK: GET /v1/accounts/{accountId}

Parameters

PATH

accountId

Customer sees the detailed information of the selected account

The customer sees the detailed information of the selected account on the TPP application.

 

The customer can click on 'View transaction history' link at the bottom to view the transactions for the selected account.

Zoom In

Customers enters the search criteria to view the transaction history of the selected account

The customer enters the search criteria like date range and transaction type and clicks on 'Apply' button to view the transaction history of the selected account.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve Transactions

Returns an array of transactions for the specified account. For investment transactions such as buying or selling a stock, they will be returned in the array investmentTransaction.

Endpoint

Poland: GET /v1/accounts/{accountId}/transactions

UK: GET /v1/accounts/{accountId}/transactions

Parameters

PATH

accountId

Query

transactionStatus

nextStartIndex

requestSize

transactionFromDate

transactionToDate

amountFrom

amountTo

Customers sees the transaction history as per search criteria

The customer sees the transaction history of the selected account on the TPP application as per his search criteria.
Zoom In