Fena Account and Transaction Data API Specification (1.0.1)

Download OpenAPI specification:Download

API Documentation for Fena Data Account and Transaction

Supported UK Banks

UK Banks	Provider Name	Status
Lloyds Personal	ob-lloyds-personal	Active
Revolut	ob-revolut	Active
Santander	ob-santander	Active
Halifax	ob-halifax-personal	Active
Natwest	ob-natwest	Active
TSB	ob-tsb	Active
HSBC Personal	ob-hsbc-personal	Active
Bank of Scotland Personal	ob-bos-personal	Active
Monzo	ob-monzo	Active
First Direct	ob-first-direct	Active
Royal Bank of Scotland	ob-rbs	Active
Ulster	ob-ulster	Active
Nationwide	ob-nationwide	Active
Starling	starling	Active
Lloyds Business	ob-lloyds-business	Active
Barclys Business	ob-barclays-business	Active
Barclys Corporate	ob-barclays-corporate	Active
Bank of Scotland Business	ob-bos-business	Active
Danske Business	ob-danske-business	Active
Danske Private	ob-danske-private	Active
HSBC Business	ob-hsbc-business	Active
Virgin Money	ob-virgin-money	Active
Lloyds Sandbox	ob-sandbox-lloyds	Inactive
Metro Personal	ob-metro-personal	Inactive
Mettle	ob-mettle	Active
Tide	ob-tide	Active

Authentication

Fena only supports API Key authentication:

API Key

clientId

Security Scheme Type	API Key
Header parameter name:	client_id

clientSecret

Security Scheme Type	API Key
Header parameter name:	client_secret

Access Consent

Create Account Access Consents

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Request Body schema: application/json

provider required	string Enum: "ob-sandbox-lloyds" "ob-sandbox-coutts" "ob-lloyds-personal" "ob-barclays-personal" "ob-barclays-business" "ob-barclays-corporate" "ob-revolut" "ob-santander" "ob-halifax-personal" "ob-natwest" "ob-tsb" "ob-hsbc-personal" "ob-hsbc-business" "ob-bos-personal" "ob-lloyds-business" "ob-bos-business" "ob-monzo" "ob-virgin-money" "ob-first-direct" "ob-rbs" "ob-ulster" "ob-metro-personal" "ob-nationwide" "ob-tide" "ob-mettle" "ob-chase" "ob-aibgb-retail" "ob-aibgb-corporate" "ob-starling" "starling" "ob-danske-business" "ob-danske-private" Provider name
flow	string Enum: "accounts" "balances" "transactions" If supplied create consent call will automatically trigger the selected flow (after redirecting back from bank's consent authorization page) and return appropriate data in the response. All in one call.
accountId	string Required if 'flow' is supplied and 'balances' or 'transactions' is selected.
transactionStartDate	string May be supplied with 'transactions' flow to pinpoint the date beginning from which transactions should be returned. Otherwise, by default, will be set to 1970-01-01T00:00:00.000Z
transactionEndDate	string May be supplied with 'transactions' flow to pinpoint the date until which transactions should be returned. Otherwise, by default, will be set to the current date
starlingCategoryId	string May be supplied with 'transactions' flow if provider is set to 'starling'.
customerConsentId	string Optional identifier for the consent, generated on client side.
	object

Responses

Request samples

Payload

Content type

application/json

{"provider": "ob-sandbox-lloyds",
"flow": "accounts",
"accountId": "string",
"transactionStartDate": "2021-01-01T00:00:00.000Z",
"transactionEndDate": "2022-03-01T00:00:00.000Z",
"starlingCategoryId": "string",
"customerConsentId": "f929d718-1496-11eb-adc1-0242ac120002",
"Option": {"RedirectUri": "string",
"WebhookUri": "string"
}
}

Response samples

201
400
500

Content type

application/json; charset=utf-8

{"result": {"consentID": "e51f2e48-5664-41f3-9d23-51874d9d38fd",
"authUrl": "string",
"customerConsentId": "f929d718-1496-11eb-adc1-0242ac120002"
}
}

Get Account Access Consents

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string

ID of the consent created.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"Data": {"ConsentId": "string",
"CreationDateTime": "2019-08-24T14:15:22Z",
"Status": "Authorised",
"StatusUpdateDateTime": "2019-08-24T14:15:22Z",
"Permissions": ["ReadAccountsBasic"
],
"ExpirationDateTime": "2019-08-24T14:15:22Z",
"TransactionFromDateTime": "2019-08-24T14:15:22Z",
"TransactionToDateTime": "2019-08-24T14:15:22Z"
},
"Risk": { },
"Links": {"Self": "http://example.com",
"First": "http://example.com",
"Prev": "http://example.com",
"Next": "http://example.com",
"Last": "http://example.com"
},
"Meta": {"TotalPages": 0,
"FirstAvailableDateTime": "2019-08-24T14:15:22Z",
"LastAvailableDateTime": "2019-08-24T14:15:22Z"
}
}

Delete Account Access Consents

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string

ID of the consent created.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"result": {"message": "string"
}
}

Reconfirm Account Access Consent

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string

ID of the consent created.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"message": "string",
"lastAuthorizationAt": "2019-08-24T14:15:22Z"
}

Accounts

Get Accounts

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string

ID of the consent created.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

Example

UK Open Banking

{"Data": {"Account": [{"AccountId": "string",
"Status": "Deleted",
"StatusUpdateDateTime": "2019-08-24T14:15:22Z",
"Currency": "string",
"AccountType": "Business",
"AccountSubType": "string",
"Description": "string",
"Nickname": "string",
"OpeningDate": "2019-08-24T14:15:22Z",
"MaturityDate": "2019-08-24T14:15:22Z",
"SwitchStatus": "string",
"Account": [{"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
}
]
}
]
}
}

Balances

Get Balances

Authorizations:

clientId

clientSecret

path Parameters

consentId required	string ID of the consent created.
accountId required	string ID of the account.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

Example

UK Open Banking

{"Data": {"Balance": [{"AccountId": "string",
"CreditDebitIndicator": "Credit",
"Type": "ClosingAvailable",
"DateTime": "2019-08-24T14:15:22Z",
"Amount": {"Amount": 0,
"Currency": "string"
},
"CreditLine": [{"Included": true,
"Type": "Available",
"Amount": {"Amount": "string",
"Currency": "string"
}
}
]
}
]
}
}

Transactions

Get Transactions

Authorizations:

clientId

clientSecret

path Parameters

consentId required	string ID of the consent created.
accountId required	string ID of the account.

query Parameters

transactionStartDate	string <date-time> ID of the account.
transactionEndDate	string <date-time> ID of the account.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

{"Data": {"Transaction": [{"AccountId": "string",
"TransactionId": "string",
"TransactionReference": "string",
"StatementReference": ["string"
],
"CreditDebitIndicator": "Credit",
"Status": "Booked",
"TransactionMutability": "Mutable",
"BookingDateTime": "2019-08-24T14:15:22Z",
"ValueDateTime": "2019-08-24T14:15:22Z",
"TransactionInformation": "string",
"AddressLine": "string",
"Amount": {"Amount": "string",
"Currency": "string"
},
"ChargeAmount": {"Amount": "string",
"Currency": "string"
},
"CurrencyExchange": {"SourceCurrency": "string",
"TargetCurrency": "string",
"UnitCurrency": "string",
"ExchangeRate": 0,
"ContractIdentification": "string",
"QuotationDate": "2019-08-24T14:15:22Z",
"InstructedAmount": {"Amount": "string",
"Currency": "string"
}
},
"BankTransactionCode": {"Code": "string",
"SubCode": "string"
},
"ProprietaryBankTransactionCode": {"Code": "string",
"Issuer": "string"
},
"Balance": {"CreditDebitIndicator": "Credit",
"Type": "ClosingAvailable",
"Amount": {"Amount": "string",
"Currency": "string"
}
},
"MerchantDetails": {"MerchantName": "string",
"MerchantCategoryCode": "stri"
},
"CreditorAgent": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"PostalAddress": {"AddressType": "Business",
"Department": "string",
"SubDepartment": "string",
"StreetName": "string",
"BuildingNumber": "string",
"PostCode": "string",
"TownName": "string",
"CountrySubDivision": "string",
"Country": "string",
"AddressLine": ["string"
]
}
},
"CreditorAccount": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
},
"DebtorAgent": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"PostalAddress": {"AddressType": "Business",
"Department": "string",
"SubDepartment": "string",
"StreetName": "string",
"BuildingNumber": "string",
"PostCode": "string",
"TownName": "string",
"CountrySubDivision": "string",
"Country": "string",
"AddressLine": ["string"
]
}
},
"DebtorAccount": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
},
"CardInstrument": {"CardSchemeName": "AmericanExpress",
"AuthorisationType": "ConsumerDevice",
"Name": "string",
"Identification": "string"
},
"SupplementaryData": { }
}
]
}
}

Variable Recurring Payment Consents

Create VRP Consent

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Request Body schema: application/json

provider required	string (VRP Provider) Enum: "ob-sandbox-natwest" "ob-natwest" "ob-nationwide" "ob-rbs" "ob-ulster" "ob-hsbc-personal" "ob-hsbc-business" "ob-hsbc-net" "ob-lloyds-personal" "ob-lloyds-business" "ob-halifax-personal" "ob-bos-personal" "ob-bos-business" "ob-first-direct" "ob-santander" "ob-barclays-personal" "ob-barclays-business" "ob-barclays-corporate" "ob-danske-business" "ob-danske-private" "ob-monzo" "ob-mettle" Providers that support VRPs
reference	string or null [ 1 .. 18 ] characters
risk	object (VRP Risk)
	object (VRP Option)
	object (VRP Remitter) VRP Remitter Object
required	object (VRP Beneficiary) VRP Beneficiary Object
maximumIndividualAmount required	string (VRPMaximumIndividualAmount) [ 4 .. 10 ] characters ^\d+\.\d{0,2}$ Maximum amount of an individual payment that consent allows
required	Array of objects (VRPPeriodicLimits) non-empty [ items ]
vrpType required	Array of strings (VRPType) non-empty Items Enum: "Sweeping" "Other" The types of payments that can be made under this VRP consent. This can be used to indicate whether this include sweeping payment or other ecommerce payments. Where 'sweeping payments' enable customers to automatically ‘sweep’ funds between their accounts on a recurring basis. And 'non-sweeping payments' enable payment providers to give businesses a new option for managing customer payments for a range of services, including utility bills and subscriptions. Despite the presence of 'Other' value in OpenBanking API schemas, only the 'Sweeping' is currently supported by banks.
psuAuthenticationMethods required	Array of strings (VRPPsuAuthenticationMethods) non-empty Items Enum: "SCA" "SCANotRequired" Indicates the PSU authentication methods supported. Despite the presence of 'SCA' value in OpenBanking API schemas, only the 'SCANotRequired' is currently supported by banks.
validFrom	string (VRPValidFrom) Start date time for which the consent remains valid. In ISO 8601 Format
validTo	string (VRPValidTo) End date time for which the consent remains valid. In ISO 8601 Format

Responses

Request samples

Payload

Content type

application/json

{"provider": "ob-natwest",
"reference": "string",
"risk": { },
"option": {"redirectUri": "string",
"webhookUri": "string"
},
"remitter": {"identificationType": "SortCodeAccountNumber",
"sortCode": "string",
"accountNumber": "stringst",
"iban": "string",
"name": "string"
},
"beneficiary": {"identificationType": "SortCodeAccountNumber",
"sortCode": "string",
"accountNumber": "stringst",
"iban": "string",
"name": "string"
},
"maximumIndividualAmount": "string",
"periodicLimits": [{"periodType": "Day",
"periodAlignment": "Consent",
"amount": "string"
}
],
"vrpType": ["Sweeping"
],
"psuAuthenticationMethods": ["SCA"
],
"validFrom": "string",
"validTo": "string"
}

Response samples

201
400
500

Content type

application/json; charset=utf-8

{"result": {"vrp_consent": {"id": "d4d72767-991e-4cd3-82ce-4bb054f7b407",
"provider": {"id": "ob-hsbc-personal",
"name": "HSBC Personal",
"sortCodeRange": "[400000,490000)"
},
"beneficiaryIdentificationType": "SortCodeAccountNumber",
"beneficiaryAccountNumber": "11397104",
"beneficiarySortCode": "040004",
"beneficiaryName": "Isaac Harper",
"maximumIndividualAmount": "10.00",
"periodicLimits": "[{\"periodType\":\"Day\",\"periodAlignment\":\"Consent\",\"amount\":\"20.00\"},{\"periodType\":\"Month\",\"periodAlignment\":\"Consent\",\"amount\":\"100.00\"}]",
"vrpType": "[\"Sweeping\"]",
"psuAuthenticationMethods": "[\"SCANotRequired\"]",
"validFrom": null,
"validTo": null,
"referenceNumber": "333333",
"risk": null,
"status": "awaiting_authorization",
"beneficiaryIban": null,
"remitterSortCode": null,
"remitterAccountNumber": null,
"remitterIban": null,
"remitterName": null,
"completedAt": null,
"redirectUri": null,
"webhookUri": null,
"createdAt": "2023-03-25T14:09:13.070Z",
"updatedAt": "2023-03-25T14:09:15.914Z",
"providerData": {"Data": {"ConsentId": "c2c4b797-fbd5-43ce-81a7-70ec35e8bd8e",
"Status": "AwaitingAuthorisation",
"StatusUpdateDateTime": "2023-03-25T14:09:15+00:00",
"CreationDateTime": "2023-03-25T14:09:15+00:00",
"ControlParameters": {"ValidFromDateTime": "2023-03-25T14:09:15+00:00",
"MaximumIndividualAmount": {"Amount": "10.00",
"Currency": "GBP"
},
"PeriodicLimits": [{"PeriodAlignment": "Consent",
"Amount": "20.00",
"Currency": "GBP",
"PeriodType": "Day"
},
{"PeriodAlignment": "Consent",
"Amount": "100.00",
"Currency": "GBP",
"PeriodType": "Month"
}
],
"VRPType": ["UK.OBIE.VRPType.Sweeping"
],
"PSUAuthenticationMethods": ["UK.OBIE.SCANotRequired"
]
},
"Initiation": {"CreditorAccount": {"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "04000411397104",
"Name": "Isaac Harper"
},
"RemittanceInformation": {"Reference": "333333"
}
}
},
"Risk": {"PaymentContextCode": "Other"
}
}
},
"auth_flow": {"type": "redirect",
"uri": "https://ob.hsbc.co.uk/obie/open-banking/v1.1/oauth2/authorize?client_id=a8d087a1-a7c1-424e-b9fe-a21d3395476d&scope=openid%20payments&response_type=code%20id_token&redirect_uri=https%3A%2F%2Fprovider.api.staging.fena.co%2Fcompleted&state=d4d72767-991e-4cd3-82ce-4bb054f7b407&nonce=d4d72767-991e-4cd3-82ce-4bb054f7b407&request=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIteWM1VC1jeW1jNEZXVnN5U051V3ZpbHhZYyJ9.eyJzdWIiOiJodHRwczovL2FwaS5vYi5oc2JjLmNvLnVrIiwiYXVkIjoiaHR0cHM6Ly9hcGkub2IuaHNiYy5jby51ayIsImlzcyI6ImE4ZDA4N2ExLWE3YzEtNDI0ZS1iOWZlLWEyMWQzMzk1NDc2ZCIsInJlc3BvbnNlX3R5cGUiOiJjb2RlIGlkX3Rva2VuIiwiY2xpZW50X2lkIjoiYThkMDg3YTEtYTdjMS00MjRlLWI5ZmUtYTIxZDMzOTU0NzZkIiwicmVkaXJlY3RfdXJpIjoiaHR0cHM6Ly9wcm92aWRlci5hcGkuc3RhZ2luZy5mZW5hLmNvL2NvbXBsZXRlZCIsInNjb3BlIjoib3BlbmlkIHBheW1lbnRzIiwic3RhdGUiOiJkNGQ3Mjc2Ny05OTFlLTRjZDMtODJjZS00YmIwNTRmN2I0MDciLCJub25jZSI6ImQ0ZDcyNzY3LTk5MWUtNGNkMy04MmNlLTRiYjA1NGY3YjQwNyIsImV4cCI6MTY3OTc1Njk1NSwiY2xhaW1zIjp7ImlkX3Rva2VuIjp7ImFjciI6eyJ2YWx1ZSI6InVybjpvcGVuYmFua2luZzpwc2QyOnNjYSIsImVzc2VudGlhbCI6dHJ1ZX0sIm9wZW5iYW5raW5nX2ludGVudF9pZCI6eyJ2YWx1ZSI6ImMyYzRiNzk3LWZiZDUtNDNjZS04MWE3LTcwZWMzNWU4YmQ4ZSIsImVzc2VudGlhbCI6dHJ1ZX19LCJ1c2VyaW5mbyI6eyJvcGVuYmFua2luZ19pbnRlbnRfaWQiOnsidmFsdWUiOiJjMmM0Yjc5Ny1mYmQ1LTQzY2UtODFhNy03MGVjMzVlOGJkOGUiLCJlc3NlbnRpYWwiOnRydWV9fX0sImFjcl92YWx1ZXMiOiJ1cm46b3BlbmJhbmtpbmc6cHNkMjpzY2EiLCJqdGkiOiJkMTY3OTc1MzM1NSJ9.j8vmhLgSsv9HxdV7sMAFwS2FGPk-oobr4q2WUta52URZep3Rc6wC8nzkMkYcjDYPPGTFH4OBojDcy_nh0Tjr-NUWH901hImyFkE12skW3E6xEUvq6DRCqjVOfu38Er_Ie72YLKSwdhM2sLh1r2cqk8kIf3hT30WKaL98eVmRHblSHjqYy3iwhrYW6sfAQRi7MnLDxmWAKjj2VellYD8lAF69IoOmiXi4Hz49slk5GD0oML9rJ14UO_OhXoZ9udlmYD0UgX7LfaVntVX5EaI4YQEREBOfXlgckio3-4eTsXTzjA9gX3NzgrQ9POzAJwZIBPpedLiqcBSYJi83-2UQXg",
"expiry": "2023-03-25T15:09:19.054Z"
}
}
}

Get VRP Consent

Authorizations:

clientId

clientSecret

path Parameters

id

required

string <uuid>

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
404
500

Content type

application/json; charset=utf-8

{"id": "0e7722c7-a076-4151-a864-85c26117e996",
"maximumIndividualAmount": "10.00",
"periodicLimits": "[{\"periodType\":\"Day\",\"periodAlignment\":\"Consent\",\"amount\":\"20.00\"},{\"periodType\":\"Month\",\"periodAlignment\":\"Consent\",\"amount\":\"100.00\"}]",
"vrpType": "[\"Sweeping\"]",
"psuAuthenticationMethods": "[\"SCANotRequired\"]",
"status": "awaiting_authorization",
"referenceNumber": "333333",
"risk": null,
"beneficiaryIdentificationType": "SortCodeAccountNumber",
"beneficiarySortCode": "040004",
"beneficiaryAccountNumber": "11397104",
"beneficiaryIban": null,
"beneficiaryName": "Isaac Harper",
"remitterIdentificationType": "SortCodeAccountNumber",
"remitterSortCode": null,
"remitterAccountNumber": null,
"remitterIban": null,
"remitterName": null,
"validFrom": null,
"validTo": null,
"completedAt": null,
"createdAt": "2023-03-25T12:51:38.574Z",
"updatedAt": "2023-03-25T12:51:43.539Z",
"redirectUri": null,
"webhookUri": null,
"provider": {"id": "ob-hsbc-personal",
"name": "HSBC Personal",
"sortCodeRange": "[400000,490000)"
},
"providerData": {"Data": {"ConsentId": "725df30c-2f64-4a87-a143-a88030b458c5",
"Status": "AwaitingAuthorisation",
"StatusUpdateDateTime": "2023-03-25T12:51:43+00:00",
"CreationDateTime": "2023-03-25T12:51:43+00:00",
"ControlParameters": {"ValidFromDateTime": "2023-03-25T12:51:43+00:00",
"MaximumIndividualAmount": {"Amount": "10.00",
"Currency": "GBP"
},
"PeriodicLimits": [{"PeriodAlignment": "Consent",
"Amount": "20.00",
"Currency": "GBP",
"PeriodType": "Day"
},
{"PeriodAlignment": "Consent",
"Amount": "100.00",
"Currency": "GBP",
"PeriodType": "Month"
}
],
"VRPType": ["UK.OBIE.VRPType.Sweeping"
],
"PSUAuthenticationMethods": ["UK.OBIE.SCANotRequired"
]
},
"Initiation": {"CreditorAccount": {"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "04000411397104",
"Name": "Isaac Harper"
},
"RemittanceInformation": {"Reference": "333333"
}
}
},
"Risk": {"PaymentContextCode": "Other"
}
}
}

Delete VRP Consent

Authorizations:

clientId

clientSecret

path Parameters

id

required

string <uuid>

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
404
500

Content type

application/json; charset=utf-8

{"successfullyDeleted": true,
"message": "Request is completed successfully"
}

Variable Recurring Payments

Initiate VRP Payment

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Request Body schema: application/json

vrpConsentId required	string^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... The ID of the VRP consent that this payment is made under.
amount required	string [ 4 .. 10 ] characters ^\d+\.\d{0,2}$
psuAuthenticationMethod required	string (VRPPsuAuthenticationMethod) Enum: "SCA" "SCANotRequired" The authentication method used to authenticate the PSU. Despite the presence of 'SCA' value in OpenBanking API schemas, only the 'SCANotRequired' is currently supported by banks.
	object (VRP Option)

Responses

Request samples

Payload

Content type

application/json

{"vrpConsentId": "string",
"amount": "string",
"psuAuthenticationMethod": "SCA",
"option": {"redirectUri": "string",
"webhookUri": "string"
}
}

Response samples

201
400
500

Content type

application/json; charset=utf-8

{"result": {"vrp_payment": {"vrpConsent": {"id": "04349a90-23c8-4098-ba36-f70389a5bf5a",
"maximumIndividualAmount": "0.50",
"periodicLimits": "[{\"periodType\":\"Day\",\"periodAlignment\":\"Consent\",\"amount\":\"5.00\"},{\"periodType\":\"Month\",\"periodAlignment\":\"Consent\",\"amount\":\"5.00\"}]",
"vrpType": "[\"Sweeping\"]",
"psuAuthenticationMethods": "[\"SCANotRequired\",\"SCA\"]",
"status": "authorized",
"referenceNumber": "333333",
"risk": null,
"beneficiaryIdentificationType": "SortCodeAccountNumber",
"beneficiarySortCode": "040004",
"beneficiaryAccountNumber": "11397104",
"beneficiaryIban": null,
"beneficiaryName": "Isaac Harper",
"remitterIdentificationType": "SortCodeAccountNumber",
"remitterSortCode": null,
"remitterAccountNumber": null,
"remitterIban": null,
"remitterName": null,
"validFrom": null,
"validTo": null,
"completedAt": "2023-03-27T09:54:49.251Z",
"createdAt": "2023-03-27T09:42:47.312Z",
"updatedAt": "2023-03-27T09:54:49.256Z",
"redirectUri": null,
"webhookUri": null,
"providerData": {"Data": {"ConsentId": "2a58e018-6391-40b5-8d49-9da6ee27d85f",
"Status": "Authorised",
"StatusUpdateDateTime": "2023-03-27T09:54:11+00:00",
"CreationDateTime": "2023-03-27T09:42:49+00:00",
"ControlParameters": {"ValidFromDateTime": "2023-03-27T09:42:49+00:00",
"MaximumIndividualAmount": {"Amount": "0.50",
"Currency": "GBP"
},
"PeriodicLimits": [{"PeriodAlignment": "Consent",
"Amount": "5.00",
"Currency": "GBP",
"PeriodType": "Day"
},
{"PeriodAlignment": "Consent",
"Amount": "5.00",
"Currency": "GBP",
"PeriodType": "Month"
}
],
"VRPType": ["UK.OBIE.VRPType.Sweeping"
],
"PSUAuthenticationMethods": ["UK.OBIE.SCANotRequired",
"UK.OBIE.SCA"
]
},
"Initiation": {"CreditorAccount": {"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "04000411397104",
"Name": "Isaac Harper"
},
"RemittanceInformation": {"Reference": "333333"
}
},
"DebtorAccount": {"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "40119170855944",
"Name": "HARPER I"
}
},
"Risk": {"PaymentContextCode": "Other"
}
}
},
"provider": {"id": "ob-hsbc-personal",
"name": "HSBC Personal",
"sortCodeRange": "[400000,490000)"
},
"id": "2423e5ef-3064-4d6c-b48a-abda67ef787e",
"amount": "0.01",
"psuAuthenticationMethod": "SCANotRequired",
"status": "executed",
"completedAt": "2023-03-27T10:11:34.102Z",
"redirectUri": null,
"webhookUri": null,
"createdAt": "2023-03-27T10:11:23.962Z",
"updatedAt": "2023-03-27T10:11:34.111Z"
}
}
}

Get VRP Payment

Authorizations:

clientId

clientSecret

path Parameters

id

required

string <uuid>

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
404
500

Content type

application/json; charset=utf-8

{"id": "2423e5ef-3064-4d6c-b48a-abda67ef787e",
"amount": "0.01",
"psuAuthenticationMethod": "SCANotRequired",
"status": "executed",
"completedAt": "2023-03-27T10:11:34.102Z",
"createdAt": "2023-03-27T10:11:23.962Z",
"updatedAt": "2023-03-27T10:11:34.111Z",
"redirectUri": null,
"webhookUri": null,
"provider": {"id": "ob-hsbc-personal",
"name": "HSBC Personal",
"sortCodeRange": "[400000,490000)"
},
"vrpConsent": {"id": "04349a90-23c8-4098-ba36-f70389a5bf5a",
"maximumIndividualAmount": "0.50",
"periodicLimits": "[{\"periodType\":\"Day\",\"periodAlignment\":\"Consent\",\"amount\":\"5.00\"},{\"periodType\":\"Month\",\"periodAlignment\":\"Consent\",\"amount\":\"5.00\"}]",
"vrpType": "[\"Sweeping\"]",
"psuAuthenticationMethods": "[\"SCANotRequired\",\"SCA\"]",
"status": "authorized",
"referenceNumber": "333333",
"risk": null,
"beneficiaryIdentificationType": "SortCodeAccountNumber",
"beneficiarySortCode": "040004",
"beneficiaryAccountNumber": "11397104",
"beneficiaryIban": null,
"beneficiaryName": "Isaac Harper",
"remitterIdentificationType": "SortCodeAccountNumber",
"remitterSortCode": null,
"remitterAccountNumber": null,
"remitterIban": null,
"remitterName": null,
"validFrom": null,
"validTo": null,
"completedAt": "2023-03-27T09:54:49.251Z",
"createdAt": "2023-03-27T09:42:47.312Z",
"updatedAt": "2023-03-27T10:11:27.650Z",
"redirectUri": null,
"webhookUri": null,
"providerData": {"Data": {"ConsentId": "2a58e018-6391-40b5-8d49-9da6ee27d85f",
"Status": "Authorised",
"StatusUpdateDateTime": "2023-03-27T09:54:11+00:00",
"CreationDateTime": "2023-03-27T09:42:49+00:00",
"ControlParameters": {"ValidFromDateTime": "2023-03-27T09:42:49+00:00",
"MaximumIndividualAmount": {"Amount": "0.50",
"Currency": "GBP"
},
"PeriodicLimits": [{"PeriodAlignment": "Consent",
"Amount": "5.00",
"Currency": "GBP",
"PeriodType": "Day"
},
{"PeriodAlignment": "Consent",
"Amount": "5.00",
"Currency": "GBP",
"PeriodType": "Month"
}
],
"VRPType": ["UK.OBIE.VRPType.Sweeping"
],
"PSUAuthenticationMethods": ["UK.OBIE.SCANotRequired",
"UK.OBIE.SCA"
]
},
"Initiation": {"CreditorAccount": {"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "04000411397104",
"Name": "Isaac Harper"
},
"RemittanceInformation": {"Reference": "333333"
}
},
"DebtorAccount": {"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "40119170855944",
"Name": "HARPER I"
}
},
"Risk": {"PaymentContextCode": "Other"
}
}
}
}

Webhook

Create a Webhook

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Request Body schema: application/json

consentId required	string Consent ID
url required	string Your webhook URL
event required	string Enum: "ACCOUNT_ACCESS_CONSENT" "ACCOUNT" "ACCOUNTS" "ACCOUNT_BALANCES" "ACCOUNT_TRANSACTION" "ACCOUNT_TRANSACTIONS" "DOMESTIC_STANDING_ACCESS_CONSENT" Event
product required	string Enum: "ACCOUNTS" "DOMESTIC_STANDING_PAYMENTS" Product. Note: you can use 'ACCOUNTS' product for UK providers and also EU providers

Responses

Request samples

Payload

Content type

application/json

{"consentId": "string",
"url": "string",
"event": "ACCOUNT_ACCESS_CONSENT",
"product": "ACCOUNTS"
}

Response samples

201
400
500

Content type

application/json; charset=utf-8

{"message": "Request is completed successfully."
}

Get Webhook

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string <uuid>

ID of the consent the webhook was registered with

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
400
500

Content type

application/json; charset=utf-8

{"consentId": "string",
"url": "string",
"event": "ACCOUNT_ACCESS_CONSENT",
"product": "ACCOUNTS"
}

Delete a Webhook

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string <uuid>

ID of the consent the webhook was registered with

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
400
500

Content type

application/json; charset=utf-8

{"message": "Request is completed successfully."
}

Providers

Get Providers

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200

Content type

application/json; charset=utf-8

[{"id": "ob-monzo",
"name": "Monzo",
"logo": "https://provider-api-prod.s3.eu-west-2.amazonaws.com/logo/monzo.png",
"active": true,
"sortCodeRange": "[40003,40006)"
}
]

Get Providers Supporting VRPs

Authorizations:

clientId

clientSecret

path Parameters

providerId

required

string

Example: ob-natwest

ID of the provider.

query Parameters

filterSandbox

boolean

Filter out sandbox banks so the response contains only live banks.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200

Content type

application/json; charset=utf-8

[{"id": "ob-monzo",
"name": "Monzo",
"logo": "https://provider-api-prod.s3.eu-west-2.amazonaws.com/logo/monzo.png",
"active": true,
"sortCodeRange": "[40003,40006)"
}
]

Get Provider

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"id": "ob-monzo",
"name": "Monzo",
"logo": "https://provider-api-prod.s3.eu-west-2.amazonaws.com/logo/monzo.png",
"active": true,
"sortCodeRange": "[40003,40006)"
}