Sign in
OpenBanking

Retrieve all the open banking consents for a single user.

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

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

get/api/v1/openbanking/consents/{merchantID}/{email}

Request

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

Path parameters

merchantIDstring uuid required

The ID of the merchant to get the consents for.

emailstring required

The email address of the end user to get the consents for.

Response

OK

idstring uuid
merchantIDstring uuid
institutionIDstring nullable
emailAddressstring nullable
isEnabledboolean
callbackUrlstring nullable
successWebHookUrlstring nullable

A web hook URL to send an HTTP request to when the open banking consent is successfuly authorised. This web hook lets the calling application know when a consent is ready to be used.

failureCallbackUrlstring nullable

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

provider'None' | 'CyberSource' | 'Checkout' | 'Stripe' | 'Modulr' | 'Plaid' | 'Yapily' | 'Nofrixion' | 'Bitcoin' | 'BitcoinTestnet' | 'BankingCircle' | 'BankingCircleAgency' | 'Simulator' | 'Lightning' | 'LightningTestnet' | 'BankingCircleDirectDebit' | 'Technoxander'

Lists the supported card and PIS processors.

expiryDatestring date-time
insertedstring date-time

Changes

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