API docs by Redocly

Finconex API (0.0.1)

Download OpenAPI specification:Download

GENERAL GUIDELINES

INTRODUCTION

Welcome to the Finconex API Technical Documentation.

Security & Access Control

Scopes

  • The access tokens required for accessing the Account Info APIs must have the following scope:
    • accounts: Ability to read Accounts information
  • The access tokens required for accessing the Payment APIs must have the following scope:
    • Payments: Generic payment scope

Grants Types

Account

  • AISPs must use a client credentials grant to obtain a token to access the account-access-consents resource. In the specification, this grant type is referred to as "Client Credentials".

  • AISPs must use an authorisation code grant using a redirect or decoupled flow to obtain a token to access all other resources. In the specification, this grant type is referred to as "Authorisation Code").

Payment

  • PISPs must use a client credentials grant to obtain a token to make POST requests to the payment-order consent endpoints. In the specification, this grant type is referred to as "Client Credentials".

  • PISPs must use an authorisation code grant using a redirect or decoupled flow to obtain a token to make POST requests to the payment-order resource endpoints. This token may also be used to confirm funds on a payment-order consent resource. In the specification, this grant type is referred to as "Authorisation Code".

  • PISPs must use a client credentials grant to obtain a token to make GET requests (excluding confirming funds).

Consents Authorisation

Account

  • The AISP must create an account-access-consents resource through a POST operation. This resource indicates the consent that the AISP claims it has been given by the user/customer to retrieve account and transaction information. At this stage, the consent is not yet authorised as the ASPSP has not yet verified this claim with the user/customer.

  • The ASPSP responds with a ConsentId. This is the intent-id that is used when initiating the authorisation code grant.

  • As part of the consent authorisation flow:

    • The ASPSP authenticates the user/customer

    • The ASPSP plays back the consent (registered by the AISP) back to the user/customer - to get consent authorisation. The user/customer may accept or reject the consent in its entirety (but not selectively)

    • The ASPSP presents the user/customer with a list of accounts to which the consent will apply

  • Once these steps are complete, the consent is considered to have been authorised by the user/customer.

Payment

  • OAuth 2.0 scopes are coarse-grained and the set of available scopes are defined at the point of client registration. There is no standard method for specifying and enforcing fine-grained scopes e.g., a scope to enforce payments of a specified amount on a specified date.

  • A consent authorisation is used to define the fine-grained scope that is granted by the user/customer to the PISP.

  • The PISP must begin a payment-order request by creating a payment-order consent resource through a POST operation. These resources indicate the consent that the PISP claims it has been given by the user/customer. At this stage, the consent is not yet authorised as the ASPSP has not yet verified this claim with the user/customer.

  • The ASPSP responds with a ConsentId. This is the intent-id that is used when initiating the authorisation code grant.

  • As part of the authorisation code grant:

    • The ASPSP authenticates the user/customer

    • If the consent did not indicate a debtor account the ASPSP presents the user/customer with a list of accounts from which the user/customer may select one

    • The ASPSP plays back the consent (registered by the PISP) back to the user/customer to get consent authorisation. The user/customer may accept or reject the consent in its entirety (but not selectively)

  • Once these steps are complete, the consent is considered to have been authorised by the user/customer.

Banks

Get A List Of Banks/FI's

Allows you to get the latest list of banks that can used for transaction.

Authorizations:
TPPOAuth2Security
query Parameters
Environment
string

The Environment of banks.

Limit
integer <int32>

The Limit for retrive data banks.

Offset
integer <int32>

The Offset for retrive data banks.

SortBy
string

The Sort By for retrive data banks (ASC/DESC).

SortByColumn
string

The Sort By Column for retrive data banks.

Responses

Response samples

Content type
application/json
{
  • "banks": [
    ]
}

Accounts

Get Accounts

Allows you to get the latest list of accounts that can used for transaction.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string

Defines the bank that contains the account

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Account Details

Allows you to get the latest details of account that can used for transaction.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string

AccountId is A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner

BankCode
required
string

Defines the bank that contains the account

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Balances

Get Accounts Balances by AccountId

This GetAccountBalanceOfUser returns a single Account Balance

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string

The AccountId of Balance.

BankCode
required
string

The BankCode of Balance.

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Balances

Get All Account Balances of user

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string

Defines the bank that contains the account

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Beneficiaries

Get A List Of Beneficiary Accounts for Specific Account

Allows you to get the latest list of beneficiary accounts of specifict account id.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string
BankCode
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get A List Of Beneficiary Accounts

Allows you to get the latest list of beneficiary accounts.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

DirectDebits

Get A List Of Account Direct Debits

Allows you to get the latest list of account direct debits.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string

AccountId A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner

BankCode
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get A List Of Direct Debits

Allows you to get the latest list of direct debits.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Future Dated Payments

Get Future Dated Payments For Specific Account

Allows you to get the latest list of the Future Dated Payment available for specific account for transaction.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string

A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner

BankCode
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Future Dated Payments

Allows you to get the latest list of the Future Dated Payment available for transaction.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Offers

Get A List Of Account Offers

Allows you to gets all of the offers for the given account identifier.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string

AccountId A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner

BankCode
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get A List Of Offers

Allows you to get the latest list of offers.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Parties

Get Account Parties

This GetAccountParties may contain multiple parties.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string

AccountId is a unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner

BankCode
required
string

BankCode of the account

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Account Owner Party

It will return the details of the party that has given authorization to the AISP to view the Accounts owner Party by AccountId

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string

AccountId is a unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner

BankCode
required
string

BankCode of the account

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Data Of A party

Allows you to get the details on the account owner(s)/holder(s) and operator(s) for a specific account.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

StandingOrders

Get A List Of Account Standing Orders

Allows you to gets all of the standing orders for the given account identifier.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string

AccountId A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner

BankCode
required
string

BankCode identify the specific bank that this account registered under

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get A List Of Standing Orders

Allows you to get the latest list of standing orders.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Statements

Get A List Of Account Statements

Allows you to gets all of the statements for the given account identifier.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string

A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner

BankCode
required
string
query Parameters
fromStatementDateTime
string <date-time>

Specifies start date and time for filtering of the Statements on the Statement/StartDateTime field. If this is not populated, the start date will be open ended.

toStatementDateTime
string <date-time>

Specifies end date and time for filtering of the Statements on the Statement/StartDateTime field. If this is not populated, the end date will be open ended.

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get A List Of Specific Account Statements

Allows you to get the statement for the given account identifier and statement identifier.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string

AccountId is A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner

BankCode
required
string
StatementId
required
string

StatementId is Unique identifier for the statement resource within a servicing institution. This identifier is both unique and immutable

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Specific Account Statement File

Allows you to download specific account's specific statement.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string
BankCode
required
string
StatementId
required
string

Responses

Response samples

Content type
application/json
null

Get A List Of Specific Account Statement Transactions

Allows you to get the list of transaction available on the system from given account identifier and statement identifier.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string

AccountId is A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner

BankCode
required
string
StatementId
required
string

StatementId is Unique identifier for the statement resource within a servicing institution. This identifier is both unique and immutable

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get A List Of Statements

Allows you to get the latest list of statements.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
query Parameters
fromStatementDateTime
string <date-time>

Specifies start date and time for filtering of the Statements on the Statement/StartDateTime field. If this is not populated, the start date will be open ended.

toStatementDateTime
string <date-time>

Specifies end date and time for filtering of the Statements on the Statement/StartDateTime field. If this is not populated, the end date will be open ended.

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Supplementary Account

Get Supplementary Account Details

Allows you to get the latest details of the supplementary account for the given account identifier.

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string

AccountId A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner

BankCode
required
string

Defines the bank that contains the account

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Transaction

Get Transactions by Account ID

Allows you to gets transactions of the user for given accounts

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
AccountId
required
string
BankCode
required
string
query Parameters
FromBookingDateTime
string <date-time>
ToBookingDateTime
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get All Account Transactions

Allows you to gets all transactions of the user for all consent accounts

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
query Parameters
FromBookingDateTime
string <date-time>
ToBookingDateTime
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Create Consents

Request credential keys for UAT and Prod.

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string

The BankCode of Consents.

Request Body schema: application/json
BankCode
required
string

The BankCode of Consents.

required
object

The Data of Consents.

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Consent

This GetConsent returns a single account access consent record

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string

The BankCode of Consents.

ConsentId
required
string

The ConsentId of Consents.

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Update Consent

UpdateConsents alows to update the status of consent record

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string

The BankCode of Consents.

ConsentId
required
string

The ConsentId of AccountAccessConsents.

Request Body schema: application/json
BankCode
string

The BankCode of Consents.

ConsentId
string

The ConsentId of AccountAccessConsents.

object

The Data of AccountAccessConsents.

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "ConsentId": "string",
  • "Data": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Domestic Future Dated Payments Consents

Create Domestic Future Dated Payments Cancellation Consents

Create Domestic Future Dated Payments Cancellation Consents resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Domestic Future Dated Payments Cancellation Consents

Get Domestic Future Dated Payments Cancellation Consent by given ConsentId

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
ConsentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Create Domestic Future Dated Payments Consents

Create Domestic Future Dated Payments Consents resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "Risk": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    },
  • "Risk": {
    }
}

Get Domestic Future Dated Payments Consents

Get Domestic Future Dated Payments Consent by given ConsentId

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
ConsentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    },
  • "Risk": {
    }
}

Domestic Future Dated Payments

Create Domestic Future Dated Payments

Create Domestic Future Dated Payments resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "Risk": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Domestic Future Dated Payments

Get Domestic Future Dated Payments resource

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
DomesticFutureDatedPaymentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Patch Domestic Future Dated Payments

Patch Domestic Future Dated Payments Status

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
DomesticFutureDatedPaymentId
required
string
Request Body schema: application/json
BankCode
string
object
DomesticFutureDatedPaymentId
required
string

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "DomesticFutureDatedPaymentId": "string"
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Domestic Future Dated Payments Details

Get Domestic Future Dated Payments Details

Get Domestic Future Dated Payments Details resource

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
DomesticFutureDatedPaymentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Domestic Payments Consents

Create Domestic Payments Consents

Create Domestic Payments Consents resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "Risk": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    },
  • "Risk": {
    }
}

Get Domestic Payment Consents by ConsentId

This GetDomesticPmtConsent returns a single Domestic PmtConsent

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string

BankCode is a Unique identification as assigned by the ASPSP to uniquely identify the consent resource

ConsentId
required
string

ConsentId is a Unique identification as assigned by the ASPSP to uniquely identify the consent resource

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    },
  • "Risk": {
    }
}

Get Domestic Payments Consent Fund Confirmation

The confirmation of funds response contains the result of a funds availability check or SupplementaryData.

Authorizations:
UserOAuth2Security
path Parameters
BankCode
required
string

Defines the bank that contains the account

ConsentId
required
string

ConsentId is a Unique identification as assigned by the ASPSP to uniquely identify the consent resource

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Domestic Payments

Create Domestic Payments

Authorizations:
(UserOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "Risk": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Domestic Payment

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string

BankCode is a Unique identification as assigned by the ASPSP to uniquely identify the bank

DomesticPaymentId
required
string

DomesticPaymentId is a Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Domestic Payments Details

Allows to get domestic payment details of specific payment

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string

Defines the bank that contains the account

DomesticPaymentId
required
string

DomesticPaymentId is a Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Domestic Standing Order Consents

Create Domestic Standing Order Consent

Allows you to create domestic standing order consent resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "Risk": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    },
  • "Risk": {
    }
}

Get Domestic Standing Order Consent

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
ConsentId
required
string

ConsentId is a Unique identification as assigned by the ASPSP to uniquely identify the consent resource

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    },
  • "Risk": {
    }
}

Domestic Standing Orders

Create Domestic Standing Orders

Allows you to create domestic standing order resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object
required
object

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "Risk": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Domestic Standing Order

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
DomesticStandingOrderId
required
string

DomesticStandingOrderId is a Unique identification as assigned by the ASPSP to uniquely identify the resource

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get Domestic Standing Orders Payment Details

Allows you to get domestic standing order payment details for the given domestic standing order identifier.

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
DomesticStandingOrderId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Event Notification

Create Event Notification

Allows you to create a new event notification.

Authorizations:
UserOAuth2Security
path Parameters
BankCode
required
string
Request Body schema: application/json
aud
required
string
BankCode
required
string
required
object
iss
required
string
jti
required
string
lat
required
string
sub
required
string
toe
required
string
txn
required
string

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "aud": "string",
  • "events": {
    },
  • "iss": "string",
  • "jti": "string",
  • "lat": "string",
  • "sub": "string",
  • "toe": "string",
  • "txn": "string"
}

Response samples

Content type
application/json
null

Event Subscriptions

Get Event Subscriptions

Allows you to get a new event subscription.

Authorizations:
UserOAuth2Security
path Parameters
BankCode
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Create Event Subscriptions

Allows you to create a new event subscription.

Authorizations:
UserOAuth2Security
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Update Event Subscriptions

Update Event Subscriptions resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
EventSubscriptionId
required
string
Request Body schema: application/json
BankCode
required
string
required
object
EventSubscriptionId
required
string

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "EventSubscriptionId": "string"
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Delete Event Subscriptions

Delete Event Subscriptions resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
EventSubscriptionId
required
string

Responses

Response samples

Content type
application/json
null

Bulk Payment Consents

Create bulk payment consents

Create bulk payment consents resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get bulk payment consents

Get bulk payment consents resource by given consent id

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
ConsentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Create file payment consents

Create payment consents resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
ConsentId
required
string
Request Body schema: application/json
string <byte>

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Bulk Payment

Create bulk payment

Create bulk payment resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get bulk payment

Get bulk payment resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
FilePaymentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get bulk payment details

Get bulk payment details resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
FilePaymentId
required
string

FilePaymentId is a Unique identification as assigned by the ASPSP to uniquely identify the bulk payment resource

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get bulk payment report file

Get bulk payment report file resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
FilePaymentId
required
string

FilePaymentId is a Unique identification as assigned by the ASPSP to uniquely identify the bulk payment resource

Responses

Response samples

Content type
application/json
null

Create International Future Dated Payment Consents

Create International Future Dated Payment Consents resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "Risk": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    },
  • "Risk": {
    }
}

Get International Future Dated Payment Consents

Get International Future Dated Payment Consents resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
ConsentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    },
  • "Risk": {
    }
}

Get International Future Dated Payment Consents fund confirmation

Get International Future Dated Payment Consents fund confirmation resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
ConsentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get International Future Dated Payment Consents fund confirmation

Get International Future Dated Payment Consents fund confirmation resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
ConsentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

International Future Dated Payments

Create International Future Dated Payments

Create International Future Dated Payments resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "Risk": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get International Future Dated Payments

Get International Future Dated Payments resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
InternationalFutureDatedPaymentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get International Future Dated Payment Details

Get International Future Dated Payment Details resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
InternationalFutureDatedPaymentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Create International Payment Consents

Create International Payment Consents resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "Risk": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    },
  • "Risk": {
    }
}

Get International Payment Consents

Get International Payment Consents resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
ConsentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    },
  • "Risk": {
    }
}

International Payment

Create International Payment

Create International Payment resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "Risk": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get International Payment

Get International Payment resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
InternationalPaymentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get International Payment Details

Get International Payment Details by international payment id resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
InternationalPaymentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

International Standing Order Consents

Create International Standing Order Consents

Create International Standing Order Consents resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "Risk": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    },
  • "Risk": {
    }
}

Get International Standing Order Consents

Get International Standing Order Consents resource

Authorizations:
TPPOAuth2Security
path Parameters
BankCode
required
string
ConsentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    },
  • "Risk": {
    }
}

International Standing Order Payments

Create International Standing Order

Create International Standing Order Payments resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
Request Body schema: application/json
BankCode
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "BankCode": "string",
  • "Data": {
    },
  • "Risk": {
    }
}

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get International Standing Order

Get International Standing Order Payments resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
InternationalStandingOrderPaymentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Get International Standing Order Payment Details

Get International Standing Order Payment Details resource

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string
InternationalStandingOrderPaymentId
required
string

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Sharing Product Details

Get A List Of Sharing Product Detail

Allows you to get the latest list of sharing product detail.

Authorizations:
(TPPOAuth2Securityx-fapi-consent-id)
path Parameters
BankCode
required
string

BankCode identify the specific bank that this account registered under

Responses

Response samples

Content type
application/json
{
  • "Data": {
    },
  • "Links": {
    },
  • "Meta": {
    }
}

Event

Create Event

Allows you to create a new event.

Authorizations:
UserOAuth2Security
path Parameters
bankCode
required
string
Request Body schema: application/json
ack
Array of strings (An array of jti values indicating event notifications positively acknowledged by the AISP/ PISP)
bankCode
string
maxEvents
integer <int32> (Maximum number of events to be returned. A value of zero indicates the ASPSP should not return events even if available)
returnImmediately
boolean (Indicates whether an ASPSP should return a response immediately or provide a long poll)
object (An object that encapsulates all negative acknowledgements transmitted by the AISP/ PISP)

Responses

Request samples

Content type
application/json
{
  • "ack": [
    ],
  • "bankCode": "string",
  • "maxEvents": 0,
  • "returnImmediately": true,
  • "setErrs": {
    }
}

Response samples

Content type
application/json
{
  • "moreAvailable": true,
  • "sets": {
    }
}