{"type":"doc","content":[{"type":"expand","attrs":{"title":"MENU"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"style":{"value":"none"}},"macroMetadata":{"macroId":{"value":"c7a6bae2-33af-4b0f-a612-8269b5c1f6b8"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"0dd28019-490b-4051-9c9b-5e83e813962c"}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"1. API Flows","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"1.1 Step 1: Agree Account Access Consent","type":"text"}]},{"type":"paragraph","content":[{"text":"The flow MUST begin with a User who provides consent to a TPP to access their account information from a LFI that they already have a relationship.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"1.2 Step 2: Authorize Account Access Consent","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP MUST now request the User to authorize the consent. Please refer to the ","type":"text"},{"text":"Authentication and Authorization","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://openfinanceuae.atlassian.net/wiki/spaces/6af317645dd64444b360d51d5bfb6d46/pages/321225904"}}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"page to review the supported Authorization Flows. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP MUST construct a Rich Authorization Request (","type":"text"},{"type":"inlineCard","attrs":{"url":"https://www.rfc-editor.org/rfc/rfc9396"}},{"text":") with the ","type":"text"},{"text":"authorization_details","type":"text","marks":[{"type":"code"}]},{"text":" populated with the User’s consent","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP MUST include in an account access consent, all REQUIRED data permissions that the User intends to provide to the TPP","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP MUST include a UUID v4 as the ConsentId as a unique identifier for the account access consent","type":"text"}]},{"type":"paragraph","content":[{"text":"A TPP MAY be a broker for data to other parties, so it is valid for a User to have multiple consents","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"for the same resource(s), with different consent or authorization parameters agreed upon.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"1.2.1 Security and Access Control","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Authorization Code Grant","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP MUST use an authorization code grant to obtain a token to access all other API resources.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"1.3 Step 3: Access Data","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"1.3.1 Request Data","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP MUST have a valid access token (with scope) from the OFP authorization server.","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP MUST use the valid access token to retrieve User data from the OFP resource server.","type":"text"}]},{"type":"paragraph","content":[{"text":"The LFI MUST return an API response when provided with a valid request from the OFP.","type":"text"}]},{"type":"paragraph","content":[{"text":"The OFP MUST return an API response when provided with a valid access token request from the TPP.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"2. Sequence Diagram","type":"text"}]},{"type":"paragraph","content":[{"text":"All sequence diagrams relating to Bank Data Sharing are now available in the API Hub Documentation.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"3. Examples","type":"text"}]},{"type":"paragraph","content":[{"text":"The following are non-normative examples of API access and usage of the Account Information API.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.1 The TPP Redirects the User to Authorize Account Access Consent","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.1.1 Request: TPP Uses RAR (Rich Authorization Request) via a PAR (Pushed Authorization Request) Endpoint with the OFP to Obtain a Request URI","type":"text"}]},{"type":"paragraph","content":[{"text":"Create a RAR Request JWT with these values:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"kid","type":"text","marks":[{"type":"code"}]},{"text":" is a valid signing key ID for the TPP on the Open Finance Directory","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"iss","type":"text","marks":[{"type":"code"}]},{"text":" is client id (UUID v4)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"state","type":"text","marks":[{"type":"code"}]},{"text":" is a UUID v4 value","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"response_type","type":"text","marks":[{"type":"code"}]},{"text":" MUST be ","type":"text"},{"text":"code","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"redirect_uri","type":"text","marks":[{"type":"code"}]},{"text":" is the TPP’s redirect URI","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The authorization_details contain the User’s account access consent details, and a UUID v4 which is a unique identifier for the account access consent.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"typ\": \"JWT\",\n \"alg\": \"PS256\",\n \"kid\": \"e4ce77c498e77000a25aa7b40e4a83f9\"\n}\n.\n{\n \"iss\": \"s6BhdRkqt3\",\n \"aud\": \"https://server.example.com\",\n \"response_type\": \"code\",\n \"redirect_uri\": \"https://openbanking.tpp1.ae/simple-redirect-url\",\n \"scope\": \"accounts\",\n \"state\": \"2616df22-899e-468b-b7af-927145b067cc\",\n \"authorization_details\": [\n {\n \"type\": \"urn:openfinanceuae:account-access-consent:v1.2\",\n \"consent\": {\n \"ConsentId\": \"399e0065-9907-42cc-82b9-1ec4f273e3e9\",\n \"Permissions\": [\n \"ReadAccountsBasic\",\n \"ReadAccountsDetail\",\n \"ReadBalances\",\n \"ReadBeneficiariesBasic\",\n \"ReadBeneficiariesDetail\",\n \"ReadTransactionsBasic\",\n \"ReadTransactionsDetail\",\n \"ReadTransactionsCredits\",\n \"ReadTransactionsDebits\",\n \"ReadScheduledPaymentsBasic\",\n \"ReadScheduledPaymentsDetail\",\n \"ReadDirectDebits\",\n \"ReadStandingOrdersBasic\",\n \"ReadStandingOrdersDetail\"\n ],\n \"ExpirationDateTime\": \"2024-03-28T15:27:13+0300\",\n \"TransactionFromDateTime\": \"2024-03-25T12:19:24+0300\",\n \"TransactionToDateTime\": \"2024-03-27T12:19:24+0300\",\n \"AccountType\": [\"Retail\"],\n \"AccountSubType\": [\"CurrentAccount\"],\n \"OpenFinanceBilling\": {\n \"UserType\": \"Retail\",\n \"Purpose\": \"AccountAggregation\"\n }\n }\n }\n ]\n}","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Create the RAR Request using the signed JWT, and authenticated using private_key_jwt. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The request parameter JWT includes the ConsentId, a UUID v4 that was originally generated by the TPP.","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /open-finance/auth/v1.2/par HTTP/1.1\nHost: auth1.openfinanceplatform.ae\nContent-Type: application/x-www-form-urlencoded\nAccept: application/json\nclient_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer\n&client_assertion=eyJhbGciOiJIUzI1NiJ9.ew0KICAiaXNzIjogImM4NDIyNzg3LTFkZmYtNDI0ZC1iNjIwLTM1NmMwODcwYmVkNCIsDQogICJzdWIiOiAiYzg0MjI3ODctMWRmZi00MjRkLWI2MjAtMzU2YzA4NzBiZWQ0IiwNCiAgImF1ZCI6ICJhdXRoMS5sYWIub3BlbmJhbmtpbmcuc2EiLA0KICJqdGkiOiAiYThmZDQ2ZjctYTNiMy00MGQ5LTk2ZjctNDk1YmEyMGFiMTZmIiwNCiAgImV4cCI6IDE1MTYyMzkwMjINCn0.nvY2tG7D3_ioVI55nRJ7apBzoGbP9sofMLd7Dni4YbI\n&request=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6ImU0Y2U3N2M0OThlNzcwMDBhMjVhYTdiNDBlNGE4M2Y5In0.eyJpc3MiOiJzNkJoZFJrcXQzIiwiaWF0IjoxNjY5MzkzMTU0LCJleHAiOjE2NjkzOTM0OTYsIm5iZiI6IjE2NjkzOTMxNTQiLCJhdWQiOiJodHRwczovL3NlcnZlci5leGFtcGxlLmNvbSIsInJlc3BvbnNlX3R5cGUiOiJjb2RlIGlkX3Rva2VuIiwicmVkaXJlY3RfdXJpIjoiaHR0cHM6Ly9sZmkubGFiLm9wZW5iYW5raW5nLmFlL2F1dGgiLCJzY29wZSI6Im9wZW5pZCBhY2NvdW50cyIsInN0YXRlIjoiYWYwaWZqc2xka2oiLCJhdXRob3JpemF0aW9uX2RldGFpbHMiOlt7IlR5cGUiOiJBY2NvdW50QWNjZXNzQ29uc2VudCIsIkRhdGEiOnsiQ29uc2VudElkIjoiMzk5ZTAwNjUtOTkwNy00MmNjLTgyYjktMWVjNGYyNzNlM2U5IiwiQ3JlYXRpb25EYXRlVGltZSI6IjIwMjQtMDMtMjdUMTU6Mjc6MTMrMDMwMCIsIkNvbnNlbnRTdGF0dXMiOiJBdXRob3JpemVkIiwiQ29uc2VudFN0YXR1c1VwZGF0ZURhdGVUaW1lIjoiMjAyNC0wMy0yN1QxNjoyNzoxMyswMzAwIiwiUGVybWlzc2lvbnMiOlsiUmVhZEFjY291bnRzQmFzaWMiLCJSZWFkQWNjb3VudHNEZXRhaWwiLCJSZWFkQmFsYW5jZXMiLCJSZWFkQmVuZWZpY2lhcmllc0Jhc2ljIiwiUmVhZEJlbmVmaWNpYXJpZXNEZXRhaWwiLCJSZWFkVHJhbnNhY3Rpb25zQmFzaWMiLCJSZWFkVHJhbnNhY3Rpb25zRGV0YWlsIiwiUmVhZFRyYW5zYWN0aW9uc0NyZWRpdHMiLCJSZWFkVHJhbnNhY3Rpb25zRGViaXRzIiwiUmVhZFNjaGVkdWxlZFBheW1lbnRzQmFzaWMiLCJSZWFkU2NoZWR1bGVkUGF5bWVudHNEZXRhaWwiLCJSZWFkRGlyZWN0RGViaXRzIiwiUmVhZFN0YW5kaW5nT3JkZXJzQmFzaWMiLCJSZWFkU3RhbmRpbmdPcmRlcnNEZXRhaWwiXSwiQXV0aG9yaXphdGlvbkV4cGlyYXRpb25UaW1lV2luZG93IjoiNzIwOjAwOjAwIiwiRXhwaXJhdGlvbkRhdGVUaW1lIjoiMjAyNC0wMy0yOFQxNToyNzoxMyswMzAwIiwiVHJhbnNhY3Rpb25Gcm9tRGF0ZVRpbWUiOiIyMDI0LTAzLTI1VDEyOjE5OjI0KzAzMDAiLCJUcmFuc2FjdGlvblRvRGF0ZVRpbWUiOiIyMDI0LTAzLTI3VDEyOjE5OjI0KzAzMDAiLCJBY2NvdW50VHlwZSI6WyJVQUVPRi5SZXRhaWwiXSwiQWNjb3VudFN1YlR5cGUiOlsiQ3VycmVudEFjY291bnQiXSwiQ29uc2VudFB1cnBvc2UiOlsiQWNjb3VudCBBZ2dyZWdhdGlvbiIsIkUtU3RhdGVtZW50Il19fV19.8T2xivs2zqFdxyrs8h3TWsMxigzk9QcsamU9Dj-2GDs","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.1.2 Response: The OFP Provides the Request URI for the TPP","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 201 Created\nContent-Type: application/json\nCache-Control: no-cache, no-store\n{\n \"request_uri\": \"urn:ietf:params:oauth:request_uri:6esc_11ACC5bwc014ltc14eY22c\",\n \"expires_in\": 60\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.2 The TPP Redirects the User to Their LFI with the Request URI to Authorize the Consent","type":"text"}]},{"type":"codeBlock","content":[{"text":"GET /auth?client_id=c8422787-1dff-424d-b620-356c0870bed4&request_uri=urn:ietf:params:oauth:request_uri:6esc_11ACC5bwc014ltc14eY22c\nHost: openbanking.lfi.ae","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.3 The User Logs into Their LFI, Reviews and Authorizes the Consent Request, and Confirms the Accounts They Want to Share with the TPP","type":"text"}]},{"type":"paragraph","content":[{"text":"The LFI confirms account access consent in the OFP.","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /auth/aac-1a672e83-d1e5-42bc-b8e1-60a490ec52fd/aac/doConfirm\nhost: auth1.openfinanceplatform.ae\nContent-Type: application/x-www-form-urlencoded\naccounts=f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115\n&accounts=bed6cb83-956e-4795-86c3-0f4254ae1cab\n&accounts=528b9f0c-c4e1-45fd-8f28-ab53fda4c850\n&accounts=fe1e15fe-d4aa-4b4c-9ce0-e69bbf901fa6\n&accounts=802d03c3-4ac5-4809-8c1e-f9f046e314e4\n&accounts=02d19fb7-cf51-4b9a-a958-77701120da3c","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.4 The LFI Returns an Authorization Code to the TPP","type":"text"}]},{"type":"codeBlock","content":[{"text":"302 Found\nLocation: https://openbanking.tpp1.ae/simple-redirect-url?\ncode=ce2aeabf-599c-4475-9171-1f6d8c1a49dc\n&state=2616df22-899e-468b-b7af-927145b067cc","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.5 The TPP Exchanges the Authorization Code for an Account API Access Token with the OFP","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /token HTTP/1.1\nHost: as1.openfinanceplatform.ae\nContent-Type: application/x-www-form-urlencoded\nAccept: application/json\ngrant_type=authorization_code\n&code=ce2aeabf-599c-4475-9171-1f6d8c1a49dc\n&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer\n&client_assertion=eyJhbGciOiJIUzI1NiJ9.ew0KICAiaXNzIjogImM4NDIyNzg3LTFkZmYtNDI0ZC1iNjIwLTM1NmMwODcwYmVkNCIsDQogICJzdWIiOiAiYzg0MjI3ODctMWRmZi00MjRkLWI2MjAtMzU2YzA4NzBiZWQ0IiwNCiAgImF1ZCI6ICJhdXRoMS5sYWIub3BlbmJhbmtpbmcuc2EiLA0KICJqdGkiOiAiYThmZDQ2ZjctYTNiMy00MGQ5LTk2ZjctNDk1YmEyMGFiMTZmIiwNCiAgImV4cCI6IDE1MTYyMzkwMjINCn0.nvY2tG7D3_ioVI55nRJ7apBzoGbP9sofMLd7Dni4YbI\n&redirect_uri=https%3A%2F%2Fopenbanking.tpp1.ae%2Fsimple-redirect-url","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.6 The OFP Returns an Access Token, Refresh Token, and ID Token to the TPP","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type:application/json\n{\n \"access_token\": \"caa1b60d-61ff-4cd8-a4e1-2d18c8696de0\",\n \"expires_in\": 432000,\n \"token_type\": \"Bearer\",\n \"scope\": \"openid%20accounts\",\n \"state\": \"2616df22-899e-468b-b7af-927145b067cc\",\n \"refresh_token\": \"266f5f15-eb81-4a02-bf05-e25063ca445f\",\n \"id_token\": \"eyJhbGciOiJQUzI1NiIsImtpZCI6IkM4a3FRRlZoUFVOUnZTN1ljamZBSEVSTEVDZEFfamZENXJjb1NXVkMwY2sifQ.eyJzdWIiOiJhYWMtMWE2NzJlODMtZDFlNS00MmJjLWI4ZTEtNjBhNDkwZWM1MmZkIiwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjoiYWFjLTFhNjcyZTgzLWQxZTUtNDJiYy1iOGUxLTYwYTQ5MGVjNTJmZCIsInBzdV9pZGVudGlmaWVycyI6eyJjb21wYW55SWQiOiIxMjM0NSJ9LCJpc3MiOiJodHRwczovL2F1dGgxLmxhYi5vcGVuYmFua2luZy5zYSIsImF1ZCI6ImM4NDIyNzg3LTFkZmYtNDI0ZC1iNjIwLTM1NmMwODcwYmVkNCIsImlhdCI6MTY1OTg2NDEzMywiZXhwIjoxNjU5ODY1MDMzLCJub25jZSI6ImZmMzljMGQxLTIyN2EtNGM3My1iYjA1LTA4NDY0ZjA1MmU4NSIsImF1dGhfdGltZSI6MTY1OTg2NDEzMywiYXpwIjoiYzg0MjI3ODctMWRmZi00MjRkLWI2MjAtMzU2YzA4NzBiZWQ0IiwicmVmcmVzaF90b2tlbl9leHBpcmVzX2F0IjoxNjY3NjQwMTMzLCJjX2hhc2giOiI5UWhXZVlzWnd6NzF0NWhjdlI2OU5BIiwic19oYXNoIjoiNHN0R0QtYTFjS3dFSjVwWFZYOEdnUSIsImFjciI6InVybjpvcGVuYmFua2luZzpwc2QyOnNjYSJ9.AfunjbLyzOMQXtZfAl4563cKxTYbXhzZk5IFrJ864w1aF9_XpIQe1iH5H17xIXL_1XmjbPiPMzx55025NMyDOMwPSRBDu9bIb37EyUlVVtVevxxwVeyOixcOx-NoNMHO4qTKyznhCM_oJmNmq5n8N9xSbmyJSGDIusGiiyXyNt0egnK4xkvPFwri4FJd3IUIdUWOCuUO9RlckBQottUiyo4UazrAaShpn4GIsl_1fj8U2Ga5v4t_6jRG7oEndwQoDruLrftFnwvDWJYD2NSm5LKUb2z4HTb-89aPihcGpCrSrnxqyB6kiAculoJAhZhC8TBY40G3l-6qjc5Ey71JHA\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP can now request account resources using the access token.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.7 Get a List of Accounts","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.7.1 Request: Accounts Resource","type":"text"}]},{"type":"codeBlock","content":[{"text":"GET /open-finance/account-information/v1.2/accounts HTTP/1.1\nHost: rs1.openfinanceplatform.ae\nAccept: application/json\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\nAuthorization: Bearer caa1b60d-61ff-4cd8-a4e1-2d18c8696de0","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.7.2 Response: Accounts Resource","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\n{\n \"Data\": {\n \"Account\": [\n {\n \"AccountId\": \"f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115\",\n \"AccountHolderName\": \"Hamad Ali\",\n \"AccountHolderShortName\": \"\",\n \"Status\": \"Active\",\n \"Currency\": \"AED\",\n \"AccountType\": \"Retail\",\n \"AccountSubType\": \"CurrentAccount\",\n \"Nickname\": \"CurrentAC\",\n \"OpeningDate\": \"2021-01-28T15:27:13+0300\",\n \"AccountIdentifiers\": [\n {\n \"SchemeName\": \"IBAN\",\n \"Identification\": \"SA4420000001234567891234\",\n \"Name\": \"Hamad Ali\"\n }\n ],\n \"Servicer\": {\n \"SchemeName\": \"BICFI\",\n \"Identification\": \"SASAMA\"\n }\n },\n {\n \"AccountId\": \"g91d07d0-6d8f-4e0e-9fb4-0ac61f84e444\",\n \"AccountHolderName\": \"Hamad Ali\",\n \"AccountHolderShortName\": \"\",\n \"Status\": \"Active\",\n \"Currency\": \"USD\",\n \"AccountType\": \"Retail\",\n \"AccountSubType\": \"Savings\",\n \"Nickname\": \"SavingsAC\",\n \"OpeningDate\": \"2021-01-28T15:27:13+0300\",\n \"AccountIdentifiers\": [\n {\n \"SchemeName\": \"IBAN\",\n \"Identification\": \"SA4420000001234567890001\",\n \"Name\": \"Hamad Ali\"\n }\n ],\n \"Servicer\": {\n \"SchemeName\": \"BICFI\",\n \"Identification\": \"SASAMA\"\n }\n }\n ]\n },\n \"Links\": {\n \"Self\": \"https://rs1.openfinanceplatform.ae/open-finance/account-information/v1.2/accounts\"\n },\n \"Meta\": {}\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.8 Get Balances for an Account","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.8.1 Request: accounts/{","type":"text"},{"text":"AccountId","type":"text","marks":[{"type":"code"}]},{"text":"}/balances resource","type":"text"}]},{"type":"codeBlock","content":[{"text":"GET /open-finance/account-information/v1.2/accounts/f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115/balances HTTP/1.1\nHost: rs1.lab.api.openbanking.ae\nAccept: application/json\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\nAuthorization: Bearer caa1b60d-61ff-4cd8-a4e1-2d18c8696de0","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.8.2 Response: accounts/{","type":"text"},{"text":"AccountId","type":"text","marks":[{"type":"code"}]},{"text":"}/balances resource","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\n{\n \"Data\": {\n \"AccountId\": \"f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115\",\n \"Balance\": [\n {\n \"CreditDebitIndicator\": \"Credit\",\n \"Type\": \"ClosingAvailable\",\n \"DateTime\": \"2024-06-28T15:27:13+0300\",\n \"Amount\": {\n \"Amount\": \"10000.00\",\n \"Currency\": \"AED\"\n },\n \"CreditLine\": [\n {\n \"Included\": true,\n \"Type\": \"Available\",\n \"Amount\": {\n \"Amount\": \"45000.00\",\n \"Currency\": \"AED\"\n }\n }\n ]\n }\n ]\n },\n \"Links\": {\n \"Self\": \"https://rs1.openfinanceplatform.ae/open-finance/account-information/v1.2/accounts/f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115/balances\"\n },\n \"Meta\": {}\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.9 Get Transactions for an Account","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.9.1 Request: accounts/{","type":"text"},{"text":"AccountId","type":"text","marks":[{"type":"code"}]},{"text":"}/transactions resource","type":"text"}]},{"type":"codeBlock","content":[{"text":"GET /open-finance/account-information/v1.2/accounts/f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115/transactions HTTP/1.1\nHost: rs1.lab.api.openbanking.ae\nAccept: application/json\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\nAuthorization: Bearer caa1b60d-61ff-4cd8-a4e1-2d18c8696de0","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.9.2 Response: accounts/{","type":"text"},{"text":"AccountId","type":"text","marks":[{"type":"code"}]},{"text":"}/transactions resource","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\n{\n \"Data\": {\n \"AccountId\": \"f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115\",\n \"Transaction\": [\n {\n \"TransactionId\": \"19ee5b71-e70a-4a97-8cc2-c235c7274beb\",\n \"TransactionDateTime\": \"2024-06-26T16:18:32+0300\",\n \"LocalTimeZone\": \"UTC+04:00\",\n \"StatementReference\": \"502fec1c-ed4f-4524-a477-13b9802c03d\",\n \"TransactionReference\": \"20230126SAMA1234567812345678123456\",\n \"TransactionType\": \"POS\",\n \"SubTransactionType\": \"Purchase\",\n \"TerminalId\": \"1234567812345678\",\n \"Flags\": [\n \"Cashback\"\n ],\n \"PaymentModes\": \"Online\",\n \"CreditDebitIndicator\": \"Debit\",\n \"Status\": \"Booked\",\n \"TransactionMutability\": \"Mutable\",\n \"BookingDateTime\": \"2024-06-26T16:18:32+0300\",\n \"ValueDateTime\": \"2024-06-26T16:18:32+0300\",\n \"Amount\": {\n \"Amount\": \"100.00\",\n \"Currency\": \"AED\"\n },\n \"ChargeAmount\": {\n \"Amount\": \"10.00\",\n \"Currency\": \"AED\",\n \"ChargeIncluded\": true\n },\n \"ChargeAmountVat\": {\n \"Amount\": \"0.00\",\n \"Currency\": \"AED\"\n },\n \"CurrencyExchange\": {\n \"SourceCurrency\": \"AED\",\n \"TargetCurrency\": \"AED\",\n \"UnitCurrency\": \"1\",\n \"ExchangeRate\": \"1.02\",\n \"InstructedAmount\": {\n \"Amount\": \"102.00\",\n \"Currency\": \"AED\"\n }\n },\n \"Balance\": {\n \"CreditDebitIndicator\": \"Credit\",\n \"Type\": \"ClosingAvailable\",\n \"Amount\": {\n \"Amount\": \"9900.00\",\n \"Currency\": \"AED\"\n }\n },\n \"MerchantDetails\": {\n \"MerchantId\": \"1234567890\",\n \"MerchantName\": \"Rand's Cafe\",\n \"MerchantCategoryCode\": \"5812\"\n },\n \"CreditorAccount\": {\n \"SchemeName\": \"IBAN\",\n \"Identification\": \"SA4420000001234567899876\",\n \"Name\": \"Rand's Cafe\"\n },\n \"DebtorAccount\": {\n \"SchemeName\": \"IBAN\",\n \"Identification\": \"SA4420000001234567891234\",\n \"Name\": \"Hamad Ali\"\n },\n \"CardInstrument\": {\n \"CardSchemeName\": \"mada\",\n \"InstrumentType\": \"madaPay\",\n \"Name\": \"Mr. Hamad Ali\",\n \"Identification\": \"1234********4321\"\n },\n \"BillDetails\": {\n \"BillerId\": \"0\",\n \"BillNumber\": \"\",\n \"BillPaymentType\": \"\"\n }\n },\n {\n \"TransactionId\": \"c68d98ea-6e91-4a3b-8459-f12a9d7ecba4\",\n \"TransactionDateTime\": \"2024-06-26T16:18:32+0300\",\n \"LocalTimeZone\": \"UTC+04:00\",\n \"StatementReference\": \"502fec1c-ed4f-4524-a477-13b9802c03d\",\n \"TransactionReference\": \"20230126SASAMASAMA2BMOB11444064073\",\n \"TransactionType\": \"LocalBankTransfer\",\n \"SubTransactionType\": \"MoneyTransfer\",\n \"PaymentModes\": \"Online\",\n \"CreditDebitIndicator\": \"Credit\",\n \"Status\": \"Booked\",\n \"TransactionMutability\": \"Immutable\",\n \"BookingDateTime\": \"2024-06-26T16:18:32+0300\",\n \"ValueDateTime\": \"2024-06-26T16:18:32+0300\",\n \"Amount\": {\n \"Amount\": \"100.00\",\n \"Currency\": \"AED\"\n },\n \"ChargeAmount\": {\n \"Amount\": \"0.00\",\n \"Currency\": \"AED\",\n \"ChargeIncluded\": true\n },\n \"ChargeAmountVat\": {\n \"Amount\": \"0.00\",\n \"Currency\": \"AED\"\n },\n \"Balance\": {\n \"CreditDebitIndicator\": \"Credit\",\n \"Type\": \"ClosingAvailable\",\n \"Amount\": {\n \"Amount\": \"10000.00\",\n \"Currency\": \"AED\"\n }\n },\n \"CreditorAccount\": {\n \"SchemeName\": \"IBAN\",\n \"Identification\": \"SA4420000001234567899876\",\n \"Name\": \"Rand Ali\"\n },\n \"DebtorAccount\": {\n \"SchemeName\": \"IBAN\",\n \"Identification\": \"SA4420000001234567891234\",\n \"Name\": \"Abdulelah Alyahya\"\n }\n }\n ]\n },\n \"Links\": {\n \"Self\": \"https://rs1.openfinanceplatform.ae/open-finance/account-information/v1.2/accounts/f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115/transactions\"\n },\n \"Meta\": {\n \"FirstAvailableDateTime\": \"2024-06-25T12:19:24+0300\",\n \"LastAvailableDateTime\": \"2024-06-27T12:19:24+0300\"\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"4. Further Examples","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4.1 The TPP Queries the Account Access Consent Resource for the Status after a User has Authorized the Consent","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.1.1 Request: account-access-consents/{","type":"text"},{"text":"ConsentId","type":"text","marks":[{"type":"code"}]},{"text":"} resource","type":"text"}]},{"type":"codeBlock","content":[{"text":"GET /open-finance/account-information/v1.2/account-access-consents/aac-1a672e83-d1e5-42bc-b8e1-60a490ec52fd HTTP/1.1\nHost: rs1.openfinanceplatform.ae\nContent-Type: application/json\nx-fapi-interaction-id: 2e974f01-d111-4078-9a19-7a9b385e637c\nAuthorization: Bearer e6156449-6f27-4c42-aa5b-36602f73eac9","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.1.2 Response: account-access-consents/{","type":"text"},{"text":"ConsentId","type":"text","marks":[{"type":"code"}]},{"text":"} resource","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type:application/json\nx-fapi-interaction-id: 2e974f01-d111-4078-9a19-7a9b385e637c\n{\n \"Data\": {\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"CreationDateTime\": \"2024-06-27T15:27:13+0300\",\n \"Status\": \"Authorized\",\n \"ConsentFlags\": {\n \"PartlyAuthorized\": \"2024-06-27T16:27:13+0300\"\n },\n \"StatusUpdateDateTime\": \"2024-06-27T16:27:13+0300\",\n \"Permissions\": [\n \"ReadAccountsBasic\",\n \"ReadAccountsDetail\",\n \"ReadBalances\",\n \"ReadBeneficiariesBasic\",\n \"ReadBeneficiariesDetail\",\n \"ReadTransactionsBasic\",\n \"ReadTransactionsDetail\",\n \"ReadTransactionsCredits\",\n \"ReadTransactionsDebits\",\n \"ReadScheduledPaymentsBasic\",\n \"ReadScheduledPaymentsDetail\",\n \"ReadDirectDebits\",\n \"ReadStandingOrdersBasic\",\n \"ReadStandingOrdersDetail\"\n ],\n \"ExpirationDateTime\": \"2024-06-28T15:27:13+0300\",\n \"TransactionFromDateTime\": \"2024-06-25T12:19:24+0300\",\n \"TransactionToDateTime\": \"2024-06-27T12:19:24+0300\",\n \"AccountType\": [\n \"Retail\"\n ],\n \"AccountSubType\": [\n \"CurrentAccount\"\n ],\n \"OpenFinanceBilling\": {\n \"UserType\": \"Retail\",\n \"Purpose\": \"AccountAggregation\"\n }\n },\n \"Subscription\": {\n \"Webhook\": {\n \"Url\": \"https://api.tpp1.com/webhook/callbackUrl\",\n \"IsActive\": false\n }\n },\n \"Links\": {\n \"Self\": \"https://rs1.openfinanceplatform.ae/open-finance/account-information/v1.2/account-access-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa\"\n },\n \"Meta\": {}\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4.2 The TPP Requests a List of Accounts Using an Expired Access Token","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.2.1 Request: accounts resource","type":"text"}]},{"type":"codeBlock","content":[{"text":"GET /open-finance/account-information/v1.2/accounts HTTP/1.1\nHost: rs1.openfinanceplatform.ae\nContent-Type: application/json\nx-fapi-interaction-id: 9a371b79-4e79-4d7d-a77d-380c528ab8c0\nAuthorization: Bearer caa1b60d-61ff-4cd8-a4e1-2d18c8696de0","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.2.2 Response: 401 Unauthorized","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 401 Unauthorized\nContent-Type: application/json\nx-fapi-interaction-id: 9a371b79-4e79-4d7d-a77d-380c528ab8c0","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4.3 Webhooks","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.3.1 The TPP Creates an Account Access Consent Request with a Webhook Subscription","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.3.1.1 Request: Account Access Consent and Webhook Subscription","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"typ\": \"JWT\",\n \"alg\": \"PS256\",\n \"kid\": \"e4ce77c498e77000a25aa7b40e4a83f9\"\n}\n.\n{\n \"iss\": \"s6BhdRkqt3\",\n \"iat\": 1669393154,\n \"exp\": 1669393496,\n \"nbf\": 1669393154,\n \"aud\": \"https://server.example.com\",\n \"response_type\": \"code\",\n \"redirect_uri\": \"https://openbanking.tpp1.ae/simple-redirect-url\",\n \"scope\": \"accounts\",\n \"state\": \"2616df22-899e-468b-b7af-927145b067cc\",\n \"authorization_details\": [\n {\n \"type\": \"urn:openfinanceuae:account-access-consent:v1.2\",\n \"consent\": {\n \"ConsentId\": \"399e0065-9907-42cc-82b9-1ec4f273e3e9\",\n \"CreationDateTime\": \"2024-03-27T15:27:13+0300\",\n \"Status\": \"Authorized\",\n \"StatusUpdateDateTime\": \"2024-03-27T16:27:13+0300\",\n \"Permissions\": [\n \"ReadAccountsBasic\",\n \"ReadAccountsDetail\",\n \"ReadBalances\",\n \"ReadBeneficiariesBasic\",\n \"ReadBeneficiariesDetail\",\n \"ReadTransactionsBasic\",\n \"ReadTransactionsDetail\",\n \"ReadTransactionsCredits\",\n \"ReadTransactionsDebits\",\n \"ReadScheduledPaymentsBasic\",\n \"ReadScheduledPaymentsDetail\",\n \"ReadDirectDebits\",\n \"ReadStandingOrdersBasic\",\n \"ReadStandingOrdersDetail\"\n ],\n \"ExpirationDateTime\": \"2024-03-28T15:27:13+0300\",\n \"TransactionFromDateTime\": \"2024-03-25T12:19:24+0300\",\n \"TransactionToDateTime\": \"2024-03-27T12:19:24+0300\",\n \"AccountType\": [\"Retail\"],\n \"AccountSubType\": [\"CurrentAccount\"],\n \"OpenFinanceBilling\": {\n \"UserType\": \"Retail\",\n \"Purpose\": \"AccountAggregation\"\n }\n },\n \"Subscription\": {\n \"Webhook\": {\n \"Url\": \"https://api.tpp1.com/webhook/callbackUrl\",\n \"IsActive\": false\n }\n }\n }\n ]\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.3.2 The TPP updates a Webhook Subscription preference with the OFP","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.3.2.1 Request: Activate Webhook events","type":"text"}]},{"type":"codeBlock","content":[{"text":"PATCH /open-finance/account-information/v1.2/account-access-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa HTTP/1.1\nHost: rs1.lab.api.openbanking.ae\nContent-Type: application/json\nx-fapi-interaction-id: 3424a379-8274-4686-99bd-f420d08acead\nAuthorization: Bearer ad297304-1057-4c68-9e76-a96f300a27f1\n{\n \"Subscription\": {\n \"Webhook\": {\n \"IsActive\": true\n }\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.3.2.2 Response: Webhook events activated","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 204 No Content\nx-fapi-interaction-id: 3424a379-8274-4686-99bd-f420d08acead","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.3.3 The TPP unsubscribes their Webhook Subscription with the OFP","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.3.3.1 Request: De-Activate Webhook events","type":"text"}]},{"type":"codeBlock","content":[{"text":"PATCH /open-finance/account-information/v1.2/account-access-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa HTTP/1.1\nHost: rs1.lab.api.openbanking.ae\nContent-Type: application/json\nx-fapi-interaction-id: 3424a379-8274-4686-99bd-f420d08acead\nAuthorization: Bearer ad297304-1057-4c68-9e76-a96f300a27f1\n{\n \"Subscription\": {\n \"Webhook\": {\n \"IsActive\": false\n }\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.3.3.2 Response: Webhook events de-activated","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 204 No Content\nx-fapi-interaction-id: 3424a379-8274-4686-99bd-f420d08acead","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.3.4 The TPP receives data from the OFP (specific to the consent and permissions) via its Webhook","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.3.4.1 The OFP generates a Self Signed JWT Authorization Token for Client Authentication with the TPP.","type":"text"}]},{"type":"paragraph","content":[{"text":"This JWT Authorization Token MUST be set in the Authorization Header.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"alg\": \"PS256\",\n \"typ\": \"JOSE\",\n \"cty\": \"json\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"https://openbanking.masrif-ahmar.ae\",\n \"sub\": \"e75c26bf-1682-401a-a227-ec125f6636ab\",\n \"aud\": \"https://api.tpp.com/webhook/callbackUrl\",\n \"exp\": 1661378066,\n \"iat\": 1661378036,\n \"nbf\": 1661378036,\n \"jti\": \"274aa39d-d77a-46a9-b832-b2ced47919dd\"\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.3.4.2 Request: OFP publishes signed/encrypted data to the registered Webhook Url provided by the TPP","type":"text"}]},{"type":"paragraph","content":[{"text":"The example below shows a signed and encrypted payload with the JWT Authorization Token set in the Authorization Header.","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /webhook/callbackUrl HTTP/1.1\nHost: api.tpp.com\nx-fapi-interaction-id: 77b0e830-b095-4c6c-94e8-20f83eaa799f\nContent-Type: application/jwt\nDate: Wed, 24 Aug 2022 07:28:00 AST\nAuthorization: Bearer eyJhbGciO9.eyJzdWImlhdCI6MTUxNjIzOTAyMn0.iOeN9eg\n\n<>\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Here, ","type":"text"},{"text":"<>","type":"text","marks":[{"type":"code"}]},{"text":" is a signed and encrypted payload. The inner JWS has the structure below:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 1664950125,\n \"nbf\": 1664950125,\n \"aud\": [\n \"6uC8HSQ8C59SDSw43Cdm9YWxxjJmDV\"\n ],\n \"iat\": 1661378036,\n \"message\": {\n \"Data\": {\n \"AccountId\": \"f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115\",\n \"Account\": [\n { \n \"Currency\": \"AED\",\n \"Status\": \"Active\", \n \"AccountIdentifiers\": [\n {\n \"Name\": \"Account 1\",\n \"SchemeName\": \"IBAN\",\n \"Identification\": \"00003130000001\"\n }\n ]\n }\n ]\n },\n \"Links\": {\n \"Self\": \"https://rs1.openfinanceplatform.ae/open-finance/account-information/v1.2/accounts/f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115\"\n },\n \"EventMeta\": {\n \"EventDateTime\": \"2022-08-24T07:28:00.556Z\",\n \"EventResource\": \"accounts\",\n \"EventType\": \"Resource.Created\",\n \"ConsentId\": \"aac-1a672e83-d1e5-42bc-b8e1-60a490ec52fd\"\n }\n }\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.3.4.3 Response: TPP validates the Self Signed JWT Authorization Token from LFI, stores data, and acknowledges a successful response to the OFP","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 202 Accepted\nx-fapi-interaction-id: 77b0e830-b095-4c6c-94e8-20f83eaa799f","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.3.5 Webhook Payload for a single resource collection associated with a single event type","type":"text"}]},{"type":"paragraph","content":[{"text":"The following non-normative example illustrates a OFP webhook payload for a collection of account ID transactions of the same event type: ","type":"text"},{"text":"Resource.Created","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","content":[{"text":"{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 1664950125,\n \"nbf\": 1664950125,\n \"aud\": [\n \"6uC8HSQ8C59SDSw43Cdm9YWxxjJmDV\"\n ],\n \"iat\": 1661378036,\n \"message\": {\n \"Data\": {\n \"AccountId\": \"f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115\",\n \"Transaction\": [\n {\n \"TransactionId\": \"668f2fc8-7aa8-411b-bb9f-7571a90e7512\",\n \"TransactionReference\": \"1852efce-bedc-4fda-ba51-0f76c9137f91\",\n \"CreditDebitIndicator\": \"Debit\",\n \"Status\": \"Booked\",\n \"TransactionMutability\": \"\",\n \"BookingDateTime\": \"2022-08-24T07:27:00.556Z\",\n \"ValueDateTime\": \"2022-08-24T07:27:00.556Z\",\n \"TransactionInformation\": \"Foo Group \",\n \"Amount\": {\n \"Amount\": \"41.10\",\n \"Currency\": \"AED\"\n },\n \"BankTransactionCode\": {\n \"Code\": \"CustomerCardTransactions\",\n \"SubCode\": \"CashWithdrawal\"\n },\n \"ProprietaryBankTransactionCode\": {\n \"Code\": \"\"\n }\n },\n {\n \"TransactionId\": \"05b6bfde-ce5a-48e1-a448-66d75518f1e8\",\n \"TransactionReference\": \"b5a6a869-730f-449d-badf-14ebf3980147\",\n \"CreditDebitIndicator\": \"Debit\",\n \"Status\": \"Booked\",\n \"TransactionMutability\": \"\",\n \"BookingDateTime\": \"2022-08-24T07:28:00.556Z\",\n \"ValueDateTime\": \"2022-08-24T07:28:00.556Z\",\n \"TransactionInformation\": \"Bar Holding\",\n \"Amount\": {\n \"Amount\": \"32.40\",\n \"Currency\": \"AED\"\n },\n \"BankTransactionCode\": {\n \"Code\": \"CustomerCardTransactions\",\n \"SubCode\": \"CashWithdrawal\"\n },\n \"ProprietaryBankTransactionCode\": {\n \"Code\": \"\"\n }\n }\n ]\n },\n \"Links\": {\n \"Self\": \"https://rs1.openfinanceplatform.ae/open-finance/account-information/v1.2/accounts/f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115/transactions\"\n },\n \"EventMeta\": {\n \"EventDateTime\": \"2022-08-24T08:28:00.556Z\",\n \"EventResource\": \"transactions\",\n \"EventType\": \"Resource.Created\",\n \"ConsentId\": \"aac-1a672e83-d1e5-42bc-b8e1-60a490ec52fd\"\n }\n }\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"5. OpenAPI Specification","type":"text"}]},{"type":"paragraph","content":[{"text":"See the ","type":"text"},{"text":"Bank Data API - Swagger ","type":"text","marks":[{"type":"strong"}]},{"text":"page","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://openfinanceuae.atlassian.net/wiki/spaces/standardsv1dot2final/pages/277942370/Bank+Data+OpenAPI"}},{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"6. Notes","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IBAN","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Where ","type":"text"},{"text":"Data.Account.AccountIdentifiers[].SchemeName","type":"text","marks":[{"type":"code"}]},{"text":" is ","type":"text"},{"text":"IBAN","type":"text","marks":[{"type":"code"}]},{"text":", the Identification field SHOULD contain the full IBAN","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Passport, Driving Permit, IDCard, Residence Permit","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Where ","type":"text"},{"text":"Data.Party.VerifiedClaims.[].Verification.Evidence[DocumentDetails.Type]","type":"text","marks":[{"type":"code"}]},{"text":" is set to any one of these enumerated values, then the DocumentNumber field SHOULD contain the actual number of the document type specified.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ProprietaryBankTransactionCodes","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"This code is mandatory when the BenefeciaryCode with code specifying the Domain, Family, and SubFamily as per ","type":"text"},{"text":"External Codes ISO20022","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.iso20022.org/sites/default/files/2022-05/BTC_Codification_31May2022.xls"}}]},{"text":" is absent. This code is a proprietary code from the LFI and does not have a defined code list.","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"7. Security","type":"text"}]},{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"accounts","type":"text","marks":[{"type":"code"}]},{"text":" scope is used for accessing the account information endpoints.","type":"text"}]}],"version":1}

Browser not supported