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

post

https://api-sandbox.nofrixion.com/api/v1/openbanking/consents

Authorization: End user or Merchant token is required.

User permissions required: CanConnectAccounts

Body Params

The fields required to request a new consent. The email address must belong to the user who will be authorising the consent.

emailAddress

string | null

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

institutionID

string

required

length ≥ 1

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

merchantID

uuid

required

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

callbackUrl

string | null

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.

successWebHookUrl

string | null

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.

failureCallbackUrl

string | null

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.

isConnectedAccounts

boolean

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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK