{"resource_docs":[{"operation_id":"UKv3.1-createFilePaymentConsentsConsentIdFile","implemented_by":{"version":"UKv3.1","function":"createFilePaymentConsentsConsentIdFile"},"request_verb":"POST","request_url":"/open-banking/v3.1/file-payment-consents/CONSENTID/file","summary":"Create File Payment Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payment-consents/CONSENTID/file","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getFooBarList_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getFooBarList_"},"request_verb":"GET","request_url":"/FooBar","summary":"Get FooBar List","description":"

Get FooBar List.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"FooBar"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /FooBar?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get FooBar List.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"FooBar\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /FooBar?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"foo_bar_list":[{"foo_bar_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_FooBar","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"foo_bar_list":{"type":"array","items":{"type":"object","properties":{"foo_bar_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_SystemFooBar","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/FooBar","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updateFishPort_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updateFishPort_"},"request_verb":"PUT","request_url":"/FishPort/FISH_PORT_ID","summary":"Update FishPort","description":"

Update FishPort.

\n

Portfolio of fishbased values

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"FishPort"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update FishPort.\n\nPortfolio of fishbased values\n\n\n**Property List:** \n\n* fish: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"FishPort\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"fish":"James Brown","number":6987233228},"success_response_body":{"fish_port":{"fish_port_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","fish":"James Brown","number":6987233228}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_FishPort","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"fish":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string"},"fish":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_SystemFishPort","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/FishPort/FISH_PORT_ID","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdStatements","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdStatements"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements","summary":"Get Statements","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNTID: ACCOUNTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Statement":[{"AccountId":{},"StatementReference":"StatementReference","StatementDateTime":[{"Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"],"DateTime":"2000-01-23T04:56:07.000+00:00"},{"Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"],"DateTime":"2000-01-23T04:56:07.000+00:00"}],"StatementInterest":[{"Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}],"Type":{},"StartDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","StatementRate":[{"Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"],"Rate":"Rate"},{"Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"],"Rate":"Rate"}],"EndDateTime":"2000-01-23T04:56:07.000+00:00","StatementId":"StatementId","StatementValue":[{"Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"],"Value":0},{"Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"],"Value":0}],"StatementBenefit":[{"Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"],"Amount":{"Amount":{},"Currency":"Currency"}},{"Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"],"Amount":{"Amount":{},"Currency":"Currency"}}],"StatementFee":[{"Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}],"StatementDescription":["StatementDescription","StatementDescription"],"StatementAmount":[{"Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}]},{"AccountId":{},"StatementReference":"StatementReference","StatementDateTime":[{"Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"],"DateTime":"2000-01-23T04:56:07.000+00:00"},{"Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"],"DateTime":"2000-01-23T04:56:07.000+00:00"}],"StatementInterest":[{"Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}],"Type":{},"StartDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","StatementRate":[{"Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"],"Rate":"Rate"},{"Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"],"Rate":"Rate"}],"EndDateTime":"2000-01-23T04:56:07.000+00:00","StatementId":"StatementId","StatementValue":[{"Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"],"Value":0},{"Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"],"Value":0}],"StatementBenefit":[{"Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"],"Amount":{"Amount":{},"Currency":"Currency"}},{"Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"],"Amount":{"Amount":{},"Currency":"Currency"}}],"StatementFee":[{"Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}],"StatementDescription":["StatementDescription","StatementDescription"],"StatementAmount":[{"Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}]}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Statements","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Statement":{"type":"array","items":{"type":"object","properties":{"StatementReference":{"type":"string"},"StatementDateTime":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"DateTime":{"type":"string"}}}},"StatementBenefit":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}}}}},"StatementFee":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}},"StartDateTime":{"type":"string"},"StatementId":{"type":"string"},"CreationDateTime":{"type":"string"},"EndDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"Type":{"type":"object","properties":{}},"StatementValue":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Value":{"type":"integer"}}}},"StatementAmount":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}},"StatementRate":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Rate":{"type":"string"}}}},"StatementDescription":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"StatementInterest":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updatecustomer_cars_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updatecustomer_cars_"},"request_verb":"PUT","request_url":"/customer_cars/CUSTOMER_CARS_ID","summary":"Update customer_cars","description":"

Update customer_cars.

\n

The car the customer arrived in

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"customer_cars"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update customer_cars.\n\nThe car the customer arrived in\n\n\n**Property List:** \n\n* customer_identifier: description of **customer_identifier** field, can be markdown text.\n* manufacturer: description of **manufacturer** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"customer_cars\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a","manufacturer":"BMW"},"success_response_body":{"customer_cars":{"customer_cars_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a","manufacturer":"BMW"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string"},"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_Systemcustomer_cars","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/customer_cars/CUSTOMER_CARS_ID","connector_methods":[]},{"operation_id":"UKv3.1-deleteFundsConfirmationConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"deleteFundsConfirmationConsentsConsentId"},"request_verb":"DELETE","request_url":"/open-banking/v3.1/funds-confirmation-consents/CONSENTID","summary":"Delete Funds Confirmation Consent","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Funds Confirmations","Mocked-Data"],"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/funds-confirmation-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdStandingOrders","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdStandingOrders"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/standing-orders","summary":"Get Standing Orders","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNTID: ACCOUNTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"StandingOrder":[{"SupplementaryData":{},"CreditorAgent":{"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification"},"AccountId":{},"StandingOrderId":"StandingOrderId","Reference":"Reference","StandingOrderStatusCode":{},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"FirstPaymentAmount":{"Amount":{},"Currency":"Currency"},"FinalPaymentAmount":{"Amount":{},"Currency":"Currency"},"FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00","NextPaymentAmount":{"Amount":{},"Currency":"Currency"},"NextPaymentDateTime":"2000-01-23T04:56:07.000+00:00","Frequency":"Frequency","FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00"},{"SupplementaryData":{},"CreditorAgent":{"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification"},"AccountId":{},"StandingOrderId":"StandingOrderId","Reference":"Reference","StandingOrderStatusCode":{},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"FirstPaymentAmount":{"Amount":{},"Currency":"Currency"},"FinalPaymentAmount":{"Amount":{},"Currency":"Currency"},"FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00","NextPaymentAmount":{"Amount":{},"Currency":"Currency"},"NextPaymentDateTime":"2000-01-23T04:56:07.000+00:00","Frequency":"Frequency","FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Standing Orders","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StandingOrder":{"type":"array","items":{"type":"object","properties":{"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"FinalPaymentDateTime":{"type":"string"},"NextPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"FirstPaymentDateTime":{"type":"string"},"StandingOrderStatusCode":{"type":"object","properties":{}},"SupplementaryData":{"type":"object","properties":{}},"Frequency":{"type":"string"},"CreditorAgent":{"type":"object","properties":{"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"}}},"FinalPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"Reference":{"type":"string"},"NextPaymentDateTime":{"type":"string"},"StandingOrderId":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/standing-orders","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalPaymentConsentsConsentIdFundsConfirmation","implemented_by":{"version":"UKv3.1","function":"getInternationalPaymentConsentsConsentIdFundsConfirmation"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-payment-consents/CONSENTID/funds-confirmation","summary":"Get International Payment Consents Funds Confirmation","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"SupplementaryData":{},"FundsAvailableResult":{"FundsAvailableDateTime":"2000-01-23T04:56:07.000+00:00","FundsAvailable":true}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"SupplementaryData":{"type":"object","properties":{}},"FundsAvailableResult":{"type":"object","properties":{"FundsAvailableDateTime":{"type":"string"},"FundsAvailable":{"type":"boolean"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-payment-consents/CONSENTID/funds-confirmation","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getMarchHareList_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getMarchHareList_gh.29.uk"},"request_verb":"GET","request_url":"/banks/gh.29.uk/MarchHare","summary":"Get MarchHare List","description":"

Get MarchHare List.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"MarchHare"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /MarchHare?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get MarchHare List.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"MarchHare\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /MarchHare?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"bank-id":"gh.29.uk","march_hare_list":[{"march_hare_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"march_hare_list":{"type":"array","items":{"type":"object","properties":{"march_hare_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_MarchHare","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/MarchHare","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingleOdometer_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingleOdometer_gh.29.uk"},"request_verb":"GET","request_url":"/banks/gh.29.uk/Odometer/ODOMETER_ID","summary":"Get Odometer by id","description":"

Get Odometer by id.

\n

Verify odometer information for flexible contracts.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"Odometer"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get Odometer by id.\n\nVerify odometer information for flexible contracts.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"Odometer\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"bank-id":"gh.29.uk","odometer":{"odometer_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_Odometer","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/Odometer/ODOMETER_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createsustrans_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createsustrans_"},"request_verb":"POST","request_url":"/sustrans","summary":"Create new sustrans","description":"

Create new sustrans.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"sustrans"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new sustrans.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"sustrans\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"sustrans":{"sustrans_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_Systemsustrans","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/sustrans","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingleFishPort_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingleFishPort_"},"request_verb":"GET","request_url":"/FishPort/FISH_PORT_ID","summary":"Get FishPort by id","description":"

Get FishPort by id.

\n

Portfolio of fishbased values

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"FishPort"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get FishPort by id.\n\nPortfolio of fishbased values\n\n\n**Property List:** \n\n* fish: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"FishPort\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"fish_port":{"fish_port_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","fish":"James Brown","number":6987233228}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_FishPort","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string"},"fish":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_SystemFishPort","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/FishPort/FISH_PORT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updateMypass_3_probe_entity_ac.bank.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updateMypass_3_probe_entity_ac.bank.uk"},"request_verb":"PUT","request_url":"/banks/ac.bank.uk/my/pass_3_probe_entity/PASS_3_PROBE_ENTITY_ID","summary":"Update My pass_3_probe_entity","description":"

Update My pass_3_probe_entity.

\n

Pass-3 probe entity

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"pass_3_probe_entity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update My pass_3_probe_entity.\n\nPass-3 probe entity\n\n\n**Property List:** \n\n* name: Name\n* amount: Amount\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"pass_3_probe_entity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James","amount":100},"success_response_body":{"bank-id":"gh.29.uk","pass_3_probe_entity":{"pass_3_probe_entity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James","amount":100}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["_Pass_3_probe_entity(ac.bank.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"amount":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"pass_3_probe_entity":{"type":"object","properties":{"pass_3_probe_entity_id":{"type":"string"},"name":{"type":"string"},"amount":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_pass_3_probe_entity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/ac.bank.uk/my/pass_3_probe_entity/PASS_3_PROBE_ENTITY_ID","connector_methods":[]},{"operation_id":"UKv3.1-getFilePaymentsFilePaymentIdReportFile","implemented_by":{"version":"UKv3.1","function":"getFilePaymentsFilePaymentIdReportFile"},"request_verb":"GET","request_url":"/open-banking/v3.1/file-payments/FILEPAYMENTID/report-file","summary":"Get File Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

FILEPAYMENTID: FILEPAYMENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[FILEPAYMENTID](/glossary#): FILEPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payments/FILEPAYMENTID/report-file","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getMypass_3_probe_entityList_ac.bank.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getMypass_3_probe_entityList_ac.bank.uk"},"request_verb":"GET","request_url":"/banks/ac.bank.uk/my/pass_3_probe_entity","summary":"Get My pass_3_probe_entity List","description":"

Get My pass_3_probe_entity List.

\n

Pass-3 probe entity

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"pass_3_probe_entity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /pass_3_probe_entity?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get My pass_3_probe_entity List.\n\nPass-3 probe entity\n\n\n**Property List:** \n\n* name: Name\n* amount: Amount\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"pass_3_probe_entity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /pass_3_probe_entity?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"bank-id":"gh.29.uk","pass_3_probe_entity_list":[{"pass_3_probe_entity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James","amount":100}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["_Pass_3_probe_entity(ac.bank.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"pass_3_probe_entity_list":{"type":"array","items":{"type":"object","properties":{"pass_3_probe_entity_id":{"type":"string"},"name":{"type":"string"},"amount":{"type":"integer"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/ac.bank.uk/my/pass_3_probe_entity","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createInsurancePremium_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createInsurancePremium_gh.29.uk"},"request_verb":"POST","request_url":"/banks/gh.29.uk/InsurancePremium","summary":"Create new InsurancePremium","description":"

Create new InsurancePremium.

\n

Retrive the premium for the customer.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"InsurancePremium"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new InsurancePremium.\n\nRetrive the premium for the customer.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"InsurancePremium\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","insurance_premium":{"insurance_premium_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_InsurancePremium","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/InsurancePremium","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_accounts","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEndpoint_POST_accounts"},"request_verb":"POST","request_url":"/accounts","summary":"Post Accounts","description":"

POST Accounts

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEndpointProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"url_pattern",\n        "value":"http://obp_mock//accounts"\n    },\n    {\n        "key":"http_method",\n        "value":"POST"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"POST Accounts\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEndpointProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"url_pattern\",\n \"value\":\"http://obp_mock//accounts\"\n },\n {\n \"key\":\"http_method\",\n \"value\":\"POST\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"name":"family account","balance":1},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Bank Accounts (Dynamic Endpoint)","Dynamic-Endpoint","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"balance":{"type":"integer"}}},"roles":[{"role":"CanCreateDynamicEndpoint_POST_account118","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-endpoint/accounts","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updateOdometer_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updateOdometer_gh.29.uk"},"request_verb":"PUT","request_url":"/banks/gh.29.uk/Odometer/ODOMETER_ID","summary":"Update Odometer","description":"

Update Odometer.

\n

Verify odometer information for flexible contracts.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"Odometer"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update Odometer.\n\nVerify odometer information for flexible contracts.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"Odometer\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","odometer":{"odometer_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_Odometer","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/Odometer/ODOMETER_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getInsurancePremiumList_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getInsurancePremiumList_gh.29.uk"},"request_verb":"GET","request_url":"/banks/gh.29.uk/InsurancePremium","summary":"Get InsurancePremium List","description":"

Get InsurancePremium List.

\n

Retrive the premium for the customer.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"InsurancePremium"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /InsurancePremium?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get InsurancePremium List.\n\nRetrive the premium for the customer.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"InsurancePremium\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /InsurancePremium?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"bank-id":"gh.29.uk","insurance_premium_list":[{"insurance_premium_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_premium_list":{"type":"array","items":{"type":"object","properties":{"insurance_premium_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_InsurancePremium","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/InsurancePremium","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getInsurancePolicyList_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getInsurancePolicyList_gh.29.uk"},"request_verb":"GET","request_url":"/banks/gh.29.uk/InsurancePolicy","summary":"Get InsurancePolicy List","description":"

Get InsurancePolicy List.

\n

Which insurance policies the customer already has.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"InsurancePolicy"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /InsurancePolicy?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get InsurancePolicy List.\n\nWhich insurance policies the customer already has.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"InsurancePolicy\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /InsurancePolicy?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"bank-id":"gh.29.uk","insurance_policy_list":[{"insurance_policy_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_policy_list":{"type":"array","items":{"type":"object","properties":{"insurance_policy_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_InsurancePolicy","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/InsurancePolicy","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getOdometerList_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getOdometerList_gh.29.uk"},"request_verb":"GET","request_url":"/banks/gh.29.uk/Odometer","summary":"Get Odometer List","description":"

Get Odometer List.

\n

Verify odometer information for flexible contracts.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"Odometer"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /Odometer?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get Odometer List.\n\nVerify odometer information for flexible contracts.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"Odometer\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /Odometer?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"bank-id":"gh.29.uk","odometer_list":[{"odometer_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"odometer_list":{"type":"array","items":{"type":"object","properties":{"odometer_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_Odometer","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/Odometer","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticPaymentConsentsConsentIdFundsConfirmation","implemented_by":{"version":"UKv3.1","function":"getDomesticPaymentConsentsConsentIdFundsConfirmation"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-payment-consents/CONSENTID/funds-confirmation","summary":"Get Domestic Payment Consents Funds Confirmation","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"SupplementaryData":{},"FundsAvailableResult":{"FundsAvailableDateTime":"2000-01-23T04:56:07.000+00:00","FundsAvailable":true}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"SupplementaryData":{"type":"object","properties":{}},"FundsAvailableResult":{"type":"object","properties":{"FundsAvailableDateTime":{"type":"string"},"FundsAvailable":{"type":"boolean"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-payment-consents/CONSENTID/funds-confirmation","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deleteMarchHare_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deleteMarchHare_gh.29.uk"},"request_verb":"DELETE","request_url":"/banks/gh.29.uk/MarchHare/MARCH_HARE_ID","summary":"Delete MarchHare by id","description":"

Delete MarchHare by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"MarchHare"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete MarchHare by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"MarchHare\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","march_hare":{"march_hare_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_MarchHare","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/MarchHare/MARCH_HARE_ID","connector_methods":[]},{"operation_id":"UKv3.1-getDirectDebits","implemented_by":{"version":"UKv3.1","function":"getDirectDebits"},"request_verb":"GET","request_url":"/open-banking/v3.1/direct-debits","summary":"Get Direct Debits","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"DirectDebit":[{"PreviousPaymentDateTime":"2000-01-23T04:56:07.000+00:00","AccountId":{},"MandateIdentification":"MandateIdentification","DirectDebitStatusCode":{},"DirectDebitId":"DirectDebitId","PreviousPaymentAmount":{"Amount":{},"Currency":"Currency"},"Name":"Name"},{"PreviousPaymentDateTime":"2000-01-23T04:56:07.000+00:00","AccountId":{},"MandateIdentification":"MandateIdentification","DirectDebitStatusCode":{},"DirectDebitId":"DirectDebitId","PreviousPaymentAmount":{"Amount":{},"Currency":"Currency"},"Name":"Name"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Direct Debits","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"DirectDebit":{"type":"array","items":{"type":"object","properties":{"PreviousPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"Name":{"type":"string"},"DirectDebitStatusCode":{"type":"object","properties":{}},"AccountId":{"type":"object","properties":{}},"MandateIdentification":{"type":"string"},"DirectDebitId":{"type":"string"},"PreviousPaymentDateTime":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/direct-debits","connector_methods":[]},{"operation_id":"UKv3.1-createInternationalStandingOrders","implemented_by":{"version":"UKv3.1","function":"createInternationalStandingOrders"},"request_verb":"POST","request_url":"/open-banking/v3.1/international-standing-orders","summary":"Create International Standing Orders","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"InternationalStandingOrderId":"InternationalStandingOrderId","ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"Reference":"Reference","CurrencyOfTransfer":"CurrencyOfTransfer","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Purpose":{},"ChargeBearer":{},"FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00","Frequency":"Frequency","FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00","NumberOfPayments":"NumberOfPayments","Creditor":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"Name":"Name"},"InstructedAmount":{"Currency":"Currency"}},"MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Standing Orders","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"InternationalStandingOrderId":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"Frequency":{"type":"string"},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"Reference":{"type":"string"}}},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-standing-orders","connector_methods":[]},{"operation_id":"UKv3.1-createInternationalScheduledPayments","implemented_by":{"version":"UKv3.1","function":"createInternationalScheduledPayments"},"request_verb":"POST","request_url":"/open-banking/v3.1/international-scheduled-payments","summary":"Create International Scheduled Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","ExchangeRateInformation":{"ExchangeRate":0.8008281904610115,"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","RateType":{},"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"InternationalScheduledPaymentId":"InternationalScheduledPaymentId","Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CurrencyOfTransfer":"CurrencyOfTransfer","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Purpose":{},"ChargeBearer":{},"InstructionPriority":{},"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"ExchangeRateInformation":{"ExchangeRate":6.027456183070403,"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Creditor":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"Name":"Name"},"InstructedAmount":{"Currency":"Currency"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00","MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Scheduled Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}},"InternationalScheduledPaymentId":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-scheduled-payments","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deletetest1_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deletetest1_"},"request_verb":"DELETE","request_url":"/test1/TEST1_ID","summary":"Delete test1 by id","description":"

Delete test1 by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test1"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete test1 by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test1\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"test1":{"test1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Test1","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_Systemtest1","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/test1/TEST1_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updateMarchHare_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updateMarchHare_gh.29.uk"},"request_verb":"PUT","request_url":"/banks/gh.29.uk/MarchHare/MARCH_HARE_ID","summary":"Update MarchHare","description":"

Update MarchHare.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"MarchHare"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update MarchHare.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"MarchHare\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","march_hare":{"march_hare_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_MarchHare","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/MarchHare/MARCH_HARE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createOdometer_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createOdometer_gh.29.uk"},"request_verb":"POST","request_url":"/banks/gh.29.uk/Odometer","summary":"Create new Odometer","description":"

Create new Odometer.

\n

Verify odometer information for flexible contracts.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"Odometer"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new Odometer.\n\nVerify odometer information for flexible contracts.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"Odometer\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","odometer":{"odometer_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_Odometer","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/Odometer","connector_methods":[]},{"operation_id":"UKv3.1-createDomesticScheduledPaymentConsents","implemented_by":{"version":"UKv3.1","function":"createDomesticScheduledPaymentConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/domestic-scheduled-payment-consents","summary":"Create Domestic Scheduled Payment Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Risk":{"PaymentContextCode":{},"DeliveryAddress":{"StreetName":"StreetName","CountrySubDivision":["CountrySubDivision","CountrySubDivision"],"AddressLine":["AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","PostCode":"PostCode"},"MerchantCategoryCode":"MerchantCategoryCode","MerchantCustomerIdentification":"MerchantCustomerIdentification"},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Permission":{},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","InstructedAmount":{"Currency":"Currency"},"CreditorPostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Scheduled Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Permission":{"type":"object","properties":{}},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-scheduled-payment-consents","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdStatementsStatementId","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdStatementsStatementId"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID","summary":"Get Statements","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNTID: ACCOUNTID

\n

STATEMENTID: STATEMENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n[STATEMENTID](/glossary#): STATEMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Statement":[{"AccountId":{},"StatementReference":"StatementReference","StatementDateTime":[{"Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"],"DateTime":"2000-01-23T04:56:07.000+00:00"},{"Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"],"DateTime":"2000-01-23T04:56:07.000+00:00"}],"StatementInterest":[{"Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}],"Type":{},"StartDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","StatementRate":[{"Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"],"Rate":"Rate"},{"Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"],"Rate":"Rate"}],"EndDateTime":"2000-01-23T04:56:07.000+00:00","StatementId":"StatementId","StatementValue":[{"Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"],"Value":0},{"Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"],"Value":0}],"StatementBenefit":[{"Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"],"Amount":{"Amount":{},"Currency":"Currency"}},{"Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"],"Amount":{"Amount":{},"Currency":"Currency"}}],"StatementFee":[{"Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}],"StatementDescription":["StatementDescription","StatementDescription"],"StatementAmount":[{"Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}]},{"AccountId":{},"StatementReference":"StatementReference","StatementDateTime":[{"Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"],"DateTime":"2000-01-23T04:56:07.000+00:00"},{"Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"],"DateTime":"2000-01-23T04:56:07.000+00:00"}],"StatementInterest":[{"Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}],"Type":{},"StartDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","StatementRate":[{"Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"],"Rate":"Rate"},{"Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"],"Rate":"Rate"}],"EndDateTime":"2000-01-23T04:56:07.000+00:00","StatementId":"StatementId","StatementValue":[{"Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"],"Value":0},{"Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"],"Value":0}],"StatementBenefit":[{"Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"],"Amount":{"Amount":{},"Currency":"Currency"}},{"Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"],"Amount":{"Amount":{},"Currency":"Currency"}}],"StatementFee":[{"Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}],"StatementDescription":["StatementDescription","StatementDescription"],"StatementAmount":[{"Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}]}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Statements","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Statement":{"type":"array","items":{"type":"object","properties":{"StatementReference":{"type":"string"},"StatementDateTime":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"DateTime":{"type":"string"}}}},"StatementBenefit":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}}}}},"StatementFee":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}},"StartDateTime":{"type":"string"},"StatementId":{"type":"string"},"CreationDateTime":{"type":"string"},"EndDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"Type":{"type":"object","properties":{}},"StatementValue":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Value":{"type":"integer"}}}},"StatementAmount":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}},"StatementRate":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Rate":{"type":"string"}}}},"StatementDescription":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"StatementInterest":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deletesustrans_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deletesustrans_"},"request_verb":"DELETE","request_url":"/sustrans/SUSTRANS_ID","summary":"Delete sustrans by id","description":"

Delete sustrans by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"sustrans"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete sustrans by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"sustrans\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"sustrans":{"sustrans_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_Systemsustrans","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/sustrans/SUSTRANS_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingleSimonCovid_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingleSimonCovid_"},"request_verb":"GET","request_url":"/SimonCovid/SIMON_COVID_ID","summary":"Get SimonCovid by id","description":"

Get SimonCovid by id.

\n

Let's put Covid99 stuff here

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"SimonCovid"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get SimonCovid by id.\n\nLet's put Covid99 stuff here\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"SimonCovid\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"simon_covid":{"simon_covid_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_SystemSimonCovid","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/SimonCovid/SIMON_COVID_ID","connector_methods":[]},{"operation_id":"UKv3.1-getParty","implemented_by":{"version":"UKv3.1","function":"getParty"},"request_verb":"GET","request_url":"/open-banking/v3.1/party","summary":"Get Party","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Party":{"PartyNumber":"PartyNumber","PartyId":"PartyId","Address":[{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","AddressType":{},"PostCode":"PostCode"},{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","AddressType":{},"PostCode":"PostCode"}],"Phone":"Phone","Mobile":"Mobile","PartyType":{},"EmailAddress":"EmailAddress","Name":"Name"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Partys","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Party":{"type":"object","properties":{"EmailAddress":{"type":"string"},"PartyType":{"type":"object","properties":{}},"Name":{"type":"string"},"Mobile":{"type":"string"},"Address":{"type":"array","items":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"PostCode":{"type":"string"}}}},"PartyId":{"type":"string"},"Phone":{"type":"string"},"PartyNumber":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/party","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticPaymentConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getDomesticPaymentConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-payment-consents/CONSENTID","summary":"Get Domestic Payment Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Risk":{"PaymentContextCode":{},"DeliveryAddress":{"StreetName":"StreetName","CountrySubDivision":["CountrySubDivision","CountrySubDivision"],"AddressLine":["AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","PostCode":"PostCode"},"MerchantCategoryCode":"MerchantCategoryCode","MerchantCustomerIdentification":"MerchantCustomerIdentification"},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"InstructedAmount":{"Currency":"Currency"},"CreditorPostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-payment-consents/CONSENTID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deleteMytest_daniel707_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deleteMytest_daniel707_"},"request_verb":"DELETE","request_url":"/my/test_daniel707/TEST_DANIEL707_ID","summary":"Delete My test_daniel707 by id","description":"

Delete My test_daniel707 by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test_daniel707"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete My test_daniel707 by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test_daniel707\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"test_daniel707":{"test_daniel707_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/my/test_daniel707/TEST_DANIEL707_ID","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalStandingOrdersInternationalStandingOrderPaymentId","implemented_by":{"version":"UKv3.1","function":"getInternationalStandingOrdersInternationalStandingOrderPaymentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-standing-orders/INTERNATIONALSTANDINGORDERPAYMENTID","summary":"Get International Standing Orders","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

INTERNATIONALSTANDINGORDERPAYMENTID: INTERNATIONALSTANDINGORDERPAYMENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[INTERNATIONALSTANDINGORDERPAYMENTID](/glossary#): INTERNATIONALSTANDINGORDERPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"InternationalStandingOrderId":"InternationalStandingOrderId","ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"Reference":"Reference","CurrencyOfTransfer":"CurrencyOfTransfer","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Purpose":{},"ChargeBearer":{},"FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00","Frequency":"Frequency","FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00","NumberOfPayments":"NumberOfPayments","Creditor":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"Name":"Name"},"InstructedAmount":{"Currency":"Currency"}},"MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Standing Orders","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"InternationalStandingOrderId":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"Frequency":{"type":"string"},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"Reference":{"type":"string"}}},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-standing-orders/INTERNATIONALSTANDINGORDERPAYMENTID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingletest1_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingletest1_"},"request_verb":"GET","request_url":"/test1/TEST1_ID","summary":"Get test1 by id","description":"

Get test1 by id.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test1"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get test1 by id.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test1\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"test1":{"test1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_Test1","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_Systemtest1","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/test1/TEST1_ID","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticScheduledPaymentsDomesticScheduledPaymentId","implemented_by":{"version":"UKv3.1","function":"getDomesticScheduledPaymentsDomesticScheduledPaymentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-scheduled-payments/DOMESTICSCHEDULEDPAYMENTID","summary":"Get Domestic Scheduled Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

DOMESTICSCHEDULEDPAYMENTID: DOMESTICSCHEDULEDPAYMENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[DOMESTICSCHEDULEDPAYMENTID](/glossary#): DOMESTICSCHEDULEDPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","DomesticScheduledPaymentId":"DomesticScheduledPaymentId","Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","InstructedAmount":{"Currency":"Currency"},"CreditorPostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00","MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Scheduled Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"DomesticScheduledPaymentId":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-scheduled-payments/DOMESTICSCHEDULEDPAYMENTID","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalScheduledPaymentConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getInternationalScheduledPaymentConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-scheduled-payment-consents/CONSENTID","summary":"Get International Scheduled Payment Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Risk":{"PaymentContextCode":{},"DeliveryAddress":{"StreetName":"StreetName","CountrySubDivision":["CountrySubDivision","CountrySubDivision"],"AddressLine":["AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","PostCode":"PostCode"},"MerchantCategoryCode":"MerchantCategoryCode","MerchantCustomerIdentification":"MerchantCustomerIdentification"},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","ExchangeRateInformation":{"ExchangeRate":0.8008281904610115,"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","RateType":{},"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Permission":{},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CurrencyOfTransfer":"CurrencyOfTransfer","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Purpose":{},"ChargeBearer":{},"InstructionPriority":{},"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"ExchangeRateInformation":{"ExchangeRate":6.027456183070403,"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Creditor":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"Name":"Name"},"InstructedAmount":{"Currency":"Currency"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Scheduled Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"Permission":{"type":"object","properties":{}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-scheduled-payment-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdStatementsStatementIdTransactions","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdStatementsStatementIdTransactions"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/transactions","summary":"Get Transactions","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNTID: ACCOUNTID

\n

STATEMENTID: STATEMENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n[STATEMENTID](/glossary#): STATEMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":"2019-03-06T07:38:51.169Z","LastAvailableDateTime":"2019-03-06T07:38:51.169Z","TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Transaction":[{"Status":"string","SupplementaryData":{},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"AccountId":"string","TransactionReference":"TransactionReference","ProprietaryBankTransactionCode":{"Issuer":"Issuer","Code":"Code"},"AddressLine":"AddressLine","Amount":{"Amount":"string","Currency":"Currency"},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditDebitIndicator":"Credit","CurrencyExchange":{"SourceCurrency":"SourceCurrency","ExchangeRate":0.8008281904610115,"QuotationDate":"2000-01-23T04:56:07.000+00:00","UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification","InstructedAmount":{"Amount":"string","Currency":"Currency"},"TargetCurrency":"TargetCurrency"},"StatementReference":["StatementReference","StatementReference"],"ChargeAmount":{"Amount":"string","Currency":"Currency"},"TransactionId":"TransactionId","TransactionInformation":"string","BookingDateTime":"2000-01-23T04:56:07.000+00:00","BankTransactionCode":{"SubCode":"SubCode","Code":"Code"},"MerchantDetails":{"MerchantName":"MerchantName","MerchantCategoryCode":"MerchantCategoryCode"},"CardInstrument":{"AuthorisationType":"string","Identification":"Identification","CardSchemeName":"string","Name":"Name"},"ValueDateTime":"2000-01-23T04:56:07.000+00:00","DebtorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"Balance":{"Type":"string","Amount":{"Amount":"string","Currency":"Currency"},"CreditDebitIndicator":"Credit"}},{"Status":"string","SupplementaryData":{},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"AccountId":"string","TransactionReference":"TransactionReference","ProprietaryBankTransactionCode":{"Issuer":"Issuer","Code":"Code"},"AddressLine":"AddressLine","Amount":{"Amount":"string","Currency":"Currency"},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditDebitIndicator":"Credit","CurrencyExchange":{"SourceCurrency":"SourceCurrency","ExchangeRate":0.8008281904610115,"QuotationDate":"2000-01-23T04:56:07.000+00:00","UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification","InstructedAmount":{"Amount":"string","Currency":"Currency"},"TargetCurrency":"TargetCurrency"},"StatementReference":["StatementReference","StatementReference"],"ChargeAmount":{"Amount":"string","Currency":"Currency"},"TransactionId":"TransactionId","TransactionInformation":"string","BookingDateTime":"2000-01-23T04:56:07.000+00:00","BankTransactionCode":{"SubCode":"SubCode","Code":"Code"},"MerchantDetails":{"MerchantName":"MerchantName","MerchantCategoryCode":"MerchantCategoryCode"},"CardInstrument":{"AuthorisationType":"string","Identification":"Identification","CardSchemeName":"string","Name":"Name"},"ValueDateTime":"2000-01-23T04:56:07.000+00:00","DebtorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"Balance":{"Type":"string","Amount":{"Amount":"string","Currency":"Currency"},"CreditDebitIndicator":"Credit"}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Statements","Transactions","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"string"},"LastAvailableDateTime":{"type":"string"},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Transaction":{"type":"array","items":{"type":"object","properties":{"TransactionId":{"type":"string"},"StatementReference":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"MerchantDetails":{"type":"object","properties":{"MerchantName":{"type":"string"},"MerchantCategoryCode":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CurrencyExchange":{"type":"object","properties":{"QuotationDate":{"type":"string"},"SourceCurrency":{"type":"string"},"TargetCurrency":{"type":"string"},"ExchangeRate":{"type":"number"},"ContractIdentification":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"UnitCurrency":{"type":"string"}}},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"BankTransactionCode":{"type":"object","properties":{"SubCode":{"type":"string"},"Code":{"type":"string"}}},"Balance":{"type":"object","properties":{"Type":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}},"TransactionInformation":{"type":"string"},"DebtorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressType":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ProprietaryBankTransactionCode":{"type":"object","properties":{"Issuer":{"type":"string"},"Code":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressType":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ValueDateTime":{"type":"string"},"ChargeAmount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"TransactionReference":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"AccountId":{"type":"string"},"BookingDateTime":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"AddressLine":{"type":"string"},"CardInstrument":{"type":"object","properties":{"AuthorisationType":{"type":"string"},"Identification":{"type":"string"},"CardSchemeName":{"type":"string"},"Name":{"type":"string"}}},"Status":{"type":"string"},"CreditDebitIndicator":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/transactions","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdScheduledPayments","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdScheduledPayments"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/scheduled-payments","summary":"Get Scheduled Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNTID: ACCOUNTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"ScheduledPayment":[{"CreditorAgent":{"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification"},"AccountId":{},"Reference":"Reference","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"ScheduledPaymentDateTime":"2000-01-23T04:56:07.000+00:00","InstructedAmount":{"Amount":{},"Currency":"Currency"},"ScheduledPaymentId":"ScheduledPaymentId","ScheduledType":{}},{"CreditorAgent":{"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification"},"AccountId":{},"Reference":"Reference","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"ScheduledPaymentDateTime":"2000-01-23T04:56:07.000+00:00","InstructedAmount":{"Amount":{},"Currency":"Currency"},"ScheduledPaymentId":"ScheduledPaymentId","ScheduledType":{}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Scheduled Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ScheduledPayment":{"type":"array","items":{"type":"object","properties":{"ScheduledType":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ScheduledPaymentId":{"type":"string"},"ScheduledPaymentDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"}}},"Reference":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/scheduled-payments","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createCovidAPIDays_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createCovidAPIDays_"},"request_verb":"POST","request_url":"/CovidAPIDays","summary":"Create new CovidAPIDays","description":"

Create new CovidAPIDays.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"CovidAPIDays"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new CovidAPIDays.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"CovidAPIDays\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"covid_api_days":{"covid_api_days_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_SystemCovidAPIDays","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/CovidAPIDays","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deleteObpActivity_obp.testing.01","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deleteObpActivity_obp.testing.01"},"request_verb":"DELETE","request_url":"/banks/obp.testing.01/ObpActivity/OBP_ACTIVITY_ID","summary":"Delete ObpActivity by id","description":"

Delete ObpActivity by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"ObpActivity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete ObpActivity by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"ObpActivity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","username":"James Brown","created_date":"698761728"},"success_response_body":{"bank-id":"gh.29.uk","obp_activity":{"obp_activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","username":"James Brown","created_date":"698761728"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_ObpActivity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/obp.testing.01/ObpActivity/OBP_ACTIVITY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createFooBar_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createFooBar_"},"request_verb":"POST","request_url":"/FooBar","summary":"Create new FooBar","description":"

Create new FooBar.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"FooBar"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new FooBar.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"FooBar\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"foo_bar":{"foo_bar_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_FooBar","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_SystemFooBar","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/FooBar","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updatepass_3_probe_entity_ac.bank.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updatepass_3_probe_entity_ac.bank.uk"},"request_verb":"PUT","request_url":"/banks/ac.bank.uk/pass_3_probe_entity/PASS_3_PROBE_ENTITY_ID","summary":"Update pass_3_probe_entity","description":"

Update pass_3_probe_entity.

\n

Pass-3 probe entity

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"pass_3_probe_entity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update pass_3_probe_entity.\n\nPass-3 probe entity\n\n\n**Property List:** \n\n* name: Name\n* amount: Amount\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"pass_3_probe_entity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James","amount":100},"success_response_body":{"bank-id":"gh.29.uk","pass_3_probe_entity":{"pass_3_probe_entity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James","amount":100}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Pass_3_probe_entity(ac.bank.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"amount":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"pass_3_probe_entity":{"type":"object","properties":{"pass_3_probe_entity_id":{"type":"string"},"name":{"type":"string"},"amount":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_pass_3_probe_entity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/ac.bank.uk/pass_3_probe_entity/PASS_3_PROBE_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updateD-Entity1_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updateD-Entity1_gh.29.uk"},"request_verb":"PUT","request_url":"/banks/gh.29.uk/D-Entity1/D-ENTITY1_ID","summary":"Update D-Entity1","description":"

Update D-Entity1.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"D-Entity1"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update D-Entity1.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"D-Entity1\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","d-entity1":{"d-entity1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_D-Entity1","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/D-Entity1/D-ENTITY1_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSinglepass_3_probe_entity_ac.bank.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSinglepass_3_probe_entity_ac.bank.uk"},"request_verb":"GET","request_url":"/banks/ac.bank.uk/pass_3_probe_entity/PASS_3_PROBE_ENTITY_ID","summary":"Get pass_3_probe_entity by id","description":"

Get pass_3_probe_entity by id.

\n

Pass-3 probe entity

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"pass_3_probe_entity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get pass_3_probe_entity by id.\n\nPass-3 probe entity\n\n\n**Property List:** \n\n* name: Name\n* amount: Amount\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"pass_3_probe_entity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"bank-id":"gh.29.uk","pass_3_probe_entity":{"pass_3_probe_entity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James","amount":100}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_Pass_3_probe_entity(ac.bank.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"pass_3_probe_entity":{"type":"object","properties":{"pass_3_probe_entity_id":{"type":"string"},"name":{"type":"string"},"amount":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_pass_3_probe_entity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/ac.bank.uk/pass_3_probe_entity/PASS_3_PROBE_ENTITY_ID","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalScheduledPaymentsInternationalScheduledPaymentId","implemented_by":{"version":"UKv3.1","function":"getInternationalScheduledPaymentsInternationalScheduledPaymentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-scheduled-payments/INTERNATIONALSCHEDULEDPAYMENTID","summary":"Get International Scheduled Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

INTERNATIONALSCHEDULEDPAYMENTID: INTERNATIONALSCHEDULEDPAYMENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[INTERNATIONALSCHEDULEDPAYMENTID](/glossary#): INTERNATIONALSCHEDULEDPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","ExchangeRateInformation":{"ExchangeRate":0.8008281904610115,"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","RateType":{},"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"InternationalScheduledPaymentId":"InternationalScheduledPaymentId","Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CurrencyOfTransfer":"CurrencyOfTransfer","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Purpose":{},"ChargeBearer":{},"InstructionPriority":{},"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"ExchangeRateInformation":{"ExchangeRate":6.027456183070403,"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Creditor":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"Name":"Name"},"InstructedAmount":{"Currency":"Currency"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00","MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Scheduled Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}},"InternationalScheduledPaymentId":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-scheduled-payments/INTERNATIONALSCHEDULEDPAYMENTID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSinglecustomer_cars_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSinglecustomer_cars_"},"request_verb":"GET","request_url":"/customer_cars/CUSTOMER_CARS_ID","summary":"Get customer_cars by id","description":"

Get customer_cars by id.

\n

The car the customer arrived in

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"customer_cars"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get customer_cars by id.\n\nThe car the customer arrived in\n\n\n**Property List:** \n\n* customer_identifier: description of **customer_identifier** field, can be markdown text.\n* manufacturer: description of **manufacturer** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"customer_cars\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"customer_cars":{"customer_cars_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a","manufacturer":"BMW"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string"},"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}}}},"roles":[{"role":"CanGetDynamicEntity_Systemcustomer_cars","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/customer_cars/CUSTOMER_CARS_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingleD-Entity1_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingleD-Entity1_gh.29.uk"},"request_verb":"GET","request_url":"/banks/gh.29.uk/D-Entity1/D-ENTITY1_ID","summary":"Get D-Entity1 by id","description":"

Get D-Entity1 by id.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"D-Entity1"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get D-Entity1 by id.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"D-Entity1\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"bank-id":"gh.29.uk","d-entity1":{"d-entity1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_D-Entity1","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/D-Entity1/D-ENTITY1_ID","connector_methods":[]},{"operation_id":"UKv3.1-createFilePayments","implemented_by":{"version":"UKv3.1","function":"createFilePayments"},"request_verb":"POST","request_url":"/open-banking/v3.1/file-payments","summary":"Create File Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","FilePaymentId":"FilePaymentId","Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"ControlSum":0.8008281904610115,"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"FileType":["UK.OBIE.PaymentInitiation.3.1","UK.OBIE.pain.001.001.08"],"FileHash":"FileHash","NumberOfTransactions":"NumberOfTransactions","FileReference":"FileReference","RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"},"MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"RequestedExecutionDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfTransactions":{"type":"string"},"ControlSum":{"type":"number"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"FileHash":{"type":"string"},"FileReference":{"type":"string"},"FileType":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"FilePaymentId":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payments","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEndpoint_GET_banks_ac_bank_uk_probe","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEndpoint_GET_banks_ac_bank_uk_probe"},"request_verb":"GET","request_url":"/banks/ac.bank.uk/probe","summary":"Probe","description":"

probe

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEndpointProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"url_pattern",\n        "value":"//banks/ac.bank.uk/probe"\n    },\n    {\n        "key":"http_method",\n        "value":"GET"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"probe\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEndpointProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"url_pattern\",\n \"value\":\"//banks/ac.bank.uk/probe\"\n },\n {\n \"key\":\"http_method\",\n \"value\":\"GET\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":"ok","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Pass-3 probe endpoint","Dynamic-Endpoint","Dynamic"],"roles":[{"role":"CanGetDynamicEndpoint_Probe723","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-endpoint/banks/ac.bank.uk/probe","connector_methods":[]},{"operation_id":"UKv3.1-createDomesticScheduledPayments","implemented_by":{"version":"UKv3.1","function":"createDomesticScheduledPayments"},"request_verb":"POST","request_url":"/open-banking/v3.1/domestic-scheduled-payments","summary":"Create Domestic Scheduled Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","DomesticScheduledPaymentId":"DomesticScheduledPaymentId","Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","InstructedAmount":{"Currency":"Currency"},"CreditorPostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00","MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Scheduled Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"DomesticScheduledPaymentId":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-scheduled-payments","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdBeneficiaries","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdBeneficiaries"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/beneficiaries","summary":"Get Beneficiaries","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNTID: ACCOUNTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Beneficiary":[{"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"AccountId":{},"Reference":"Reference","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"BeneficiaryId":"BeneficiaryId"},{"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"AccountId":{},"Reference":"Reference","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"BeneficiaryId":"BeneficiaryId"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Beneficiaries","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Beneficiary":{"type":"array","items":{"type":"object","properties":{"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"BeneficiaryId":{"type":"string"},"Reference":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/beneficiaries","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deleteFooBar_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deleteFooBar_"},"request_verb":"DELETE","request_url":"/FooBar/FOO_BAR_ID","summary":"Delete FooBar by id","description":"

Delete FooBar by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"FooBar"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete FooBar by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"FooBar\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"foo_bar":{"foo_bar_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_FooBar","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_SystemFooBar","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/FooBar/FOO_BAR_ID","connector_methods":[]},{"operation_id":"UKv3.1-createAccountAccessConsents","implemented_by":{"version":"UKv3.1","function":"createAccountAccessConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/account-access-consents","summary":"Create Account Access Consents","description":"

Create Account Access Consents

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"Create Account Access Consents\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"Data":{"Permissions":["ReadAccountsBasic"],"ExpirationDateTime":"2020-10-20T08:40:47.285Z","TransactionFromDateTime":"2020-10-20T08:40:47.285Z","TransactionToDateTime":"2020-10-20T08:40:47.285Z"},"Risk":""},"success_response_body":{"Data":{"ConsentId":"string","CreationDateTime":"2020-10-20T08:40:47.375Z","Status":"Authorised","StatusUpdateDateTime":"2020-10-20T08:40:47.375Z","Permissions":["ReadAccountsBasic"],"ExpirationDateTime":"2020-10-20T08:40:47.375Z","TransactionFromDateTime":"2020-10-20T08:40:47.375Z","TransactionToDateTime":"2020-10-20T08:40:47.375Z"},"Risk":{},"Links":{"Self":"https://apisandbox.openbankproject.com/open-banking/v3.1/account-access-consents/CONSENT_ID"},"Meta":{"TotalPages":0,"FirstAvailableDateTime":"2020-10-20T08:40:47.375Z","LastAvailableDateTime":"2020-10-20T08:40:47.375Z"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Access"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"Data":{"type":"object","properties":{"Permissions":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"ExpirationDateTime":{"type":"string"},"TransactionFromDateTime":{"type":"string"},"TransactionToDateTime":{"type":"string"}}},"Risk":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Data":{"type":"object","properties":{"ConsentId":{"type":"string"},"Status":{"type":"string"},"CreationDateTime":{"type":"string"},"TransactionToDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"Permissions":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TransactionFromDateTime":{"type":"string"},"ExpirationDateTime":{"type":"string"}}},"Risk":{"type":"object","properties":{}},"Links":{"type":"object","properties":{"Self":{"type":"string"}}},"Meta":{"type":"object","properties":{"TotalPages":{"type":"integer"},"FirstAvailableDateTime":{"type":"string"},"LastAvailableDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/account-access-consents","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingleMypass_3_probe_entity_ac.bank.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingleMypass_3_probe_entity_ac.bank.uk"},"request_verb":"GET","request_url":"/banks/ac.bank.uk/my/pass_3_probe_entity/PASS_3_PROBE_ENTITY_ID","summary":"Get My pass_3_probe_entity by id","description":"

Get My pass_3_probe_entity by id.

\n

Pass-3 probe entity

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"pass_3_probe_entity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get My pass_3_probe_entity by id.\n\nPass-3 probe entity\n\n\n**Property List:** \n\n* name: Name\n* amount: Amount\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"pass_3_probe_entity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"bank-id":"gh.29.uk","pass_3_probe_entity":{"pass_3_probe_entity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James","amount":100}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["_Pass_3_probe_entity(ac.bank.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"pass_3_probe_entity":{"type":"object","properties":{"pass_3_probe_entity_id":{"type":"string"},"name":{"type":"string"},"amount":{"type":"integer"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/ac.bank.uk/my/pass_3_probe_entity/PASS_3_PROBE_ENTITY_ID","connector_methods":[]},{"operation_id":"UKv3.1-getStatements","implemented_by":{"version":"UKv3.1","function":"getStatements"},"request_verb":"GET","request_url":"/open-banking/v3.1/statements","summary":"Get Statements","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Statement":[{"AccountId":{},"StatementReference":"StatementReference","StatementDateTime":[{"Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"],"DateTime":"2000-01-23T04:56:07.000+00:00"},{"Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"],"DateTime":"2000-01-23T04:56:07.000+00:00"}],"StatementInterest":[{"Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}],"Type":{},"StartDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","StatementRate":[{"Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"],"Rate":"Rate"},{"Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"],"Rate":"Rate"}],"EndDateTime":"2000-01-23T04:56:07.000+00:00","StatementId":"StatementId","StatementValue":[{"Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"],"Value":0},{"Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"],"Value":0}],"StatementBenefit":[{"Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"],"Amount":{"Amount":{},"Currency":"Currency"}},{"Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"],"Amount":{"Amount":{},"Currency":"Currency"}}],"StatementFee":[{"Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}],"StatementDescription":["StatementDescription","StatementDescription"],"StatementAmount":[{"Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}]},{"AccountId":{},"StatementReference":"StatementReference","StatementDateTime":[{"Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"],"DateTime":"2000-01-23T04:56:07.000+00:00"},{"Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"],"DateTime":"2000-01-23T04:56:07.000+00:00"}],"StatementInterest":[{"Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}],"Type":{},"StartDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","StatementRate":[{"Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"],"Rate":"Rate"},{"Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"],"Rate":"Rate"}],"EndDateTime":"2000-01-23T04:56:07.000+00:00","StatementId":"StatementId","StatementValue":[{"Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"],"Value":0},{"Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"],"Value":0}],"StatementBenefit":[{"Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"],"Amount":{"Amount":{},"Currency":"Currency"}},{"Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"],"Amount":{"Amount":{},"Currency":"Currency"}}],"StatementFee":[{"Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}],"StatementDescription":["StatementDescription","StatementDescription"],"StatementAmount":[{"Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"},{"Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit"}]}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Statements","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Statement":{"type":"array","items":{"type":"object","properties":{"StatementReference":{"type":"string"},"StatementDateTime":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"DateTime":{"type":"string"}}}},"StatementBenefit":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}}}}},"StatementFee":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}},"StartDateTime":{"type":"string"},"StatementId":{"type":"string"},"CreationDateTime":{"type":"string"},"EndDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"Type":{"type":"object","properties":{}},"StatementValue":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Value":{"type":"integer"}}}},"StatementAmount":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}},"StatementRate":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Rate":{"type":"string"}}}},"StatementDescription":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"StatementInterest":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/statements","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_gettest1List_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_gettest1List_"},"request_verb":"GET","request_url":"/test1","summary":"Get test1 List","description":"

Get test1 List.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test1"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /test1?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get test1 List.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test1\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /test1?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"test1_list":[{"test1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_Test1","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"test1_list":{"type":"array","items":{"type":"object","properties":{"test1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_Systemtest1","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/test1","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingletest_daniel707_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingletest_daniel707_"},"request_verb":"GET","request_url":"/test_daniel707/TEST_DANIEL707_ID","summary":"Get test_daniel707 by id","description":"

Get test_daniel707 by id.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test_daniel707"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get test_daniel707 by id.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test_daniel707\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"test_daniel707":{"test_daniel707_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_Systemtest_daniel707","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/test_daniel707/TEST_DANIEL707_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createtest1_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createtest1_"},"request_verb":"POST","request_url":"/test1","summary":"Create new test1","description":"

Create new test1.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test1"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new test1.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test1\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"test1":{"test1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Test1","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_Systemtest1","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/test1","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdOffers","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdOffers"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/offers","summary":"Get Offers","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNTID: ACCOUNTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Offer":[{"OfferId":"OfferId","AccountId":{},"Description":"Description","StartDateTime":"2000-01-23T04:56:07.000+00:00","EndDateTime":"2000-01-23T04:56:07.000+00:00","Rate":"Rate","Amount":{"Amount":{},"Currency":"Currency"},"Fee":{"Amount":{},"Currency":"Currency"},"Value":0,"Term":"Term","URL":"URL","OfferType":{}},{"OfferId":"OfferId","AccountId":{},"Description":"Description","StartDateTime":"2000-01-23T04:56:07.000+00:00","EndDateTime":"2000-01-23T04:56:07.000+00:00","Rate":"Rate","Amount":{"Amount":{},"Currency":"Currency"},"Fee":{"Amount":{},"Currency":"Currency"},"Value":0,"Term":"Term","URL":"URL","OfferType":{}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Offers","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Offer":{"type":"array","items":{"type":"object","properties":{"Term":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"StartDateTime":{"type":"string"},"URL":{"type":"string"},"EndDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"OfferType":{"type":"object","properties":{}},"Value":{"type":"integer"},"Fee":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"OfferId":{"type":"string"},"Description":{"type":"string"},"Rate":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/offers","connector_methods":[]},{"operation_id":"UKv3.1-getStandingOrders","implemented_by":{"version":"UKv3.1","function":"getStandingOrders"},"request_verb":"GET","request_url":"/open-banking/v3.1/standing-orders","summary":"Get Standing Orders","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"StandingOrder":[{"SupplementaryData":{},"CreditorAgent":{"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification"},"AccountId":{},"StandingOrderId":"StandingOrderId","Reference":"Reference","StandingOrderStatusCode":{},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"FirstPaymentAmount":{"Amount":{},"Currency":"Currency"},"FinalPaymentAmount":{"Amount":{},"Currency":"Currency"},"FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00","NextPaymentAmount":{"Amount":{},"Currency":"Currency"},"NextPaymentDateTime":"2000-01-23T04:56:07.000+00:00","Frequency":"Frequency","FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00"},{"SupplementaryData":{},"CreditorAgent":{"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification"},"AccountId":{},"StandingOrderId":"StandingOrderId","Reference":"Reference","StandingOrderStatusCode":{},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"FirstPaymentAmount":{"Amount":{},"Currency":"Currency"},"FinalPaymentAmount":{"Amount":{},"Currency":"Currency"},"FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00","NextPaymentAmount":{"Amount":{},"Currency":"Currency"},"NextPaymentDateTime":"2000-01-23T04:56:07.000+00:00","Frequency":"Frequency","FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Standing Orders","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StandingOrder":{"type":"array","items":{"type":"object","properties":{"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"FinalPaymentDateTime":{"type":"string"},"NextPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"FirstPaymentDateTime":{"type":"string"},"StandingOrderStatusCode":{"type":"object","properties":{}},"SupplementaryData":{"type":"object","properties":{}},"Frequency":{"type":"string"},"CreditorAgent":{"type":"object","properties":{"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"}}},"FinalPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"Reference":{"type":"string"},"NextPaymentDateTime":{"type":"string"},"StandingOrderId":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/standing-orders","connector_methods":[]},{"operation_id":"UKv3.1-createDomesticStandingOrderConsents","implemented_by":{"version":"UKv3.1","function":"createDomesticStandingOrderConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/domestic-standing-order-consents","summary":"Create Domestic Standing Order Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Risk":{"PaymentContextCode":{},"DeliveryAddress":{"StreetName":"StreetName","CountrySubDivision":["CountrySubDivision","CountrySubDivision"],"AddressLine":["AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","PostCode":"PostCode"},"MerchantCategoryCode":"MerchantCategoryCode","MerchantCustomerIdentification":"MerchantCustomerIdentification"},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Permission":{},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Reference":"Reference","RecurringPaymentDateTime":"2000-01-23T04:56:07.000+00:00","RecurringPaymentAmount":{"Currency":"Currency"},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Frequency":"Frequency","FirstPaymentAmount":{"Amount":{},"Currency":"Currency"},"FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00","FinalPaymentAmount":{"Currency":"Currency"},"NumberOfPayments":"NumberOfPayments","FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Standing Orders","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Permission":{"type":"object","properties":{}},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"RecurringPaymentDateTime":{"type":"string"},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Frequency":{"type":"string"},"RecurringPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"FinalPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"Reference":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-standing-order-consents","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deletetest_daniel707_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deletetest_daniel707_"},"request_verb":"DELETE","request_url":"/test_daniel707/TEST_DANIEL707_ID","summary":"Delete test_daniel707 by id","description":"

Delete test_daniel707 by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test_daniel707"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete test_daniel707 by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test_daniel707\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"test_daniel707":{"test_daniel707_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_Systemtest_daniel707","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/test_daniel707/TEST_DANIEL707_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createMytest_daniel707_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createMytest_daniel707_"},"request_verb":"POST","request_url":"/my/test_daniel707","summary":"Create new My test_daniel707","description":"

Create new My test_daniel707.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test_daniel707"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new My test_daniel707.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test_daniel707\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"test_daniel707":{"test_daniel707_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/my/test_daniel707","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createObpActivity_obp.testing.01","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createObpActivity_obp.testing.01"},"request_verb":"POST","request_url":"/banks/obp.testing.01/ObpActivity","summary":"Create new ObpActivity","description":"

Create new ObpActivity.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"ObpActivity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new ObpActivity.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* username: description of **name** field, can be markdown text.\n* created_date: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"ObpActivity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","username":"James Brown","created_date":"698761728"},"success_response_body":{"bank-id":"gh.29.uk","obp_activity":{"obp_activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","username":"James Brown","created_date":"698761728"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}}}},"roles":[{"role":"CanCreateDynamicEntity_ObpActivity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/obp.testing.01/ObpActivity","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getsustransList_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getsustransList_"},"request_verb":"GET","request_url":"/sustrans","summary":"Get sustrans List","description":"

Get sustrans List.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"sustrans"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /sustrans?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get sustrans List.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"sustrans\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /sustrans?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"sustrans_list":[{"sustrans_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"sustrans_list":{"type":"array","items":{"type":"object","properties":{"sustrans_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_Systemsustrans","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/sustrans","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deleteFishPort_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deleteFishPort_"},"request_verb":"DELETE","request_url":"/FishPort/FISH_PORT_ID","summary":"Delete FishPort by id","description":"

Delete FishPort by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"FishPort"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete FishPort by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"FishPort\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"fish":"James Brown","number":6987233228},"success_response_body":{"fish_port":{"fish_port_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","fish":"James Brown","number":6987233228}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_FishPort","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"fish":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string"},"fish":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_SystemFishPort","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/FishPort/FISH_PORT_ID","connector_methods":[]},{"operation_id":"UKv3.1-createInternationalPaymentConsents","implemented_by":{"version":"UKv3.1","function":"createInternationalPaymentConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/international-payment-consents","summary":"Create International Payment Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Risk":{"PaymentContextCode":{},"DeliveryAddress":{"StreetName":"StreetName","CountrySubDivision":["CountrySubDivision","CountrySubDivision"],"AddressLine":["AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","PostCode":"PostCode"},"MerchantCategoryCode":"MerchantCategoryCode","MerchantCustomerIdentification":"MerchantCustomerIdentification"},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","ExchangeRateInformation":{"ExchangeRate":0.8008281904610115,"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","RateType":{},"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CurrencyOfTransfer":"CurrencyOfTransfer","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Purpose":{},"ChargeBearer":{},"InstructionPriority":{},"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"ExchangeRateInformation":{"ExchangeRate":6.027456183070403,"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Creditor":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"Name":"Name"},"InstructedAmount":{"Currency":"Currency"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-payment-consents","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updateObpActivity_obp.testing.01","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updateObpActivity_obp.testing.01"},"request_verb":"PUT","request_url":"/banks/obp.testing.01/ObpActivity/OBP_ACTIVITY_ID","summary":"Update ObpActivity","description":"

Update ObpActivity.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"ObpActivity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update ObpActivity.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* username: description of **name** field, can be markdown text.\n* created_date: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"ObpActivity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","username":"James Brown","created_date":"698761728"},"success_response_body":{"bank-id":"gh.29.uk","obp_activity":{"obp_activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","username":"James Brown","created_date":"698761728"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_ObpActivity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/obp.testing.01/ObpActivity/OBP_ACTIVITY_ID","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdProduct","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdProduct"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/product","summary":"Get Products","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNTID: ACCOUNTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Products","Mocked-Data"],"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/product","connector_methods":[]},{"operation_id":"UKv3.1-createDomesticPaymentConsents","implemented_by":{"version":"UKv3.1","function":"createDomesticPaymentConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/domestic-payment-consents","summary":"Create Domestic Payment Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Risk":{"PaymentContextCode":{},"DeliveryAddress":{"StreetName":"StreetName","CountrySubDivision":["CountrySubDivision","CountrySubDivision"],"AddressLine":["AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","PostCode":"PostCode"},"MerchantCategoryCode":"MerchantCategoryCode","MerchantCustomerIdentification":"MerchantCustomerIdentification"},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"InstructedAmount":{"Currency":"Currency"},"CreditorPostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-payment-consents","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdTransactions","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdTransactions"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNT_ID/transactions","summary":"Get Transactions","description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

JSON response body fields:

\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":"2019-03-06T07:38:51.169Z","LastAvailableDateTime":"2019-03-06T07:38:51.169Z","TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Transaction":[{"Status":"string","SupplementaryData":{},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"AccountId":"string","TransactionReference":"TransactionReference","ProprietaryBankTransactionCode":{"Issuer":"Issuer","Code":"Code"},"AddressLine":"AddressLine","Amount":{"Amount":"string","Currency":"Currency"},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditDebitIndicator":"Credit","CurrencyExchange":{"SourceCurrency":"SourceCurrency","ExchangeRate":0.8008281904610115,"QuotationDate":"2000-01-23T04:56:07.000+00:00","UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification","InstructedAmount":{"Amount":"string","Currency":"Currency"},"TargetCurrency":"TargetCurrency"},"StatementReference":["StatementReference","StatementReference"],"ChargeAmount":{"Amount":"string","Currency":"Currency"},"TransactionId":"TransactionId","TransactionInformation":"string","BookingDateTime":"2000-01-23T04:56:07.000+00:00","BankTransactionCode":{"SubCode":"SubCode","Code":"Code"},"MerchantDetails":{"MerchantName":"MerchantName","MerchantCategoryCode":"MerchantCategoryCode"},"CardInstrument":{"AuthorisationType":"string","Identification":"Identification","CardSchemeName":"string","Name":"Name"},"ValueDateTime":"2000-01-23T04:56:07.000+00:00","DebtorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"Balance":{"Type":"string","Amount":{"Amount":"string","Currency":"Currency"},"CreditDebitIndicator":"Credit"}},{"Status":"string","SupplementaryData":{},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"AccountId":"string","TransactionReference":"TransactionReference","ProprietaryBankTransactionCode":{"Issuer":"Issuer","Code":"Code"},"AddressLine":"AddressLine","Amount":{"Amount":"string","Currency":"Currency"},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditDebitIndicator":"Credit","CurrencyExchange":{"SourceCurrency":"SourceCurrency","ExchangeRate":0.8008281904610115,"QuotationDate":"2000-01-23T04:56:07.000+00:00","UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification","InstructedAmount":{"Amount":"string","Currency":"Currency"},"TargetCurrency":"TargetCurrency"},"StatementReference":["StatementReference","StatementReference"],"ChargeAmount":{"Amount":"string","Currency":"Currency"},"TransactionId":"TransactionId","TransactionInformation":"string","BookingDateTime":"2000-01-23T04:56:07.000+00:00","BankTransactionCode":{"SubCode":"SubCode","Code":"Code"},"MerchantDetails":{"MerchantName":"MerchantName","MerchantCategoryCode":"MerchantCategoryCode"},"CardInstrument":{"AuthorisationType":"string","Identification":"Identification","CardSchemeName":"string","Name":"Name"},"ValueDateTime":"2000-01-23T04:56:07.000+00:00","DebtorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"Balance":{"Type":"string","Amount":{"Amount":"string","Currency":"Currency"},"CreditDebitIndicator":"Credit"}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Transactions"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"string"},"LastAvailableDateTime":{"type":"string"},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Transaction":{"type":"array","items":{"type":"object","properties":{"TransactionId":{"type":"string"},"StatementReference":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"MerchantDetails":{"type":"object","properties":{"MerchantName":{"type":"string"},"MerchantCategoryCode":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CurrencyExchange":{"type":"object","properties":{"QuotationDate":{"type":"string"},"SourceCurrency":{"type":"string"},"TargetCurrency":{"type":"string"},"ExchangeRate":{"type":"number"},"ContractIdentification":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"UnitCurrency":{"type":"string"}}},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"BankTransactionCode":{"type":"object","properties":{"SubCode":{"type":"string"},"Code":{"type":"string"}}},"Balance":{"type":"object","properties":{"Type":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}},"TransactionInformation":{"type":"string"},"DebtorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressType":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ProprietaryBankTransactionCode":{"type":"object","properties":{"Issuer":{"type":"string"},"Code":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressType":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ValueDateTime":{"type":"string"},"ChargeAmount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"TransactionReference":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"AccountId":{"type":"string"},"BookingDateTime":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"AddressLine":{"type":"string"},"CardInstrument":{"type":"object","properties":{"AuthorisationType":{"type":"string"},"Identification":{"type":"string"},"CardSchemeName":{"type":"string"},"Name":{"type":"string"}}},"Status":{"type":"string"},"CreditDebitIndicator":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNT_ID/transactions","connector_methods":[]},{"operation_id":"UKv3.1-getFilePaymentConsentsConsentIdFile","implemented_by":{"version":"UKv3.1","function":"getFilePaymentConsentsConsentIdFile"},"request_verb":"GET","request_url":"/open-banking/v3.1/file-payment-consents/CONSENTID/file","summary":"Get File Payment Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payment-consents/CONSENTID/file","connector_methods":[]},{"operation_id":"UKv3.1-createInternationalStandingOrderConsents","implemented_by":{"version":"UKv3.1","function":"createInternationalStandingOrderConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/international-standing-order-consents","summary":"Create International Standing Order Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Risk":{"PaymentContextCode":{},"DeliveryAddress":{"StreetName":"StreetName","CountrySubDivision":["CountrySubDivision","CountrySubDivision"],"AddressLine":["AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","PostCode":"PostCode"},"MerchantCategoryCode":"MerchantCategoryCode","MerchantCustomerIdentification":"MerchantCustomerIdentification"},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Permission":{},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"Reference":"Reference","CurrencyOfTransfer":"CurrencyOfTransfer","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Purpose":{},"ChargeBearer":{},"FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00","Frequency":"Frequency","FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00","NumberOfPayments":"NumberOfPayments","Creditor":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"Name":"Name"},"InstructedAmount":{"Currency":"Currency"}}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Standing Orders","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Permission":{"type":"object","properties":{}},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"Frequency":{"type":"string"},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"Reference":{"type":"string"}}},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-standing-order-consents","connector_methods":[]},{"operation_id":"OBPv4.0.0-test-dynamic-resource-doc","implemented_by":{"version":"OBPv4.0.0","function":"test-dynamic-resource-doc"},"request_verb":"POST","request_url":"/test-dynamic-resource-doc/my_user/MY_USER_ID","summary":"A test endpoint","description":"

A test endpoint.

\n

Just for debug method body of dynamic resource doc.
\nbetter watch the following introduction video first
\n* Dynamic resourceDoc version1

\n

The endpoint return the response from PractiseEndpoint code.
\nHere, code.api.DynamicEndpoints.dynamic.practise.PractiseEndpoint.process
\nYou can test the method body grammar, and try the business logic, but need to restart the OBP-API code .

\n

User Authentication is Optional. The User need not be logged in.

\n

URL Parameters:

\n

MY_USER_ID: MY_USER_ID

\n

JSON request body fields:

\n

age: 18

\n

hobby: hobby

\n

name: ACCOUNT_MANAGEMENT_FEE

\n

JSON response body fields:

\n

age: 18

\n

hobby: hobby

\n

name: ACCOUNT_MANAGEMENT_FEE

\n","description_markdown":"A test endpoint.\n\nJust for debug method body of dynamic resource doc.\nbetter watch the following introduction video first \n* [Dynamic resourceDoc version1](https://vimeo.com/623381607)\n\nThe endpoint return the response from PractiseEndpoint code.\nHere, code.api.DynamicEndpoints.dynamic.practise.PractiseEndpoint.process\nYou can test the method body grammar, and try the business logic, but need to restart the OBP-API code .\n\n\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[MY_USER_ID](/glossary#): MY_USER_ID\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**age**](/glossary#Age): 18\n\n\n\n[**hobby**](/glossary#): hobby\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**age**](/glossary#Age): 18\n\n\n\n[**hobby**](/glossary#): hobby\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n","example_request_body":{"name":"ACCOUNT_MANAGEMENT_FEE","age":18,"hobby":[]},"success_response_body":{"name":"ACCOUNT_MANAGEMENT_FEE","age":18,"hobby":[]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Dynamic-Resource-Doc"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"object","properties":{}},"age":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"object","properties":{}},"age":{"type":"integer"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-endpoint/test-dynamic-resource-doc/my_user/MY_USER_ID","connector_methods":[]},{"operation_id":"UKv3.1-getBeneficiaries","implemented_by":{"version":"UKv3.1","function":"getBeneficiaries"},"request_verb":"GET","request_url":"/open-banking/v3.1/beneficiaries","summary":"Get Beneficiaries","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Beneficiary":[{"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"AccountId":{},"Reference":"Reference","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"BeneficiaryId":"BeneficiaryId"},{"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"AccountId":{},"Reference":"Reference","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"BeneficiaryId":"BeneficiaryId"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Beneficiaries","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Beneficiary":{"type":"array","items":{"type":"object","properties":{"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"BeneficiaryId":{"type":"string"},"Reference":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/beneficiaries","connector_methods":[]},{"operation_id":"UKv3.1-createFundsConfirmationConsents","implemented_by":{"version":"UKv3.1","function":"createFundsConfirmationConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/funds-confirmation-consents","summary":"Create Funds Confirmation Consent","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","ConsentId":"ConsentId"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Funds Confirmations","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/funds-confirmation-consents","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createpass_3_probe_entity_ac.bank.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createpass_3_probe_entity_ac.bank.uk"},"request_verb":"POST","request_url":"/banks/ac.bank.uk/pass_3_probe_entity","summary":"Create new pass_3_probe_entity","description":"

Create new pass_3_probe_entity.

\n

Pass-3 probe entity

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"pass_3_probe_entity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new pass_3_probe_entity.\n\nPass-3 probe entity\n\n\n**Property List:** \n\n* name: Name\n* amount: Amount\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"pass_3_probe_entity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James","amount":100},"success_response_body":{"bank-id":"gh.29.uk","pass_3_probe_entity":{"pass_3_probe_entity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James","amount":100}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Pass_3_probe_entity(ac.bank.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"amount":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"pass_3_probe_entity":{"type":"object","properties":{"pass_3_probe_entity_id":{"type":"string"},"name":{"type":"string"},"amount":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_pass_3_probe_entity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/ac.bank.uk/pass_3_probe_entity","connector_methods":[]},{"operation_id":"UKv3.1-getProducts","implemented_by":{"version":"UKv3.1","function":"getProducts"},"request_verb":"GET","request_url":"/open-banking/v3.1/products","summary":"Get Products","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Products","Mocked-Data"],"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/products","connector_methods":[]},{"operation_id":"UKv3.1-getScheduledPayments","implemented_by":{"version":"UKv3.1","function":"getScheduledPayments"},"request_verb":"GET","request_url":"/open-banking/v3.1/scheduled-payments","summary":"Get Scheduled Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"ScheduledPayment":[{"CreditorAgent":{"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification"},"AccountId":{},"Reference":"Reference","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"ScheduledPaymentDateTime":"2000-01-23T04:56:07.000+00:00","InstructedAmount":{"Amount":{},"Currency":"Currency"},"ScheduledPaymentId":"ScheduledPaymentId","ScheduledType":{}},{"CreditorAgent":{"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification"},"AccountId":{},"Reference":"Reference","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"ScheduledPaymentDateTime":"2000-01-23T04:56:07.000+00:00","InstructedAmount":{"Amount":{},"Currency":"Currency"},"ScheduledPaymentId":"ScheduledPaymentId","ScheduledType":{}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Scheduled Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ScheduledPayment":{"type":"array","items":{"type":"object","properties":{"ScheduledType":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ScheduledPaymentId":{"type":"string"},"ScheduledPaymentDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"}}},"Reference":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/scheduled-payments","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updatetest_daniel707_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updatetest_daniel707_"},"request_verb":"PUT","request_url":"/test_daniel707/TEST_DANIEL707_ID","summary":"Update test_daniel707","description":"

Update test_daniel707.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test_daniel707"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update test_daniel707.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test_daniel707\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"test_daniel707":{"test_daniel707_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_Systemtest_daniel707","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/test_daniel707/TEST_DANIEL707_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingleInsurancePolicy_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingleInsurancePolicy_gh.29.uk"},"request_verb":"GET","request_url":"/banks/gh.29.uk/InsurancePolicy/INSURANCE_POLICY_ID","summary":"Get InsurancePolicy by id","description":"

Get InsurancePolicy by id.

\n

Which insurance policies the customer already has.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"InsurancePolicy"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get InsurancePolicy by id.\n\nWhich insurance policies the customer already has.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"InsurancePolicy\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"bank-id":"gh.29.uk","insurance_policy":{"insurance_policy_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_InsurancePolicy","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/InsurancePolicy/INSURANCE_POLICY_ID","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalPaymentsInternationalPaymentId","implemented_by":{"version":"UKv3.1","function":"getInternationalPaymentsInternationalPaymentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-payments/INTERNATIONALPAYMENTID","summary":"Get International Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

INTERNATIONALPAYMENTID: INTERNATIONALPAYMENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[INTERNATIONALPAYMENTID](/glossary#): INTERNATIONALPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","ExchangeRateInformation":{"ExchangeRate":0.8008281904610115,"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","RateType":{},"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"InternationalPaymentId":"InternationalPaymentId","ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CurrencyOfTransfer":"CurrencyOfTransfer","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Purpose":{},"ChargeBearer":{},"InstructionPriority":{},"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"ExchangeRateInformation":{"ExchangeRate":6.027456183070403,"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Creditor":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"Name":"Name"},"InstructedAmount":{"Currency":"Currency"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00","MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"InternationalPaymentId":{"type":"string"},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-payments/INTERNATIONALPAYMENTID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deletecustomer_cars_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deletecustomer_cars_"},"request_verb":"DELETE","request_url":"/customer_cars/CUSTOMER_CARS_ID","summary":"Delete customer_cars by id","description":"

Delete customer_cars by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"customer_cars"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete customer_cars by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"customer_cars\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a","manufacturer":"BMW"},"success_response_body":{"customer_cars":{"customer_cars_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a","manufacturer":"BMW"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string"},"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_Systemcustomer_cars","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/customer_cars/CUSTOMER_CARS_ID","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalPaymentConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getInternationalPaymentConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-payment-consents/CONSENTID","summary":"Get International Payment Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Risk":{"PaymentContextCode":{},"DeliveryAddress":{"StreetName":"StreetName","CountrySubDivision":["CountrySubDivision","CountrySubDivision"],"AddressLine":["AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","PostCode":"PostCode"},"MerchantCategoryCode":"MerchantCategoryCode","MerchantCustomerIdentification":"MerchantCustomerIdentification"},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","ExchangeRateInformation":{"ExchangeRate":0.8008281904610115,"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","RateType":{},"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CurrencyOfTransfer":"CurrencyOfTransfer","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Purpose":{},"ChargeBearer":{},"InstructionPriority":{},"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"ExchangeRateInformation":{"ExchangeRate":6.027456183070403,"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Creditor":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"Name":"Name"},"InstructedAmount":{"Currency":"Currency"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-payment-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticScheduledPaymentConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getDomesticScheduledPaymentConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-scheduled-payment-consents/CONSENTID","summary":"Get Domestic Scheduled Payment Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Risk":{"PaymentContextCode":{},"DeliveryAddress":{"StreetName":"StreetName","CountrySubDivision":["CountrySubDivision","CountrySubDivision"],"AddressLine":["AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","PostCode":"PostCode"},"MerchantCategoryCode":"MerchantCategoryCode","MerchantCustomerIdentification":"MerchantCustomerIdentification"},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Permission":{},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","InstructedAmount":{"Currency":"Currency"},"CreditorPostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Scheduled Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Permission":{"type":"object","properties":{}},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-scheduled-payment-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-createDomesticStandingOrders","implemented_by":{"version":"UKv3.1","function":"createDomesticStandingOrders"},"request_verb":"POST","request_url":"/open-banking/v3.1/domestic-standing-orders","summary":"Create Domestic Standing Orders","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"DomesticStandingOrderId":"DomesticStandingOrderId","ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Reference":"Reference","RecurringPaymentDateTime":"2000-01-23T04:56:07.000+00:00","RecurringPaymentAmount":{"Currency":"Currency"},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Frequency":"Frequency","FirstPaymentAmount":{"Amount":{},"Currency":"Currency"},"FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00","FinalPaymentAmount":{"Currency":"Currency"},"NumberOfPayments":"NumberOfPayments","FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00"},"MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Standing Orders","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"RecurringPaymentDateTime":{"type":"string"},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Frequency":{"type":"string"},"RecurringPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"FinalPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"Reference":{"type":"string"}}},"DomesticStandingOrderId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-standing-orders","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticStandingOrderConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getDomesticStandingOrderConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-standing-order-consents/CONSENTID","summary":"Get Domestic Standing Order Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Risk":{"PaymentContextCode":{},"DeliveryAddress":{"StreetName":"StreetName","CountrySubDivision":["CountrySubDivision","CountrySubDivision"],"AddressLine":["AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","PostCode":"PostCode"},"MerchantCategoryCode":"MerchantCategoryCode","MerchantCustomerIdentification":"MerchantCustomerIdentification"},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Permission":{},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Reference":"Reference","RecurringPaymentDateTime":"2000-01-23T04:56:07.000+00:00","RecurringPaymentAmount":{"Currency":"Currency"},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Frequency":"Frequency","FirstPaymentAmount":{"Amount":{},"Currency":"Currency"},"FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00","FinalPaymentAmount":{"Currency":"Currency"},"NumberOfPayments":"NumberOfPayments","FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Standing Orders","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Permission":{"type":"object","properties":{}},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"RecurringPaymentDateTime":{"type":"string"},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Frequency":{"type":"string"},"RecurringPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"FinalPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"Reference":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-standing-order-consents/CONSENTID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getpass_3_probe_entityList_ac.bank.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getpass_3_probe_entityList_ac.bank.uk"},"request_verb":"GET","request_url":"/banks/ac.bank.uk/pass_3_probe_entity","summary":"Get pass_3_probe_entity List","description":"

Get pass_3_probe_entity List.

\n

Pass-3 probe entity

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"pass_3_probe_entity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /pass_3_probe_entity?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get pass_3_probe_entity List.\n\nPass-3 probe entity\n\n\n**Property List:** \n\n* name: Name\n* amount: Amount\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"pass_3_probe_entity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /pass_3_probe_entity?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"bank-id":"gh.29.uk","pass_3_probe_entity_list":[{"pass_3_probe_entity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James","amount":100}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_Pass_3_probe_entity(ac.bank.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"pass_3_probe_entity_list":{"type":"array","items":{"type":"object","properties":{"pass_3_probe_entity_id":{"type":"string"},"name":{"type":"string"},"amount":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_pass_3_probe_entity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/ac.bank.uk/pass_3_probe_entity","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getCovidAPIDaysList_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getCovidAPIDaysList_"},"request_verb":"GET","request_url":"/CovidAPIDays","summary":"Get CovidAPIDays List","description":"

Get CovidAPIDays List.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"CovidAPIDays"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /CovidAPIDays?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get CovidAPIDays List.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"CovidAPIDays\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /CovidAPIDays?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"covid_api_days_list":[{"covid_api_days_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"covid_api_days_list":{"type":"array","items":{"type":"object","properties":{"covid_api_days_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_SystemCovidAPIDays","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/CovidAPIDays","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updateInsurancePolicy_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updateInsurancePolicy_gh.29.uk"},"request_verb":"PUT","request_url":"/banks/gh.29.uk/InsurancePolicy/INSURANCE_POLICY_ID","summary":"Update InsurancePolicy","description":"

Update InsurancePolicy.

\n

Which insurance policies the customer already has.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"InsurancePolicy"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update InsurancePolicy.\n\nWhich insurance policies the customer already has.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"InsurancePolicy\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","insurance_policy":{"insurance_policy_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_InsurancePolicy","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/InsurancePolicy/INSURANCE_POLICY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getcustomer_carsList_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getcustomer_carsList_"},"request_verb":"GET","request_url":"/customer_cars","summary":"Get customer_cars List","description":"

Get customer_cars List.

\n

The car the customer arrived in

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"customer_cars"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /customer_cars?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get customer_cars List.\n\nThe car the customer arrived in\n\n\n**Property List:** \n\n* customer_identifier: description of **customer_identifier** field, can be markdown text.\n* manufacturer: description of **manufacturer** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"customer_cars\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /customer_cars?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"customer_cars_list":[{"customer_cars_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a","manufacturer":"BMW"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"customer_cars_list":{"type":"array","items":{"type":"object","properties":{"customer_cars_id":{"type":"string"},"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}}}}},"roles":[{"role":"CanGetDynamicEntity_Systemcustomer_cars","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/customer_cars","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getFishPortList_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getFishPortList_"},"request_verb":"GET","request_url":"/FishPort","summary":"Get FishPort List","description":"

Get FishPort List.

\n

Portfolio of fishbased values

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"FishPort"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /FishPort?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get FishPort List.\n\nPortfolio of fishbased values\n\n\n**Property List:** \n\n* fish: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"FishPort\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /FishPort?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"fish_port_list":[{"fish_port_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","fish":"James Brown","number":6987233228}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_FishPort","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"fish_port_list":{"type":"array","items":{"type":"object","properties":{"fish_port_id":{"type":"string"},"fish":{"type":"string"},"number":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_SystemFishPort","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/FishPort","connector_methods":[]},{"operation_id":"UKv3.1-getFundsConfirmationConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getFundsConfirmationConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/funds-confirmation-consents/CONSENTID","summary":"Get Funds Confirmation Consent","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","ConsentId":"ConsentId"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Funds Confirmations","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/funds-confirmation-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdBalances","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdBalances"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNT_ID/balances","summary":"Get Balances","description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

JSON response body fields:

\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Balance":[{"Type":{},"AccountId":{},"CreditLine":[{"Type":{},"Included":true,"Amount":{"Amount":{},"Currency":"Currency"}},{"Type":{},"Included":true,"Amount":{"Amount":{},"Currency":"Currency"}}],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit","DateTime":"2000-01-23T04:56:07.000+00:00"},{"Type":{},"AccountId":{},"CreditLine":[{"Type":{},"Included":true,"Amount":{"Amount":{},"Currency":"Currency"}},{"Type":{},"Included":true,"Amount":{"Amount":{},"Currency":"Currency"}}],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit","DateTime":"2000-01-23T04:56:07.000+00:00"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Balances"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Balance":{"type":"array","items":{"type":"object","properties":{"CreditLine":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"object","properties":{}},"Included":{"type":"boolean"},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"Type":{"type":"object","properties":{}},"DateTime":{"type":"string"},"CreditDebitIndicator":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNT_ID/balances","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createInsurancePolicy_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createInsurancePolicy_gh.29.uk"},"request_verb":"POST","request_url":"/banks/gh.29.uk/InsurancePolicy","summary":"Create new InsurancePolicy","description":"

Create new InsurancePolicy.

\n

Which insurance policies the customer already has.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"InsurancePolicy"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new InsurancePolicy.\n\nWhich insurance policies the customer already has.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"InsurancePolicy\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","insurance_policy":{"insurance_policy_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_InsurancePolicy","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/InsurancePolicy","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingleCovidAPIDays_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingleCovidAPIDays_"},"request_verb":"GET","request_url":"/CovidAPIDays/COVID_API_DAYS_ID","summary":"Get CovidAPIDays by id","description":"

Get CovidAPIDays by id.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"CovidAPIDays"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get CovidAPIDays by id.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"CovidAPIDays\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"covid_api_days":{"covid_api_days_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_SystemCovidAPIDays","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/CovidAPIDays/COVID_API_DAYS_ID","connector_methods":[]},{"operation_id":"UKv3.1-createInternationalScheduledPaymentConsents","implemented_by":{"version":"UKv3.1","function":"createInternationalScheduledPaymentConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/international-scheduled-payment-consents","summary":"Create International Scheduled Payment Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Risk":{"PaymentContextCode":{},"DeliveryAddress":{"StreetName":"StreetName","CountrySubDivision":["CountrySubDivision","CountrySubDivision"],"AddressLine":["AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","PostCode":"PostCode"},"MerchantCategoryCode":"MerchantCategoryCode","MerchantCustomerIdentification":"MerchantCustomerIdentification"},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","ExchangeRateInformation":{"ExchangeRate":0.8008281904610115,"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","RateType":{},"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Permission":{},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CurrencyOfTransfer":"CurrencyOfTransfer","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Purpose":{},"ChargeBearer":{},"InstructionPriority":{},"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"ExchangeRateInformation":{"ExchangeRate":6.027456183070403,"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Creditor":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"Name":"Name"},"InstructedAmount":{"Currency":"Currency"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Scheduled Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"Permission":{"type":"object","properties":{}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-scheduled-payment-consents","connector_methods":[]},{"operation_id":"UKv3.1-deleteAccountAccessConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"deleteAccountAccessConsentsConsentId"},"request_verb":"DELETE","request_url":"/open-banking/v3.1/account-access-consents/CONSENT_ID","summary":"Delete Account Access Consents","description":"

Delete Account Access Consents

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947

\n

JSON response body fields:

\n","description_markdown":"Delete Account Access Consents\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENT_ID](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Access"],"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/account-access-consents/CONSENT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deleteD-Entity1_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deleteD-Entity1_gh.29.uk"},"request_verb":"DELETE","request_url":"/banks/gh.29.uk/D-Entity1/D-ENTITY1_ID","summary":"Delete D-Entity1 by id","description":"

Delete D-Entity1 by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"D-Entity1"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete D-Entity1 by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"D-Entity1\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","d-entity1":{"d-entity1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_D-Entity1","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/D-Entity1/D-ENTITY1_ID","connector_methods":[]},{"operation_id":"UKv3.1-createInternationalPayments","implemented_by":{"version":"UKv3.1","function":"createInternationalPayments"},"request_verb":"POST","request_url":"/open-banking/v3.1/international-payments","summary":"Create International Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","ExchangeRateInformation":{"ExchangeRate":0.8008281904610115,"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","RateType":{},"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"InternationalPaymentId":"InternationalPaymentId","ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CurrencyOfTransfer":"CurrencyOfTransfer","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Purpose":{},"ChargeBearer":{},"InstructionPriority":{},"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"ExchangeRateInformation":{"ExchangeRate":6.027456183070403,"UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification"},"Creditor":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"Name":"Name"},"InstructedAmount":{"Currency":"Currency"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00","MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"InternationalPaymentId":{"type":"string"},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-payments","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updateCovidAPIDays_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updateCovidAPIDays_"},"request_verb":"PUT","request_url":"/CovidAPIDays/COVID_API_DAYS_ID","summary":"Update CovidAPIDays","description":"

Update CovidAPIDays.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"CovidAPIDays"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update CovidAPIDays.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"CovidAPIDays\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"covid_api_days":{"covid_api_days_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_SystemCovidAPIDays","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/CovidAPIDays/COVID_API_DAYS_ID","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalStandingOrderConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getInternationalStandingOrderConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-standing-order-consents/CONSENTID","summary":"Get International Standing Order Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Risk":{"PaymentContextCode":{},"DeliveryAddress":{"StreetName":"StreetName","CountrySubDivision":["CountrySubDivision","CountrySubDivision"],"AddressLine":["AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","PostCode":"PostCode"},"MerchantCategoryCode":"MerchantCategoryCode","MerchantCustomerIdentification":"MerchantCustomerIdentification"},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Permission":{},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"Reference":"Reference","CurrencyOfTransfer":"CurrencyOfTransfer","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Purpose":{},"ChargeBearer":{},"FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00","Frequency":"Frequency","FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00","NumberOfPayments":"NumberOfPayments","Creditor":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"},"Name":"Name"},"InstructedAmount":{"Currency":"Currency"}}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Standing Orders","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Permission":{"type":"object","properties":{}},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"Frequency":{"type":"string"},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"Reference":{"type":"string"}}},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-standing-order-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticPaymentsDomesticPaymentId","implemented_by":{"version":"UKv3.1","function":"getDomesticPaymentsDomesticPaymentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-payments/DOMESTICPAYMENTID","summary":"Get Domestic Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

DOMESTICPAYMENTID: DOMESTICPAYMENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[DOMESTICPAYMENTID](/glossary#): DOMESTICPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"DomesticPaymentId":"DomesticPaymentId","Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"InstructedAmount":{"Currency":"Currency"},"CreditorPostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00","MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}},"Status":{"type":"object","properties":{}},"DomesticPaymentId":{"type":"string"},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-payments/DOMESTICPAYMENTID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getD-Entity1List_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getD-Entity1List_gh.29.uk"},"request_verb":"GET","request_url":"/banks/gh.29.uk/D-Entity1","summary":"Get D-Entity1 List","description":"

Get D-Entity1 List.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"D-Entity1"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /D-Entity1?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get D-Entity1 List.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"D-Entity1\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /D-Entity1?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"bank-id":"gh.29.uk","d-entity1_list":[{"d-entity1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"d-entity1_list":{"type":"array","items":{"type":"object","properties":{"d-entity1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_D-Entity1","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/D-Entity1","connector_methods":[]},{"operation_id":"UKv3.1-getFilePaymentConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getFilePaymentConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/file-payment-consents/CONSENTID","summary":"Get File Payment Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"ControlSum":0.8008281904610115,"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"FileType":["UK.OBIE.PaymentInitiation.3.1","UK.OBIE.pain.001.001.08"],"FileHash":"FileHash","NumberOfTransactions":"NumberOfTransactions","FileReference":"FileReference","RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"RequestedExecutionDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfTransactions":{"type":"string"},"ControlSum":{"type":"number"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"FileHash":{"type":"string"},"FileReference":{"type":"string"},"FileType":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payment-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-createFundsConfirmations","implemented_by":{"version":"UKv3.1","function":"createFundsConfirmations"},"request_verb":"POST","request_url":"/open-banking/v3.1/funds-confirmations","summary":"Create Funds Confirmation","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"FundsConfirmationId":"FundsConfirmationId","CreationDateTime":"2000-01-23T04:56:07.000+00:00","Reference":"Reference","FundsAvailable":true,"ConsentId":"ConsentId","InstructedAmount":{"Amount":{},"Currency":"Currency"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Funds Confirmations","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"FundsAvailable":{"type":"boolean"},"FundsConfirmationId":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"Reference":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/funds-confirmations","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createcustomer_cars_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createcustomer_cars_"},"request_verb":"POST","request_url":"/customer_cars","summary":"Create new customer_cars","description":"

Create new customer_cars.

\n

The car the customer arrived in

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"customer_cars"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new customer_cars.\n\nThe car the customer arrived in\n\n\n**Property List:** \n\n* customer_identifier: description of **customer_identifier** field, can be markdown text.\n* manufacturer: description of **manufacturer** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"customer_cars\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a","manufacturer":"BMW"},"success_response_body":{"customer_cars":{"customer_cars_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a","manufacturer":"BMW"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string"},"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}}}},"roles":[{"role":"CanCreateDynamicEntity_Systemcustomer_cars","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/customer_cars","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingleMarchHare_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingleMarchHare_gh.29.uk"},"request_verb":"GET","request_url":"/banks/gh.29.uk/MarchHare/MARCH_HARE_ID","summary":"Get MarchHare by id","description":"

Get MarchHare by id.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"MarchHare"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get MarchHare by id.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"MarchHare\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"bank-id":"gh.29.uk","march_hare":{"march_hare_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_MarchHare","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/MarchHare/MARCH_HARE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deleteCovidAPIDays_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deleteCovidAPIDays_"},"request_verb":"DELETE","request_url":"/CovidAPIDays/COVID_API_DAYS_ID","summary":"Delete CovidAPIDays by id","description":"

Delete CovidAPIDays by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"CovidAPIDays"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete CovidAPIDays by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"CovidAPIDays\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"covid_api_days":{"covid_api_days_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_SystemCovidAPIDays","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/CovidAPIDays/COVID_API_DAYS_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createMypass_3_probe_entity_ac.bank.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createMypass_3_probe_entity_ac.bank.uk"},"request_verb":"POST","request_url":"/banks/ac.bank.uk/my/pass_3_probe_entity","summary":"Create new My pass_3_probe_entity","description":"

Create new My pass_3_probe_entity.

\n

Pass-3 probe entity

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"pass_3_probe_entity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new My pass_3_probe_entity.\n\nPass-3 probe entity\n\n\n**Property List:** \n\n* name: Name\n* amount: Amount\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"pass_3_probe_entity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James","amount":100},"success_response_body":{"bank-id":"gh.29.uk","pass_3_probe_entity":{"pass_3_probe_entity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James","amount":100}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Pass_3_probe_entity(ac.bank.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"amount":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"pass_3_probe_entity":{"type":"object","properties":{"pass_3_probe_entity_id":{"type":"string"},"name":{"type":"string"},"amount":{"type":"integer"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/ac.bank.uk/my/pass_3_probe_entity","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updateMytest_daniel707_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updateMytest_daniel707_"},"request_verb":"PUT","request_url":"/my/test_daniel707/TEST_DANIEL707_ID","summary":"Update My test_daniel707","description":"

Update My test_daniel707.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test_daniel707"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update My test_daniel707.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test_daniel707\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"test_daniel707":{"test_daniel707_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_Systemtest_daniel707","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/my/test_daniel707/TEST_DANIEL707_ID","connector_methods":[]},{"operation_id":"UKv3.1-getAccountAccessConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getAccountAccessConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/account-access-consents/CONSENT_ID","summary":"Get Account Access Consents","description":"

Get Account Access Consents

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947

\n

JSON response body fields:

\n","description_markdown":"Get Account Access Consents\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENT_ID](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Data":{"ConsentId":"string","CreationDateTime":"2020-10-20T10:28:39.801Z","Status":"Authorised","StatusUpdateDateTime":"2020-10-20T10:28:39.801Z","Permissions":["ReadAccountsBasic"],"ExpirationDateTime":"2020-10-20T10:28:39.801Z","TransactionFromDateTime":"2020-10-20T10:28:39.801Z","TransactionToDateTime":"2020-10-20T10:28:39.801Z"},"Risk":"","Links":{"Self":"https://apisandbox.openbankproject.com/open-banking/v3.1/account-access-consents/CONSENT_ID"},"Meta":{"TotalPages":0,"FirstAvailableDateTime":"2020-10-20T10:28:39.801Z","LastAvailableDateTime":"2020-10-20T10:28:39.801Z"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Access"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Data":{"type":"object","properties":{"TransactionFromDateTime":{"type":"string"},"ConsentId":{"type":"string"},"ExpirationDateTime":{"type":"string"},"Status":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"Permissions":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"CreationDateTime":{"type":"string"},"TransactionToDateTime":{"type":"string"}}},"Risk":{"type":"string"},"Links":{"type":"object","properties":{"Self":{"type":"string"}}},"Meta":{"type":"object","properties":{"TotalPages":{"type":"integer"},"FirstAvailableDateTime":{"type":"string"},"LastAvailableDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/account-access-consents/CONSENT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_gettest_daniel707List_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_gettest_daniel707List_"},"request_verb":"GET","request_url":"/test_daniel707","summary":"Get test_daniel707 List","description":"

Get test_daniel707 List.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test_daniel707"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /test_daniel707?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get test_daniel707 List.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test_daniel707\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /test_daniel707?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"test_daniel707_list":[{"test_daniel707_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"test_daniel707_list":{"type":"array","items":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_Systemtest_daniel707","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/test_daniel707","connector_methods":[]},{"operation_id":"UKv3.1-getBalances","implemented_by":{"version":"UKv3.1","function":"getBalances"},"request_verb":"GET","request_url":"/open-banking/v3.1/balances","summary":"Get Balances","description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON response body fields:

\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Balance":[{"Type":{},"AccountId":{},"CreditLine":[{"Type":{},"Included":true,"Amount":{"Amount":{},"Currency":"Currency"}},{"Type":{},"Included":true,"Amount":{"Amount":{},"Currency":"Currency"}}],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit","DateTime":"2000-01-23T04:56:07.000+00:00"},{"Type":{},"AccountId":{},"CreditLine":[{"Type":{},"Included":true,"Amount":{"Amount":{},"Currency":"Currency"}},{"Type":{},"Included":true,"Amount":{"Amount":{},"Currency":"Currency"}}],"Amount":{"Amount":{},"Currency":"Currency"},"CreditDebitIndicator":"Credit","DateTime":"2000-01-23T04:56:07.000+00:00"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Balances"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Balance":{"type":"array","items":{"type":"object","properties":{"CreditLine":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"object","properties":{}},"Included":{"type":"boolean"},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"Type":{"type":"object","properties":{}},"DateTime":{"type":"string"},"CreditDebitIndicator":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/balances","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdParty","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdParty"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/party","summary":"Get Party","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNTID: ACCOUNTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Party":{"PartyNumber":"PartyNumber","PartyId":"PartyId","Address":[{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","AddressType":{},"PostCode":"PostCode"},{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","AddressType":{},"PostCode":"PostCode"}],"Phone":"Phone","Mobile":"Mobile","PartyType":{},"EmailAddress":"EmailAddress","Name":"Name"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Partys","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Party":{"type":"object","properties":{"EmailAddress":{"type":"string"},"PartyType":{"type":"object","properties":{}},"Name":{"type":"string"},"Mobile":{"type":"string"},"Address":{"type":"array","items":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"PostCode":{"type":"string"}}}},"PartyId":{"type":"string"},"Phone":{"type":"string"},"PartyNumber":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/party","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountId","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountId"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNT_ID","summary":"Get Accounts","description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

JSON response body fields:

\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":"2019-03-05T13:09:30.399Z","LastAvailableDateTime":"2019-03-05T13:09:30.399Z","TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Account":[{"Account":[{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"}],"Servicer":{"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification"},"AccountId":"String","Description":"Description","Currency":"Currency","AccountType":"String","AccountSubType":"String","Nickname":"Nickname"},{"Account":[{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"}],"Servicer":{"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification"},"AccountId":"String","Description":"Description","Currency":"Currency","AccountType":"String","AccountSubType":"String","Nickname":"Nickname"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Accounts"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"string"},"LastAvailableDateTime":{"type":"string"},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Account":{"type":"array","items":{"type":"object","properties":{"AccountType":{"type":"string"},"Nickname":{"type":"string"},"AccountSubType":{"type":"string"},"Servicer":{"type":"object","properties":{"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"}}},"Currency":{"type":"string"},"Account":{"type":"array","items":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}}},"Description":{"type":"string"},"AccountId":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNT_ID","connector_methods":[]},{"operation_id":"UKv3.1-getAccounts","implemented_by":{"version":"UKv3.1","function":"getAccounts"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts","summary":"Get Accounts","description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON response body fields:

\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Account":[{"Account":[{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"}],"Servicer":{"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification"},"AccountId":"String","Description":"Description","Currency":"Currency","AccountType":"String","AccountSubType":"String","Nickname":"Nickname"},{"Account":[{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"}],"Servicer":{"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification"},"AccountId":"String","Description":"Description","Currency":"Currency","AccountType":"String","AccountSubType":"String","Nickname":"Nickname"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Accounts"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Account":{"type":"array","items":{"type":"object","properties":{"AccountType":{"type":"string"},"Nickname":{"type":"string"},"AccountSubType":{"type":"string"},"Servicer":{"type":"object","properties":{"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"}}},"Currency":{"type":"string"},"Account":{"type":"array","items":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}}},"Description":{"type":"string"},"AccountId":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingleMytest_daniel707_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingleMytest_daniel707_"},"request_verb":"GET","request_url":"/my/test_daniel707/TEST_DANIEL707_ID","summary":"Get My test_daniel707 by id","description":"

Get My test_daniel707 by id.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test_daniel707"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get My test_daniel707 by id.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test_daniel707\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"test_daniel707":{"test_daniel707_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/my/test_daniel707/TEST_DANIEL707_ID","connector_methods":[]},{"operation_id":"UKv3.1-getTransactions","implemented_by":{"version":"UKv3.1","function":"getTransactions"},"request_verb":"GET","request_url":"/open-banking/v3.1/transactions","summary":"Get Transactions","description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON response body fields:

\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":"2019-03-06T07:38:51.169Z","LastAvailableDateTime":"2019-03-06T07:38:51.169Z","TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Transaction":[{"Status":"string","SupplementaryData":{},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"AccountId":"string","TransactionReference":"TransactionReference","ProprietaryBankTransactionCode":{"Issuer":"Issuer","Code":"Code"},"AddressLine":"AddressLine","Amount":{"Amount":"string","Currency":"Currency"},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditDebitIndicator":"Credit","CurrencyExchange":{"SourceCurrency":"SourceCurrency","ExchangeRate":0.8008281904610115,"QuotationDate":"2000-01-23T04:56:07.000+00:00","UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification","InstructedAmount":{"Amount":"string","Currency":"Currency"},"TargetCurrency":"TargetCurrency"},"StatementReference":["StatementReference","StatementReference"],"ChargeAmount":{"Amount":"string","Currency":"Currency"},"TransactionId":"TransactionId","TransactionInformation":"string","BookingDateTime":"2000-01-23T04:56:07.000+00:00","BankTransactionCode":{"SubCode":"SubCode","Code":"Code"},"MerchantDetails":{"MerchantName":"MerchantName","MerchantCategoryCode":"MerchantCategoryCode"},"CardInstrument":{"AuthorisationType":"string","Identification":"Identification","CardSchemeName":"string","Name":"Name"},"ValueDateTime":"2000-01-23T04:56:07.000+00:00","DebtorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"Balance":{"Type":"string","Amount":{"Amount":"string","Currency":"Currency"},"CreditDebitIndicator":"Credit"}},{"Status":"string","SupplementaryData":{},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"AccountId":"string","TransactionReference":"TransactionReference","ProprietaryBankTransactionCode":{"Issuer":"Issuer","Code":"Code"},"AddressLine":"AddressLine","Amount":{"Amount":"string","Currency":"Currency"},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditDebitIndicator":"Credit","CurrencyExchange":{"SourceCurrency":"SourceCurrency","ExchangeRate":0.8008281904610115,"QuotationDate":"2000-01-23T04:56:07.000+00:00","UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification","InstructedAmount":{"Amount":"string","Currency":"Currency"},"TargetCurrency":"TargetCurrency"},"StatementReference":["StatementReference","StatementReference"],"ChargeAmount":{"Amount":"string","Currency":"Currency"},"TransactionId":"TransactionId","TransactionInformation":"string","BookingDateTime":"2000-01-23T04:56:07.000+00:00","BankTransactionCode":{"SubCode":"SubCode","Code":"Code"},"MerchantDetails":{"MerchantName":"MerchantName","MerchantCategoryCode":"MerchantCategoryCode"},"CardInstrument":{"AuthorisationType":"string","Identification":"Identification","CardSchemeName":"string","Name":"Name"},"ValueDateTime":"2000-01-23T04:56:07.000+00:00","DebtorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"Balance":{"Type":"string","Amount":{"Amount":"string","Currency":"Currency"},"CreditDebitIndicator":"Credit"}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Transactions"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"string"},"LastAvailableDateTime":{"type":"string"},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Transaction":{"type":"array","items":{"type":"object","properties":{"TransactionId":{"type":"string"},"StatementReference":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"MerchantDetails":{"type":"object","properties":{"MerchantName":{"type":"string"},"MerchantCategoryCode":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CurrencyExchange":{"type":"object","properties":{"QuotationDate":{"type":"string"},"SourceCurrency":{"type":"string"},"TargetCurrency":{"type":"string"},"ExchangeRate":{"type":"number"},"ContractIdentification":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"UnitCurrency":{"type":"string"}}},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"BankTransactionCode":{"type":"object","properties":{"SubCode":{"type":"string"},"Code":{"type":"string"}}},"Balance":{"type":"object","properties":{"Type":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}},"TransactionInformation":{"type":"string"},"DebtorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressType":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ProprietaryBankTransactionCode":{"type":"object","properties":{"Issuer":{"type":"string"},"Code":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressType":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ValueDateTime":{"type":"string"},"ChargeAmount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"TransactionReference":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"AccountId":{"type":"string"},"BookingDateTime":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"AddressLine":{"type":"string"},"CardInstrument":{"type":"object","properties":{"AuthorisationType":{"type":"string"},"Identification":{"type":"string"},"CardSchemeName":{"type":"string"},"Name":{"type":"string"}}},"Status":{"type":"string"},"CreditDebitIndicator":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/transactions","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdDirectDebits","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdDirectDebits"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/direct-debits","summary":"Get Direct Debits","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNTID: ACCOUNTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"DirectDebit":[{"PreviousPaymentDateTime":"2000-01-23T04:56:07.000+00:00","AccountId":{},"MandateIdentification":"MandateIdentification","DirectDebitStatusCode":{},"DirectDebitId":"DirectDebitId","PreviousPaymentAmount":{"Amount":{},"Currency":"Currency"},"Name":"Name"},{"PreviousPaymentDateTime":"2000-01-23T04:56:07.000+00:00","AccountId":{},"MandateIdentification":"MandateIdentification","DirectDebitStatusCode":{},"DirectDebitId":"DirectDebitId","PreviousPaymentAmount":{"Amount":{},"Currency":"Currency"},"Name":"Name"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Direct Debits","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"DirectDebit":{"type":"array","items":{"type":"object","properties":{"PreviousPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"Name":{"type":"string"},"DirectDebitStatusCode":{"type":"object","properties":{}},"AccountId":{"type":"object","properties":{}},"MandateIdentification":{"type":"string"},"DirectDebitId":{"type":"string"},"PreviousPaymentDateTime":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/direct-debits","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deleteMypass_3_probe_entity_ac.bank.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deleteMypass_3_probe_entity_ac.bank.uk"},"request_verb":"DELETE","request_url":"/banks/ac.bank.uk/my/pass_3_probe_entity/PASS_3_PROBE_ENTITY_ID","summary":"Delete My pass_3_probe_entity by id","description":"

Delete My pass_3_probe_entity by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"pass_3_probe_entity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete My pass_3_probe_entity by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"pass_3_probe_entity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James","amount":100},"success_response_body":{"bank-id":"gh.29.uk","pass_3_probe_entity":{"pass_3_probe_entity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James","amount":100}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["_Pass_3_probe_entity(ac.bank.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"amount":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"pass_3_probe_entity":{"type":"object","properties":{"pass_3_probe_entity_id":{"type":"string"},"name":{"type":"string"},"amount":{"type":"integer"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/ac.bank.uk/my/pass_3_probe_entity/PASS_3_PROBE_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updateFooBar_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updateFooBar_"},"request_verb":"PUT","request_url":"/FooBar/FOO_BAR_ID","summary":"Update FooBar","description":"

Update FooBar.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"FooBar"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update FooBar.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"FooBar\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"foo_bar":{"foo_bar_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_FooBar","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_SystemFooBar","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/FooBar/FOO_BAR_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingleFooBar_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingleFooBar_"},"request_verb":"GET","request_url":"/FooBar/FOO_BAR_ID","summary":"Get FooBar by id","description":"

Get FooBar by id.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"FooBar"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get FooBar by id.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"FooBar\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"foo_bar":{"foo_bar_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_FooBar","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_SystemFooBar","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/FooBar/FOO_BAR_ID","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticStandingOrdersDomesticStandingOrderId","implemented_by":{"version":"UKv3.1","function":"getDomesticStandingOrdersDomesticStandingOrderId"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-standing-orders/DOMESTICSTANDINGORDERID","summary":"Get Domestic Standing Orders","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

DOMESTICSTANDINGORDERID: DOMESTICSTANDINGORDERID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[DOMESTICSTANDINGORDERID](/glossary#): DOMESTICSTANDINGORDERID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"DomesticStandingOrderId":"DomesticStandingOrderId","ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Reference":"Reference","RecurringPaymentDateTime":"2000-01-23T04:56:07.000+00:00","RecurringPaymentAmount":{"Currency":"Currency"},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"Frequency":"Frequency","FirstPaymentAmount":{"Amount":{},"Currency":"Currency"},"FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00","FinalPaymentAmount":{"Currency":"Currency"},"NumberOfPayments":"NumberOfPayments","FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00"},"MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Standing Orders","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"RecurringPaymentDateTime":{"type":"string"},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Frequency":{"type":"string"},"RecurringPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"FinalPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"Reference":{"type":"string"}}},"DomesticStandingOrderId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-standing-orders/DOMESTICSTANDINGORDERID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingleObpActivity_obp.testing.01","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingleObpActivity_obp.testing.01"},"request_verb":"GET","request_url":"/banks/obp.testing.01/ObpActivity/OBP_ACTIVITY_ID","summary":"Get ObpActivity by id","description":"

Get ObpActivity by id.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"ObpActivity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get ObpActivity by id.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* username: description of **name** field, can be markdown text.\n* created_date: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"ObpActivity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"bank-id":"gh.29.uk","obp_activity":{"obp_activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","username":"James Brown","created_date":"698761728"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}}}},"roles":[{"role":"CanGetDynamicEntity_ObpActivity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/obp.testing.01/ObpActivity/OBP_ACTIVITY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updateInsurancePremium_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updateInsurancePremium_gh.29.uk"},"request_verb":"PUT","request_url":"/banks/gh.29.uk/InsurancePremium/INSURANCE_PREMIUM_ID","summary":"Update InsurancePremium","description":"

Update InsurancePremium.

\n

Retrive the premium for the customer.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"InsurancePremium"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update InsurancePremium.\n\nRetrive the premium for the customer.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"InsurancePremium\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","insurance_premium":{"insurance_premium_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_InsurancePremium","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/InsurancePremium/INSURANCE_PREMIUM_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createFishPort_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createFishPort_"},"request_verb":"POST","request_url":"/FishPort","summary":"Create new FishPort","description":"

Create new FishPort.

\n

Portfolio of fishbased values

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"FishPort"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new FishPort.\n\nPortfolio of fishbased values\n\n\n**Property List:** \n\n* fish: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"FishPort\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"fish":"James Brown","number":6987233228},"success_response_body":{"fish_port":{"fish_port_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","fish":"James Brown","number":6987233228}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_FishPort","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"fish":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string"},"fish":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_SystemFishPort","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/FishPort","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deleteSimonCovid_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deleteSimonCovid_"},"request_verb":"DELETE","request_url":"/SimonCovid/SIMON_COVID_ID","summary":"Delete SimonCovid by id","description":"

Delete SimonCovid by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"SimonCovid"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete SimonCovid by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"SimonCovid\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"simon_covid":{"simon_covid_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_SystemSimonCovid","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/SimonCovid/SIMON_COVID_ID","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation","implemented_by":{"version":"UKv3.1","function":"getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-scheduled-payment-consents/CONSENTID/funds-confirmation","summary":"Get International Scheduled Payment Consents Funds Confirmation","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

CONSENTID: CONSENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"SupplementaryData":{},"FundsAvailableResult":{"FundsAvailableDateTime":"2000-01-23T04:56:07.000+00:00","FundsAvailable":true}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Scheduled Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"SupplementaryData":{"type":"object","properties":{}},"FundsAvailableResult":{"type":"object","properties":{"FundsAvailableDateTime":{"type":"string"},"FundsAvailable":{"type":"boolean"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-scheduled-payment-consents/CONSENTID/funds-confirmation","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSinglesustrans_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSinglesustrans_"},"request_verb":"GET","request_url":"/sustrans/SUSTRANS_ID","summary":"Get sustrans by id","description":"

Get sustrans by id.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"sustrans"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get sustrans by id.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"sustrans\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"sustrans":{"sustrans_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_Systemsustrans","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/sustrans/SUSTRANS_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deleteInsurancePolicy_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deleteInsurancePolicy_gh.29.uk"},"request_verb":"DELETE","request_url":"/banks/gh.29.uk/InsurancePolicy/INSURANCE_POLICY_ID","summary":"Delete InsurancePolicy by id","description":"

Delete InsurancePolicy by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"InsurancePolicy"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete InsurancePolicy by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"InsurancePolicy\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","insurance_policy":{"insurance_policy_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_InsurancePolicy","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/InsurancePolicy/INSURANCE_POLICY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updateSimonCovid_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updateSimonCovid_"},"request_verb":"PUT","request_url":"/SimonCovid/SIMON_COVID_ID","summary":"Update SimonCovid","description":"

Update SimonCovid.

\n

Let's put Covid99 stuff here

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"SimonCovid"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update SimonCovid.\n\nLet's put Covid99 stuff here\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"SimonCovid\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"simon_covid":{"simon_covid_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_SystemSimonCovid","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/SimonCovid/SIMON_COVID_ID","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdStatementsStatementIdTransactions","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdStatementsStatementIdTransactions"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/transactions","summary":"Get Transactions","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNTID: ACCOUNTID

\n

STATEMENTID: STATEMENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n[STATEMENTID](/glossary#): STATEMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":"2019-03-06T07:38:51.169Z","LastAvailableDateTime":"2019-03-06T07:38:51.169Z","TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Transaction":[{"Status":"string","SupplementaryData":{},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"AccountId":"string","TransactionReference":"TransactionReference","ProprietaryBankTransactionCode":{"Issuer":"Issuer","Code":"Code"},"AddressLine":"AddressLine","Amount":{"Amount":"string","Currency":"Currency"},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditDebitIndicator":"Credit","CurrencyExchange":{"SourceCurrency":"SourceCurrency","ExchangeRate":0.8008281904610115,"QuotationDate":"2000-01-23T04:56:07.000+00:00","UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification","InstructedAmount":{"Amount":"string","Currency":"Currency"},"TargetCurrency":"TargetCurrency"},"StatementReference":["StatementReference","StatementReference"],"ChargeAmount":{"Amount":"string","Currency":"Currency"},"TransactionId":"TransactionId","TransactionInformation":"string","BookingDateTime":"2000-01-23T04:56:07.000+00:00","BankTransactionCode":{"SubCode":"SubCode","Code":"Code"},"MerchantDetails":{"MerchantName":"MerchantName","MerchantCategoryCode":"MerchantCategoryCode"},"CardInstrument":{"AuthorisationType":"string","Identification":"Identification","CardSchemeName":"string","Name":"Name"},"ValueDateTime":"2000-01-23T04:56:07.000+00:00","DebtorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"Balance":{"Type":"string","Amount":{"Amount":"string","Currency":"Currency"},"CreditDebitIndicator":"Credit"}},{"Status":"string","SupplementaryData":{},"CreditorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"AccountId":"string","TransactionReference":"TransactionReference","ProprietaryBankTransactionCode":{"Issuer":"Issuer","Code":"Code"},"AddressLine":"AddressLine","Amount":{"Amount":"string","Currency":"Currency"},"CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"CreditDebitIndicator":"Credit","CurrencyExchange":{"SourceCurrency":"SourceCurrency","ExchangeRate":0.8008281904610115,"QuotationDate":"2000-01-23T04:56:07.000+00:00","UnitCurrency":"UnitCurrency","ContractIdentification":"ContractIdentification","InstructedAmount":{"Amount":"string","Currency":"Currency"},"TargetCurrency":"TargetCurrency"},"StatementReference":["StatementReference","StatementReference"],"ChargeAmount":{"Amount":"string","Currency":"Currency"},"TransactionId":"TransactionId","TransactionInformation":"string","BookingDateTime":"2000-01-23T04:56:07.000+00:00","BankTransactionCode":{"SubCode":"SubCode","Code":"Code"},"MerchantDetails":{"MerchantName":"MerchantName","MerchantCategoryCode":"MerchantCategoryCode"},"CardInstrument":{"AuthorisationType":"string","Identification":"Identification","CardSchemeName":"string","Name":"Name"},"ValueDateTime":"2000-01-23T04:56:07.000+00:00","DebtorAgent":{"PostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":"string","PostCode":"PostCode"},"SchemeName":["UK.OBIE.BICFI"],"Identification":"Identification","Name":"Name"},"Balance":{"Type":"string","Amount":{"Amount":"string","Currency":"Currency"},"CreditDebitIndicator":"Credit"}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Statements","Transactions","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"string"},"LastAvailableDateTime":{"type":"string"},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Transaction":{"type":"array","items":{"type":"object","properties":{"TransactionId":{"type":"string"},"StatementReference":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"MerchantDetails":{"type":"object","properties":{"MerchantName":{"type":"string"},"MerchantCategoryCode":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CurrencyExchange":{"type":"object","properties":{"QuotationDate":{"type":"string"},"SourceCurrency":{"type":"string"},"TargetCurrency":{"type":"string"},"ExchangeRate":{"type":"number"},"ContractIdentification":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"UnitCurrency":{"type":"string"}}},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"BankTransactionCode":{"type":"object","properties":{"SubCode":{"type":"string"},"Code":{"type":"string"}}},"Balance":{"type":"object","properties":{"Type":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}},"TransactionInformation":{"type":"string"},"DebtorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressType":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ProprietaryBankTransactionCode":{"type":"object","properties":{"Issuer":{"type":"string"},"Code":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressType":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ValueDateTime":{"type":"string"},"ChargeAmount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"TransactionReference":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"AccountId":{"type":"string"},"BookingDateTime":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"AddressLine":{"type":"string"},"CardInstrument":{"type":"object","properties":{"AuthorisationType":{"type":"string"},"Identification":{"type":"string"},"CardSchemeName":{"type":"string"},"Name":{"type":"string"}}},"Status":{"type":"string"},"CreditDebitIndicator":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/transactions","connector_methods":[]},{"operation_id":"UKv3.1-getFilePaymentsFilePaymentId","implemented_by":{"version":"UKv3.1","function":"getFilePaymentsFilePaymentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/file-payments/FILEPAYMENTID","summary":"Get File Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

FILEPAYMENTID: FILEPAYMENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[FILEPAYMENTID](/glossary#): FILEPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","FilePaymentId":"FilePaymentId","Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"ControlSum":0.8008281904610115,"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"FileType":["UK.OBIE.PaymentInitiation.3.1","UK.OBIE.pain.001.001.08"],"FileHash":"FileHash","NumberOfTransactions":"NumberOfTransactions","FileReference":"FileReference","RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"},"MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"RequestedExecutionDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfTransactions":{"type":"string"},"ControlSum":{"type":"number"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"FileHash":{"type":"string"},"FileReference":{"type":"string"},"FileType":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"FilePaymentId":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payments/FILEPAYMENTID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createD-Entity1_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createD-Entity1_gh.29.uk"},"request_verb":"POST","request_url":"/banks/gh.29.uk/D-Entity1","summary":"Create new D-Entity1","description":"

Create new D-Entity1.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"D-Entity1"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new D-Entity1.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"D-Entity1\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","d-entity1":{"d-entity1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_D-Entity1","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/D-Entity1","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updatetest1_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updatetest1_"},"request_verb":"PUT","request_url":"/test1/TEST1_ID","summary":"Update test1","description":"

Update test1.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test1"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update test1.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test1\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"test1":{"test1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Test1","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_Systemtest1","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/test1/TEST1_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createSimonCovid_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createSimonCovid_"},"request_verb":"POST","request_url":"/SimonCovid","summary":"Create new SimonCovid","description":"

Create new SimonCovid.

\n

Let's put Covid99 stuff here

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"SimonCovid"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new SimonCovid.\n\nLet's put Covid99 stuff here\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"SimonCovid\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"simon_covid":{"simon_covid_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_SystemSimonCovid","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/SimonCovid","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSimonCovidList_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSimonCovidList_"},"request_verb":"GET","request_url":"/SimonCovid","summary":"Get SimonCovid List","description":"

Get SimonCovid List.

\n

Let's put Covid99 stuff here

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"SimonCovid"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /SimonCovid?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get SimonCovid List.\n\nLet's put Covid99 stuff here\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"SimonCovid\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /SimonCovid?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"simon_covid_list":[{"simon_covid_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"simon_covid_list":{"type":"array","items":{"type":"object","properties":{"simon_covid_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}},"roles":[{"role":"CanGetDynamicEntity_SystemSimonCovid","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/SimonCovid","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getSingleInsurancePremium_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getSingleInsurancePremium_gh.29.uk"},"request_verb":"GET","request_url":"/banks/gh.29.uk/InsurancePremium/INSURANCE_PREMIUM_ID","summary":"Get InsurancePremium by id","description":"

Get InsurancePremium by id.

\n

Retrive the premium for the customer.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"InsurancePremium"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get InsurancePremium by id.\n\nRetrive the premium for the customer.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"InsurancePremium\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"bank-id":"gh.29.uk","insurance_premium":{"insurance_premium_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanGetDynamicEntity_InsurancePremium","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/InsurancePremium/INSURANCE_PREMIUM_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEndpoint_GET_accounts_ACCOUNT_ID","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEndpoint_GET_accounts_ACCOUNT_ID"},"request_verb":"GET","request_url":"/accounts/ACCOUNT_ID","summary":"Get Bank Account By Id","description":"

Get Bank Account

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEndpointProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"url_pattern",\n        "value":"http://obp_mock//accounts/{account_id}"\n    },\n    {\n        "key":"http_method",\n        "value":"GET"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Get Bank Account\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEndpointProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"url_pattern\",\n \"value\":\"http://obp_mock//accounts/{account_id}\"\n },\n {\n \"key\":\"http_method\",\n \"value\":\"GET\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","success_response_body":{"name":"family account","balance":1},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Bank Accounts (Dynamic Endpoint)","Dynamic-Endpoint","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"balance":{"type":"integer"}}},"roles":[{"role":"CanGetDynamicEndpoint__account202","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-endpoint/accounts/ACCOUNT_ID","connector_methods":[]},{"operation_id":"UKv3.1-getOffers","implemented_by":{"version":"UKv3.1","function":"getOffers"},"request_verb":"GET","request_url":"/open-banking/v3.1/offers","summary":"Get Offers","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Offer":[{"OfferId":"OfferId","AccountId":{},"Description":"Description","StartDateTime":"2000-01-23T04:56:07.000+00:00","EndDateTime":"2000-01-23T04:56:07.000+00:00","Rate":"Rate","Amount":{"Amount":{},"Currency":"Currency"},"Fee":{"Amount":{},"Currency":"Currency"},"Value":0,"Term":"Term","URL":"URL","OfferType":{}},{"OfferId":"OfferId","AccountId":{},"Description":"Description","StartDateTime":"2000-01-23T04:56:07.000+00:00","EndDateTime":"2000-01-23T04:56:07.000+00:00","Rate":"Rate","Amount":{"Amount":{},"Currency":"Currency"},"Fee":{"Amount":{},"Currency":"Currency"},"Value":0,"Term":"Term","URL":"URL","OfferType":{}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Offers","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Offer":{"type":"array","items":{"type":"object","properties":{"Term":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"StartDateTime":{"type":"string"},"URL":{"type":"string"},"EndDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"OfferType":{"type":"object","properties":{}},"Value":{"type":"integer"},"Fee":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"OfferId":{"type":"string"},"Description":{"type":"string"},"Rate":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/offers","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deleteInsurancePremium_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deleteInsurancePremium_gh.29.uk"},"request_verb":"DELETE","request_url":"/banks/gh.29.uk/InsurancePremium/INSURANCE_PREMIUM_ID","summary":"Delete InsurancePremium by id","description":"

Delete InsurancePremium by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"InsurancePremium"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete InsurancePremium by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"InsurancePremium\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","insurance_premium":{"insurance_premium_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_InsurancePremium","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/InsurancePremium/INSURANCE_PREMIUM_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deleteOdometer_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deleteOdometer_gh.29.uk"},"request_verb":"DELETE","request_url":"/banks/gh.29.uk/Odometer/ODOMETER_ID","summary":"Delete Odometer by id","description":"

Delete Odometer by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"Odometer"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete Odometer by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"Odometer\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","odometer":{"odometer_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_Odometer","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/Odometer/ODOMETER_ID","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdStatementsStatementIdFile","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdStatementsStatementIdFile"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/file","summary":"Get Statements","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNTID: ACCOUNTID

\n

STATEMENTID: STATEMENTID

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n[STATEMENTID](/glossary#): STATEMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Statements","Mocked-Data"],"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/file","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createtest_daniel707_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createtest_daniel707_"},"request_verb":"POST","request_url":"/test_daniel707","summary":"Create new test_daniel707","description":"

Create new test_daniel707.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test_daniel707"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new test_daniel707.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test_daniel707\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"test_daniel707":{"test_daniel707_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_Systemtest_daniel707","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/test_daniel707","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_updatesustrans_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_updatesustrans_"},"request_verb":"PUT","request_url":"/sustrans/SUSTRANS_ID","summary":"Update sustrans","description":"

Update sustrans.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"sustrans"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Update sustrans.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"sustrans\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"sustrans":{"sustrans_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanUpdateDynamicEntity_Systemsustrans","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/sustrans/SUSTRANS_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_createMarchHare_gh.29.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_createMarchHare_gh.29.uk"},"request_verb":"POST","request_url":"/banks/gh.29.uk/MarchHare","summary":"Create new MarchHare","description":"

Create new MarchHare.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"MarchHare"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Create new MarchHare.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"MarchHare\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James Brown","number":698761728},"success_response_body":{"bank-id":"gh.29.uk","march_hare":{"march_hare_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}},"roles":[{"role":"CanCreateDynamicEntity_MarchHare","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/gh.29.uk/MarchHare","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_deletepass_3_probe_entity_ac.bank.uk","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_deletepass_3_probe_entity_ac.bank.uk"},"request_verb":"DELETE","request_url":"/banks/ac.bank.uk/pass_3_probe_entity/PASS_3_PROBE_ENTITY_ID","summary":"Delete pass_3_probe_entity by id","description":"

Delete pass_3_probe_entity by id

\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"pass_3_probe_entity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n","description_markdown":"Delete pass_3_probe_entity by id\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"pass_3_probe_entity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","example_request_body":{"name":"James","amount":100},"success_response_body":{"bank-id":"gh.29.uk","pass_3_probe_entity":{"pass_3_probe_entity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James","amount":100}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["_Pass_3_probe_entity(ac.bank.uk)","Dynamic-Entity","Dynamic"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"amount":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"pass_3_probe_entity":{"type":"object","properties":{"pass_3_probe_entity_id":{"type":"string"},"name":{"type":"string"},"amount":{"type":"integer"}}}}},"roles":[{"role":"CanDeleteDynamicEntity_pass_3_probe_entity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/ac.bank.uk/pass_3_probe_entity/PASS_3_PROBE_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getObpActivityList_obp.testing.01","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getObpActivityList_obp.testing.01"},"request_verb":"GET","request_url":"/banks/obp.testing.01/ObpActivity","summary":"Get ObpActivity List","description":"

Get ObpActivity List.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"ObpActivity"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /ObpActivity?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get ObpActivity List.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* username: description of **name** field, can be markdown text.\n* created_date: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"ObpActivity\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /ObpActivity?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"bank-id":"gh.29.uk","obp_activity_list":[{"obp_activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","username":"James Brown","created_date":"698761728"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"bank-id":{"type":"string"},"obp_activity_list":{"type":"array","items":{"type":"object","properties":{"obp_activity_id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}}}}},"roles":[{"role":"CanGetDynamicEntity_ObpActivity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/banks/obp.testing.01/ObpActivity","connector_methods":[]},{"operation_id":"UKv3.1-createFilePaymentConsents","implemented_by":{"version":"UKv3.1","function":"createFilePaymentConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/file-payment-consents","summary":"Create File Payment Consents","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","CutOffDateTime":"2000-01-23T04:56:07.000+00:00","Authorisation":{"CompletionDateTime":"2000-01-23T04:56:07.000+00:00","AuthorisationType":{}},"Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"ControlSum":0.8008281904610115,"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"FileType":["UK.OBIE.PaymentInitiation.3.1","UK.OBIE.pain.001.001.08"],"FileHash":"FileHash","NumberOfTransactions":"NumberOfTransactions","FileReference":"FileReference","RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"RequestedExecutionDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfTransactions":{"type":"string"},"ControlSum":{"type":"number"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"FileHash":{"type":"string"},"FileReference":{"type":"string"},"FileType":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payment-consents","connector_methods":[]},{"operation_id":"UKv3.1-createDomesticPayments","implemented_by":{"version":"UKv3.1","function":"createDomesticPayments"},"request_verb":"POST","request_url":"/open-banking/v3.1/domestic-payments","summary":"Create Domestic Payments","description":"

NOTE: This endpoint currently only returns example data.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

JSON response body fields:

\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"Meta":{"FirstAvailableDateTime":{},"TotalPages":0},"Links":{"Last":"http://example.com/aeiou","Prev":"http://example.com/aeiou","Next":"http://example.com/aeiou","Self":"http://example.com/aeiou","First":"http://example.com/aeiou"},"Data":{"DomesticPaymentId":"DomesticPaymentId","Status":{},"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00","CreationDateTime":"2000-01-23T04:56:07.000+00:00","ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00","Charges":[{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}},{"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],"Amount":{"Amount":{},"Currency":"Currency"},"ChargeBearer":{}}],"ConsentId":"ConsentId","Initiation":{"SupplementaryData":{},"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],"DebtorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"RemittanceInformation":{"Unstructured":"Unstructured","Reference":"Reference"},"EndToEndIdentification":"EndToEndIdentification","InstructionIdentification":"InstructionIdentification","CreditorAccount":{"SecondaryIdentification":"SecondaryIdentification","SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],"Identification":"Identification","Name":"Name"},"InstructedAmount":{"Currency":"Currency"},"CreditorPostalAddress":{"StreetName":"StreetName","CountrySubDivision":"CountrySubDivision","Department":"Department","AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],"BuildingNumber":"BuildingNumber","TownName":"TownName","Country":"Country","SubDepartment":"SubDepartment","AddressType":{},"PostCode":"PostCode"}},"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00","MultiAuthorisation":{"Status":{},"NumberReceived":6,"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00","ExpirationDateTime":"2000-01-23T04:56:07.000+00:00","NumberRequired":0}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Payments","Mocked-Data"],"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}},"Status":{"type":"object","properties":{}},"DomesticPaymentId":{"type":"string"},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-payments","connector_methods":[]},{"operation_id":"OBPv4.0.0-dynamicEntity_getMytest_daniel707List_","implemented_by":{"version":"OBPv4.0.0","function":"dynamicEntity_getMytest_daniel707List_"},"request_verb":"GET","request_url":"/my/test_daniel707","summary":"Get My test_daniel707 List","description":"

Get My test_daniel707 List.

\n

Description of this entity, can be markdown text.

\n

Property List:

\n\n

MethodRouting settings example:

\n
\n
{\n  "is_bank_id_exact_match":false,\n  "method_name":"dynamicEntityProcess",\n  "connector_name":"rest_vMar2019",\n  "bank_id_pattern":".*",\n  "parameters":[\n    {\n        "key":"entityName",\n        "value":"test_daniel707"\n    }\n    {\n        "key":"url",\n        "value":"http://mydomain.com/xxx"\n    }\n  ]\n}\n
\n
\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

Can do filter on the fields
\ne.g: /test_daniel707?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

\n","description_markdown":"Get My test_daniel707 List.\n\nDescription of this entity, can be markdown text.\n\n\n**Property List:** \n\n* name: description of **name** field, can be markdown text.\n* number: description of **number** field, can be markdown text.\n\n\nMethodRouting settings example:\n\n
\n\n```\n{\n \"is_bank_id_exact_match\":false,\n \"method_name\":\"dynamicEntityProcess\",\n \"connector_name\":\"rest_vMar2019\",\n \"bank_id_pattern\":\".*\",\n \"parameters\":[\n {\n \"key\":\"entityName\",\n \"value\":\"test_daniel707\"\n }\n {\n \"key\":\"url\",\n \"value\":\"http://mydomain.com/xxx\"\n }\n ]\n}\n```\n\n
\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCan do filter on the fields\ne.g: /test_daniel707?name=James%20Brown&number=123.456&number=11.11\nWill do filter by this rule: name == \"James Brown\" && (number==123.456 || number=11.11)","success_response_body":{"test_daniel707_list":[{"test_daniel707_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","name":"James Brown","number":698761728}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"typed_success_response_body":{"type":"object","properties":{"test_daniel707_list":{"type":"array","items":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/dynamic-entity/my/test_daniel707","connector_methods":[]}]}