Sign in
OpenBanking

Creates a consent thats used to initiate an authorisation to a financial institution.

<b>Authorization</b>: End user or Merchant token is required.

<b>User permissions required</b>: CanConnectAccounts

post/api/v1/openbanking/consents

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/openbanking/consents
  • Auth: API key in header Authorization

Request body

emailAddressstring email nullable

The email address that identifies the end user that will be authorising the open banking consent request.

institutionIDstring required

The institution ID the open banking consent is being requested for.

merchantIDstring uuid required

The ID of the merchant the consent token is being created to be used with.

callbackUrlstring nullable

Optional callback URL that the end user performing the open banking authorisation will be redirected to on completion. Typically this should be a URL that takes the user back to the application that they originally started the open banking authorisation from.

successWebHookUrlstring nullable

Optional URL that will be called by the MoneyMoov server upon a successful open banking authorisation. The webhook URL will pass a single parameter of "id". That ID can then be used in the MoneyMoov open banking actions to verify the operation. Note web hooks can easily be spoofed and should NOT be trusted without calling back to the MoneyMoov server for verification.

failureCallbackUrlstring nullable

Optional URL for open banking consent authorisation failure. If the URL is set, the calling application will be redirected here with the error message as query parameter. If it’s not set it will fall back on default page that will show the error message.

isConnectedAccountsboolean

Optional setting. If connected accounts is enabled. After a successful consent authorisation, NoFrixion will pull all authorised EUR and GBP account information and store them along NoFrixion payment accounts.

Response

OK

consentIDstring uuid

The ID of the open banking consent. Once the consent has been authorised this is the ID that allows it to be utilised via the open banking APIs to list accounts, transactions etc.

authorisationUrlstring nullable

The URL the authorising user needs to be redirected to in order to get the open banking consent token.

Changes

No recorded changes to this endpoint across all 2 revisions of this API.