{"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":"8406147a-550c-4873-a021-2937faa2d935"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"53c7a6b4-880c-48bd-a314-552a7f910916"}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"1. API Flows","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"1.1 Step 1: Agree Service Initiation Consent","type":"text"}]},{"type":"paragraph","content":[{"text":"The flow MUST begin with a User who provides consent to a TPP to stage a Bank Service Initiation operation, for a LFI that they already have a relationship with.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"1.2 Step 2: Authorize Service Initiation 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"}]},{"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 Service Initiation consent","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP MUST include in a Service Initiation consent all mandatory data that the User intends to provide to the TPP for initiating a Service Initiation operation.","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP MUST include a UUID v4 as the ConsentId as a unique identifier for the Service Initiation consent.","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP MAY, within in the Service Initiation Consent (where applicable):","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the ","type":"text"},{"text":"IsSingleAuthorization","type":"text","marks":[{"type":"code"}]},{"text":" field to determine if only Single Authorizer flow supported.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the ","type":"text"},{"text":"AuthorizationExpirationDateTime","type":"text","marks":[{"type":"code"}]},{"text":" field to limit the overall time in which a Consent MUST be authorized.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"1.2.1 Service Initiation Consent Types","type":"text"}]},{"type":"paragraph","content":[{"text":"The OFP MUST link both ","type":"text"},{"text":"PaymentId","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"ConsentId","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the Service Initiation resource ","type":"text"},{"text":"(PaymentId","type":"text","marks":[{"type":"code"}]},{"text":") set ","type":"text"},{"text":"Links.Related","type":"text","marks":[{"type":"code"}]},{"text":" to the authorized ","type":"text"},{"text":"ConsentId","type":"text","marks":[{"type":"code"}]},{"text":" used to create the Service Initiation.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the Service Initiation consent resource (","type":"text"},{"text":"ConsentId","type":"text","marks":[{"type":"code"}]},{"text":") set ","type":"text"},{"text":"Links.Related","type":"text","marks":[{"type":"code"}]},{"text":" to the ","type":"text"},{"text":"PaymentId","type":"text","marks":[{"type":"code"}]},{"text":" resource created for the Consent.","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: Create Service Initiation","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 create a Service Initiation resource with the OFP resource server.","type":"text"}]},{"type":"paragraph","content":[{"text":"The LFI MUST return a ","type":"text"},{"text":"201 Status Code","type":"text","marks":[{"type":"code"}]},{"text":" together to acknowledge the creation of the new Service Initiation resource when provided with a valid request from the OFP.","type":"text"}]},{"type":"paragraph","content":[{"text":"The OFP MUST return a ","type":"text"},{"text":"201 Status Code","type":"text","marks":[{"type":"code"}]},{"text":" together to acknowledge the creation of the new Service Initiation resource when provided with a valid access token request from the TPP.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"1.4 Step 4: Access the Service Initiation Status","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"1.5.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 set the Content-Type as ","type":"text"},{"text":"application/jwt","type":"text","marks":[{"type":"code"}]},{"text":" when creating a Service Initiation resource with the OFP, together with the resource identifier from Step 3.","type":"text"}]},{"type":"paragraph","content":[{"text":"The OFP MUST respond with the TPP request with a signed JWT with a Service Initiation resource. This ensures non-repudiation for Service Initiation.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"2. Service Initiation Sequence Diagrams","type":"text"}]},{"type":"paragraph","content":[{"text":"All sequence diagrams relating to Bank Service Initiation are now available in the API Hub Documentation.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"3. Service Initiation Examples","type":"text"}]},{"type":"paragraph","content":[{"text":"The following are non-normative examples of API access and usage of the Service Initiation API.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.1 The TPP Redirects the User to Authorize the Service Initiation 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 service initiation consent details, and a UUID v4 which is a unique identifier for the Service Initiation consent.","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"PersonalIdentifiableInformation","type":"text","marks":[{"type":"code"}]},{"text":" field is a JWE that is encrypted by the LFI’s public key, so that only the LFI can decrypt it. It allows the TPP to transmit personal identifiable information (such as the ","type":"text"},{"text":"CreditorAccount","type":"text","marks":[{"type":"code"}]},{"text":" and personal information in the ","type":"text"},{"text":"Risk","type":"text","marks":[{"type":"code"}]},{"text":" object) to the LFI, without the OFP having to store this information in the consent object. The structure of the decrypted JWE is document in the ","type":"text"},{"text":"AEPaymentPII","type":"text","marks":[{"type":"code"}]},{"text":" schema in the OpenAPI document.","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\": \"openid payments\",\n \"state\": \"2616df22-899e-468b-b7af-927145b067cc\",\n \"authorization_details\": [\n {\n \"type\": \"urn:openfinanceuae:service-initiation-consent:v1.1\",\n \"consent\": {\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"IsSingleAuthorization\": true,\n \"AuthorizationExpirationDateTime\": \"2024-05-01T03:00:00.000Z\",\n \"ExpirationDateTime\": \"2024-10-01T00:00:00.000Z\",\n \"ControlParameters\": {\n \"ConsentSchedule\": {\n \"MultiPayment\": {\n \"MaximumCumulativeNumberOfPayments\": 10,\n \"PeriodicSchedule\": {\n \"Type\": \"VariablePeriodicSchedule\",\n \"PeriodType\": \"Day\",\n \"PeriodStartDate\": \"2024-05-01\",\n \"MaximumIndividualAmount\": {\n \"Amount\": \"100.00\",\n \"Currency\": \"AED\"\n }\n }\n }\n }\n },\n \"PersonalIdentifiableInformation\": \"eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ.UGhIOguC7...aQeF_PXwJZ4g.48V1_ALb6US04U3b.5eym5T...QzAAE=.XFBoMY...wifLw\",\n \"DebtorReference\": \"string\",\n \"CreditorReference\": \"string\",\n \"PaymentPurposeCode\": \"ABCD\"\n }\n }\n ]\n}","type":"text"}]},{"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.1/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=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzNkJoZFJrcXQzIiwiaWF0IjoxNjY5MzkzMTU0LCJleHAiOjE2NjkzOTM0OTYsIm5iZiI6MTY2OTM5MzE1NCwiYXVkIjoiaHR0cHM6Ly9zZXJ2ZXIuZXhhbXBsZS5jb20iLCJyZXNwb25zZV90eXBlIjoiY29kZSBpZF90b2tlbiIsInJlZGlyZWN0X3VyaSI6Imh0dHBzOi8vb3BlbmJhbmtpbmcubGZpLmFlL2F1dGgiLCJzY29wZSI6Im9wZW5pZCBhY2NvdW50cyIsInN0YXRlIjoiYWYwaWZqc2xka2oiLCJhdXRob3JpemF0aW9uX2RldGFpbHMiOlt7IlR5cGUiOiJBY2NvdW50QWNjZXNzQ29uc2VudCIsIkRhdGEiOnsiQWNjZXB0ZWRBdXRob3JpemF0aW9uVHlwZSI6IlVBRU9GLlNpbmdsZSIsIkF1dGhvcml6YXRpb25FeHBpcmF0aW9uVGltZVdpbmRvdyI6IjcyMDowMDowMCIsIkV4cGlyYXRpb25EYXRlVGltZSI6IjIwMjQtMTAtMDFUMDA6MDA6MDAuMDAwWiIsIkNvbnRyb2xQYXJhbWV0ZXJzIjp7IklzUGF5QnlBY2NvdW50IjpmYWxzZSwiQ29uc2VudFNjaGVkdWxlIjp7Ik11bHRpUGF5bWVudCI6eyJUeXBlIjoiVUFFT0YuRml4ZWRSZWN1cnJpbmdQYXltZW50IiwiVG90YWxOdW1iZXJPZlBheW1lbnRzIjoxMCwiUGVyaW9kaWNTY2hlZHVsZSI6eyJQZXJpb2RUeXBlIjoiRGF5IiwiUGVyaW9kU3RhcnREYXRlIjoiMjAyMy0xMC0wMSIsIkFtb3VudCI6eyJBbW91bnQiOiIxMDAuMDAiLCJDdXJyZW5jeSI6IkFFRCJ9fX19fSwiSW5pdGlhdGlvbiI6eyJEZWJ0b3JBY2NvdW50Ijp7IklkZW50aWZpY2F0aW9uVHlwZSI6IlVBRU9GLklCQU4iLCJJZGVudGlmaWNhdGlvbiI6InN0cmluZyIsIk5hbWUiOnsiZW4iOiJzdHJpbmciLCJhciI6InN0cmluZyJ9fSwiQ3JlZGl0b3JBY2NvdW50Ijp7IklkZW50aWZpY2F0aW9uVHlwZSI6IlVBRU9GLklCQU4iLCJJZGVudGlmaWNhdGlvbiI6InN0cmluZyIsIk5hbWUiOnsiZW4iOiJzdHJpbmciLCJhciI6InN0cmluZyJ9LCJUcmFkaW5nTmFtZSI6eyJlbiI6InN0cmluZyIsImFyIjoic3RyaW5nIn0sIkNyZWRpdG9yQWdlbnQiOiJTQVNBTUEifX0sIlBheWVyTm90ZXMiOiJzdHJpbmciLCJCZW5lZmljaWFyeUluZm9ybWF0aW9uIjp7Ik5vdGVzIjoic3RyaW5nIn0sIlBheW1lbnRQdXJwb3NlQ29kZSI6IkFCQ0QiLCJTcG9uc29yZWRUUFBJbmZvcm1hdGlvbiI6eyJOYW1lIjoic3RyaW5nIiwiSWRlbnRpZmljYXRpb24iOiJzdHJpbmcifX19XX0.Fsvm1_ffsLYqXMdLGy2Os6hMtNhXYPzFXiV8Mgd5dMs","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.4 The TPP Redirects the User to Their LFI with the Request URI to Authorize the Consent","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"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.5 The User Logs into Their LFI, Reviews and Authorizes the Consent","type":"text"}]},{"type":"paragraph","content":[{"text":"The LFI confirms the Service Initiation consent in the OFP.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"POST /auth/aac-69255d98-ab0e-4758-92a7-cacbf3073efa/rp/doConfirm\nhost: auth1.lab.openbanking.ae\nContent-Type: application/x-www-form-urlencoded\nDebtorAccount.SchemeName=IBAN\n&CreditorAccount.SchemeName=IBAN\n...","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.6 The LFI Returns an Authorization Code to the TPP","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"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.7 The TPP Exchanges the Authorization Code for an Service Initiation API Access Token with the OFP","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"POST /token HTTP/1.1\nHost: as1.lab.openbanking.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.8 The OFP Returns an Access Token, Refresh Token to the TPP","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"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 payments\",\n \"state\": \"2616df22-899e-468b-b7af-927145b067cc\",\n \"refresh_token\": \"266f5f15-eb81-4a02-bf05-e25063ca445f\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP can now initiate a Service Initiation resource using the access token.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.9 The TPP Initiates a Service Initiation Request with the OFP","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.9.1 Request: ","type":"text"},{"text":"payments","type":"text","marks":[{"type":"code"}]},{"text":" Resource","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"POST /open-finance/payment/v1.1/payments HTTP/1.1\nHost: rs1.openfinanceplatform.ae\nContent-Type: application/jwt\nAccept: application/jwt\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\nx-idempotency-key: 78dae4513b8847f98e2d4173b4ed0eb6\nAuthorization: Bearer caa1b60d-61ff-4cd8-a4e1-2d18c8696de0\n{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 0.5,\n \"nbf\": 0.5,\n \"aud\": [\n \"string\"\n ],\n \"iat\": 0.5,\n \"message\": {\n \"Data\": {\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"Instruction\": {\n \"Amount\": {\n \"Amount\": \"100.00\",\n \"Currency\": \"AED\"\n },\n \"PaymentSequenceNumber\": \"1\"\n },\n \"PaymentPurposeCode\": \"ABCD\",\n \"DebtorReference\": \"string\",\n \"CreditorReference\": \"string\",\n \"OpenFinanceBilling\": {\n \"Type\": \"PushP2P\"\n }\n }\n }\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.9.2 Response: ","type":"text"},{"text":"payments","type":"text","marks":[{"type":"code"}]},{"text":" Resource","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"HTTP/1.1 201 Created\nContent-Type: application/jwt\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\n{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 0.5,\n \"nbf\": 0.5,\n \"aud\": [\n \"string\"\n ],\n \"iat\": 0.5,\n \"message\": {\n \"Data\": {\n \"PaymentId\": \"83b47199-90c2-4c05-9ef1-aeae68b0fc7c\",\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"PaymentTransactionId\": \"string\",\n \"Status\": \"Pending\",\n \"StatusUpdateDateTime\": \"2024-05-01T00:00:00.000Z\",\n \"CreationDateTime\": \"2024-05-01T00:00:00.000Z\",\n \"DebtorCharges\": [\n {\n \"Type\": \"VAT\",\n \"Amount\": {\n \"Amount\": \"100.00\",\n \"Currency\": \"AED\"\n }\n }\n ],\n \"Instruction\": {\n \"Amount\": {\n \"Amount\": \"100.00\",\n \"Currency\": \"AED\"\n },\n \"PaymentSequenceNumber\": \"1\"\n },\n \"PaymentPurposeCode\": \"ABCD\",\n \"DebtorReference\": \"string\",\n \"CreditorReference\": \"string\",\n \"OpenFinanceBilling\": {\n \"Type\": \"PushP2P\"\n }\n },\n \"Links\": {\n \"Self\": \"/payments/83b47199-90c2-4c05-9ef1-aeae68b0fc7c\",\n \"Related\": \"/payment-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa\"\n },\n \"Meta\": {}\n }\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3.10 The TPP Retrieves the Service Initiation Status from the OFP Using the Resource Identifier","type":"text"}]},{"type":"paragraph","content":[{"text":"Get the Service Initiation Status from the OFP as a JWT response","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.10.1 Request: /payments/{","type":"text"},{"text":"PaymentId","type":"text","marks":[{"type":"code"}]},{"text":"} Resource","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"GET /open-finance/payment/v1.1/payments/83b47199-90c2-4c05-9ef1-aeae68b0fc7c HTTP/1.1\nHost: rs1.openfinanceplatform.ae\nAccept: application/jwt\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\nAuthorization: Bearer ad297304-1057-4c68-9e76-a96f300a27f1","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.10.2 Response: /payments/{","type":"text"},{"text":"PaymentId","type":"text","marks":[{"type":"code"}]},{"text":"} Resource","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/jwt\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\n{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 0.5,\n \"nbf\": 0.5,\n \"aud\": [\n \"string\"\n ],\n \"iat\": 0.5,\n \"message\": {\n \"Data\": {\n \"PaymentId\": \"83b47199-90c2-4c05-9ef1-aeae68b0fc7c\",\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"PaymentTransactionId\": \"string\",\n \"Status\": \"Pending\",\n \"StatusUpdateDateTime\": \"2024-05-01T00:00:00.000Z\",\n \"CreationDateTime\": \"2024-05-01T00:00:00.000Z\",\n \"DebtorCharges\": [\n {\n \"Type\": \"VAT\",\n \"Amount\": {\n \"Amount\": \"100.00\",\n \"Currency\": \"AED\"\n }\n }\n ],\n \"Instruction\": {\n \"Amount\": {\n \"Amount\": \"100.00\",\n \"Currency\": \"AED\"\n },\n \"PaymentSequenceNumber\": \"1\"\n },\n \"PaymentPurposeCode\": \"ABCD\",\n \"DebtorReference\": \"string\",\n \"CreditorReference\": \"string\",\n \"OpenFinanceBilling\": {\n \"Type\": \"PushP2P\"\n }\n },\n \"Links\": {\n \"Self\": \"/payments/83b47199-90c2-4c05-9ef1-aeae68b0fc7c\",\n \"Related\": \"/payment-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa\"\n },\n \"Meta\": {}\n }\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"4. Further Service Initiation Examples","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4.1 The TPP Queries the Service Initiation Resource Using an Expired Access Token","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.1.1 Request: payments/{","type":"text"},{"text":"PaymentId","type":"text","marks":[{"type":"code"}]},{"text":"} Resource","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"GET /open-finance/payment/v1.1/payments/83b47199-90c2-4c05-9ef1-aeae68b0fc7c HTTP/1.1\nHost: rs1.openfinanceplatform.ae\nAccept: application/jwt\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\nAuthorization: Bearer ad297304-1057-4c68-9e76-a96f300a27f1","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.1.2 Response: payments/{","type":"text"},{"text":"PaymentId","type":"text","marks":[{"type":"code"}]},{"text":"} Resource","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 401 Unauthorized\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\nContent-Type: application/jwt\n{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 0,\n \"nbf\": 0,\n \"aud\": [\n \"string\"\n ],\n \"iat\": 0,\n \"message\": {\n \"Errors\": [\n {\n \"Code\": \"AccessToken.Unauthorized\",\n \"Message\": \"max_age_exceeded: Token has expired\",\n \"Path\": \"Authorization\",\n \"Url\": \"https://developer.openfinanceplatform.ae/api-errros/401\"\n }\n ]\n }\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4.2 Webhooks","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.2.1 The TPP Creates a Service Initiation Consent Request on Behalf of the User with a Webhook Subscription","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.2.1.1 Request: Service Initiation 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\": \"openid payments\",\n \"state\": \"af0ifjsldkj\",\n \"authorization_details\": [\n {\n \"type\": \"urn:openfinanceuae:service-initiation-consent:v1.1\",\n \"consent\": {\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"IsSingleAuthorization\": true,\n \"AuthorizationExpirationDateTime\": \"2024-05-01T03:00:00.000Z\",\n \"ExpirationDateTime\": \"2024-10-01T00:00:00.000Z\",\n \"ControlParameters\": {\n \"ConsentSchedule\": {\n \"MultiPayment\": {\n \"MaximumCumulativeNumberOfPayments\": 10,\n \"PeriodicSchedule\": {\n \"Type\": \"VariablePeriodicSchedule\",\n \"PeriodType\": \"Day\",\n \"PeriodStartDate\": \"2024-05-01\",\n \"MaximumIndividualAmount\": {\n \"Amount\": \"100.00\",\n \"Currency\": \"AED\"\n }\n }\n }\n }\n },\n \"PersonalIdentifiableInformation\": \"eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ.UGhIOguC7...aQeF_PXwJZ4g.48V1_ALb6US04U3b.5eym5T...QzAAE=.XFBoMY...wifLw\",,\n \"DebtorReference\": \"string\",\n \"CreditorReference\": \"string\",\n \"PaymentPurposeCode\": \"ABCD\"\n },\n \"Subscription\": {\n \"Webhook\": {\n \"Url\": \"https://api.tpp.com/webhook/callbackUrl\",\n \"IsActive\": true\n }\n }\n }\n }\n ]\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.2.2 The TPP updates a Webhook Subscription preference with the OFP","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.2.2.1 Request: Activate Webhook events","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"PATCH /open-finance/payment/v1.1/payment-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa HTTP/1.1\nHost: rs1.lab.api.openbanking.ae\nContent-Type: application/jwt\nAccept: application/jwt\nx-fapi-interaction-id: 3424a379-8274-4686-99bd-f420d08acead\nAuthorization: Bearer ad297304-1057-4c68-9e76-a96f300a27f1\n{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 0,\n \"nbf\": 0,\n \"aud\": [\n \"string\"\n ],\n \"iat\": 0,\n \"message\": {\n \"Subscription\": {\n \"Webhook\": {\n \"IsActive\": true\n }\n }\n }\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.2.2.2 Response: Webhook events activated","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"x-fapi-interaction-id: 3424a379-8274-4686-99bd-f420d08acead\nHTTP/1.1 204 No Content","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.2.3 The TPP unsubscribes their Webhook Subscription with the OFP","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.2.3.1 Request: De-Activate Webhook events","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"PATCH /open-finance/payment/v1.1/payment-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa HTTP/1.1\nHost: rs1.lab.api.openbanking.ae\nContent-Type: application/jwt\nx-fapi-interaction-id: 3424a379-8274-4686-99bd-f420d08acead\nAuthorization: Bearer ad297304-1057-4c68-9e76-a96f300a27f1\n{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 0,\n \"nbf\": 0,\n \"aud\": [\n \"string\"\n ],\n \"iat\": 0,\n \"message\": {\n \"Subscription\": {\n \"Webhook\": {\n \"IsActive\": false\n }\n }\n }\n}\n.\n<>\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.2.3.2 Response: Webhook events de-activated","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"x-fapi-interaction-id: 3424a379-8274-4686-99bd-f420d08acead\nHTTP/1.1 204 No Content","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.2.4 The TPP receives Service Initiation Consent data from the OFP via its Webhook","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.2.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","attrs":{"language":"shell"},"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.pisp.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.2.4.2 Request: OFP publishes signed/encrypted Service Initiation 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","attrs":{"language":"shell"},"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","attrs":{"language":"shell"},"content":[{"text":"{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 0.5,\n \"nbf\": 0.5,\n \"aud\": [\n \"string\"\n ],\n \"iat\": 0.5,\n \"message\": {\n \"Data\": {\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"BaseConsentId\": \"abc-19877d98-ab0e-4758-92a7-vvffr1234abv\",\n \"IsSingleAuthorization\": true,\n \"AuthorizationExpirationDateTime\": \"2024-05-01T03:00:00.000Z\",\n \"ExpirationDateTime\": \"2024-10-01T00:00:00.000Z\",\n \"ConsentStatus\": \"AwaitingAuthorization\",\n \"ConsentStatusUpdateDateTime\": \"2024-05-01T00:00:00.000Z\",\n \"CreationDateTime\": \"2024-05-01T00:00:00.000Z\",\n \"ControlParameters\": {\n \"ConsentSchedule\": {\n \"MultiPayment\": {\n \"MaximumCumulativeNumberOfPayments\": 10,\n \"PeriodicSchedule\": {\n \"Type\": \"VariablePeriodicSchedule\",\n \"PeriodType\": \"Day\",\n \"PeriodStartDate\": \"2024-05-01\",\n \"MaximumIndividualAmount\": {\n \"Amount\": \"100.00\",\n \"Currency\": \"AED\"\n }\n }\n }\n }\n },\n \"PersonalIdentifiableInformation\": \"eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ.UGhIOguC7...aQeF_PXwJZ4g.48V1_ALb6US04U3b.5eym5T...QzAAE=.XFBoMY...wifLw\",,\n \"DebtorReference\": \"string\",\n \"CreditorReference\": \"string\",\n \"PaymentPurposeCode\": \"ABCD\",\n \"PaymentConsumption\": {\n \"CumulativeValueOfPayments\": {\n \"Amount\": \"1000.00\",\n \"Currency\": \"AED\"\n },\n \"CumulativeNumberOfPayments\": 10\n }\n },\n \"Links\": {\n \"Self\": \"/payment-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"Related\": []\n },\n \"EventMeta\": {\n \"EventDateTime\": \"2024-05-01T00:00:00.000Z\",\n \"EventResource\": \"\"/payment-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"EventType\": \"Resource.Created\",\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\"\n }\n }\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"4.2.4.3 Response: TPP validates the Self Signed JWT Authorization Token from OFP, stores Payment consent data and acknowledges a success response to the OFP","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"x-fapi-interaction-id: 77b0e830-b095-4c6c-94e8-20f83eaa799f\nHTTP/1.1 202 Accepted","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4.3 Multiple Authorizations","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.3.1 Request: Service Initiation consent resource requesting Multi-Authorization","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP creates a Service Initiation consent with ","type":"text"},{"text":"IsSingleAuthorization","type":"text","marks":[{"type":"code"}]},{"text":" as ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":" denoting its support for a Multi-Authorization consent.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"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\": \"openid payments\",\n \"state\": \"af0ifjsldkj\",\n \"authorization_details\": [\n {\n \"type\": \"urn:openfinanceuae:service-initiation-consent:v1.1\",\n \"consent\": {\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"IsSingleAuthorization\": false,\n \"AuthorizationExpirationDateTime\": \"2024-05-01T03:00:00.000Z\",\n \"ExpirationDateTime\": \"2024-10-01T00:00:00.000Z\",\n \"ControlParameters\": {\n \"ConsentSchedule\": {\n \"MultiPayment\": {\n \"MaximumCumulativeNumberOfPayments\": 10,\n \"PeriodicSchedule\": {\n \"Type\": \"VariablePeriodicSchedule\",\n \"PeriodType\": \"Day\",\n \"PeriodStartDate\": \"2024-05-01\",\n \"MaximumIndividualAmount\": {\n \"Amount\": \"100.00\",\n \"Currency\": \"AED\"\n }\n }\n }\n }\n },\n \"PersonalIdentifiableInformation\": \"eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ.UGhIOguC7...aQeF_PXwJZ4g.48V1_ALb6US04U3b.5eym5T...QzAAE=.XFBoMY...wifLw\",,\n \"DebtorReference\": \"string\",\n \"CreditorReference\": \"string\",\n \"PaymentPurposeCode\": \"ABCD\"\n }\n }\n ]\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4.4 The TPP Queries the existence of a Service Initiation Resource Using the X-Idempotency-Key","type":"text"}]},{"type":"paragraph","content":[{"text":"This is a negative scenario whereby the OFP fails to return any ","type":"text"},{"text":"payments","type":"text","marks":[{"type":"code"}]},{"text":" response and the TPP has no way of identifying the resource ","type":"text"},{"text":"PaymentId","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"PaymentId","type":"text","marks":[{"type":"code"}]},{"text":" is returned within the HTTP ","type":"text"},{"text":"Location","type":"text","marks":[{"type":"code"}]},{"text":" Header URL under the ","type":"text"},{"text":"/payments","type":"text","marks":[{"type":"code"}]},{"text":" resource.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.4.1 Request to /payments Resource","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"HEAD /open-finance/payment/v1.1/payments HTTP/1.1\nHost: rs1.lab.api.openbanking.ae\nAccept: application/jwt\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\nAuthorization: Bearer ad297304-1057-4c68-9e76-a96f300a27f1\nx-idempotency-key: 78dae4513b8847f98e2d4173b4ed0eb6","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.4.2 Response to /payments Resource","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"HTTP/1.1 204 No Content\nx-fapi-interaction-id: 3424a379-8274-4686-99bd-f420d08acead\nLocation: /open-finance/payment/v1.1/payments/83b47199-90c2-4c05-9ef1-aeae68b0fc7c","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4.5 The TPP Initiates a Bulk File Payment","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.5.1 Request: TPP Uses RAR (Rich Authorization Request) to Request Initial Base Consent","type":"text"}]},{"type":"paragraph","content":[{"text":"The authorization_details contain the User’s service initiation consent details, and a UUID v4 which is a unique identifier for the Service Initiation 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\": \"openid payments\",\n \"state\": \"2616df22-899e-468b-b7af-927145b067cc\",\n \"authorization_details\": [\n {\n \"type\": \"urn:openfinanceuae:service-initiation-consent:v1.1\",\n \"consent\": {\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"IsSingleAuthorization\": true,\n \"AuthorizationExpirationDateTime\": \"2024-05-01T03:00:00.000Z\",\n \"ExpirationDateTime\": \"2024-10-01T00:00:00.000Z\",\n \"ControlParameters\": {\n \"ConsentSchedule\": {\n \"FilePayment\": {\n \"FileType\": \"pain.001.001.08\",\n \"FileHash\": \"m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ\",\n \"NumberOfTransactions\": 5,\n \"ControlSum\": \"10003.40\"\n }\n }\n }\n }\n }\n ]\n}","type":"text"}]},{"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.1/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.eyJpc3MiOiJzNkJoZFJrcXQzIiwiYXVkIjoiaHR0cHM6Ly9zZXJ2ZXIuZXhhbXBsZS5jb20iLCJyZXNwb25zZV90eXBlIjoiY29kZSIsInJlZGlyZWN0X3VyaSI6Imh0dHBzOi8vb3BlbmJhbmtpbmcudHBwMS5hZS9zaW1wbGUtcmVkaXJlY3QtdXJsIiwic2NvcGUiOiJvcGVuaWQgcGF5bWVudHMiLCJzdGF0ZSI6IjI2MTZkZjIyLTg5OWUtNDY4Yi1iN2FmLTkyNzE0NWIwNjdjYyIsImF1dGhvcml6YXRpb25fZGV0YWlscyI6W3sidHlwZSI6InVybjpvcGVuZmluYW5jZXVhZTpzZXJ2aWNlLWluaXRpYXRpb24tY29uc2VudDp2MS4wLWRyYWZ0MyIsImNvbnNlbnQiOnsiQ29uc2VudElkIjoiYWFjLTY5MjU1ZDk4LWFiMGUtNDc1OC05MmE3LWNhY2JmMzA3M2VmYSIsIkFjY2VwdGVkQXV0aG9yaXphdGlvblR5cGUiOiJVQUVPRi5TaW5nbGUiLCJBdXRob3JpemF0aW9uRXhwaXJhdGlvblRpbWVXaW5kb3ciOiI3MjA6MDA6MDAiLCJFeHBpcmF0aW9uRGF0ZVRpbWUiOiIyMDI0LTEwLTAxVDAwOjAwOjAwLjAwMFoiLCJDb250cm9sUGFyYW1ldGVycyI6eyJJc1BheUJ5QWNjb3VudCI6ZmFsc2UsIkNvbnNlbnRTY2hlZHVsZSI6eyJGaWxlUGF5bWVudCI6eyJGaWxlVHlwZSI6IlVBRU9GLnBhaW4uMDAxLjAwMS4wOCIsIkZpbGVIYXNoIjoibTVhaC9oMVVqTHZKWU14cUFvWm1qOWRLZGpabnNHTm0reU1rSnAvS3VxUSIsIk51bWJlck9mVHJhbnNhY3Rpb25zIjo1LCJDb250cm9sU3VtIjoiMTAwMDMuNDAifX19fX1dfQ.RnWw0gKOQNb8D0nYvaduiYURhFmIx-gnK6awBg_gF80","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.5.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":3},"content":[{"text":"4.5.3 The TPP Uploads File Payment","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /open-finance/payment/v1.1/payment-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa/file HTTP/1.1\nAuthorization: Bearer ad297304-1057-4c68-9e76-a96f300a27f1\nContent-Type: text/xml\nAccept: application/json\n\n[File-Data]","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.5.4 The TPP Redirects the User to Their LFI with the Request URI to Authorize the Consent","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"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":3},"content":[{"text":"4.5.5 The User Logs into Their LFI, Reviews and Authorizes the Consent","type":"text"}]},{"type":"paragraph","content":[{"text":"The LFI confirms the Service Initiation consent in the OFP.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"POST /auth/aac-69255d98-ab0e-4758-92a7-cacbf3073efa/rp/doConfirm\nhost: auth1.lab.openbanking.ae\nContent-Type: application/x-www-form-urlencoded\n...","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.5.6 The LFI Returns an Authorization Code to the TPP","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"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":3},"content":[{"text":"4.5.7 The TPP Exchanges the Authorization Code for an Service Initiation API Access Token with the OFP","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"POST /token HTTP/1.1\nHost: as1.lab.openbanking.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":3},"content":[{"text":"4.5.8 The OFP Returns an Access Token, Refresh Token to the TPP","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"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 payments\",\n \"state\": \"2616df22-899e-468b-b7af-927145b067cc\",\n \"refresh_token\": \"266f5f15-eb81-4a02-bf05-e25063ca445f\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP can now initiate a Service Initiation resource using the access token.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.5.9 The TPP Initiates a Service Initiation Request with the OFP","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.5.9.1 Request: ","type":"text"},{"text":"file-payments","type":"text","marks":[{"type":"code"}]},{"text":" Resource","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"POST /open-finance/payment/v1.1/file-payments HTTP/1.1\nHost: rs1.openfinanceplatform.ae\nContent-Type: application/jwt\nAccept: application/jwt\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\nx-idempotency-key: 78dae4513b8847f98e2d4173b4ed0eb6\nAuthorization: Bearer caa1b60d-61ff-4cd8-a4e1-2d18c8696de0\n{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 0.5,\n \"nbf\": 0.5,\n \"aud\": [\n \"string\"\n ],\n \"iat\": 0.5,\n \"message\": {\n \"Data\": {\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"Instruction\": {\n \"FileType\": \"pain.001.001.08\",\n \"FileHash\": \"m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ\",\n \"NumberOfTransactions\": 5,\n \"ControlSum\": \"10003.40\"\n },\n \"PaymentPurposeCode\": \"ABCD\",\n \"DebtorReference\": \"string\"\n }\n }\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.5.8.2 Response: ","type":"text"},{"text":"file-payments","type":"text","marks":[{"type":"code"}]},{"text":" Resource","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"HTTP/1.1 201 Created\nContent-Type: application/jwt\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\n{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 0.5,\n \"nbf\": 0.5,\n \"aud\": [\n \"string\"\n ],\n \"iat\": 0.5,\n \"message\": {\n \"Data\": {\n \"PaymentId\": \"83b47199-90c2-4c05-9ef1-aeae68b0fc7c\",\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"PaymentTransactionId\": \"string\",\n \"Status\": \"Received\",\n \"StatusUpdateDateTime\": \"2024-05-01T00:00:00.000Z\",\n \"CreationDateTime\": \"2024-05-01T00:00:00.000Z\",\n \"Instruction\": {\n \"FileType\": \"pain.001.001.08\",\n \"FileHash\": \"m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ\",\n \"NumberOfTransactions\": 5,\n \"ControlSum\": \"10003.40\"\n },\n \"PaymentPurposeCode\": \"ABCD\",\n \"DebtorReference\": \"string\"\n },\n \"Links\": {\n \"Self\": \"/file-payments/83b47199-90c2-4c05-9ef1-aeae68b0fc7c\",\n \"Related\": \"/payment-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa\"\n },\n \"Meta\": {}\n }\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4.6 The TPP Requests Refund Account Details","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.6.1 Request: payment-consents/{","type":"text"},{"text":"ConsentId","type":"text","marks":[{"type":"code"}]},{"text":"}/refund Resource","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"GET /open-finance/payment/v1.1/payment-consents/83b47199-90c2-4c05-9ef1-aeae68b0fc7c/refund HTTP/1.1\nHost: rs1.openfinanceplatform.ae\nAccept: application/jwt\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\nAuthorization: Bearer ad297304-1057-4c68-9e76-a96f300a27f1","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.6.2 Response: payment-consents/{","type":"text"},{"text":"ConsentId","type":"text","marks":[{"type":"code"}]},{"text":"}/refund Resource","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/jwt\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\n{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 0.5,\n \"nbf\": 0.5,\n \"aud\": [\n \"string\"\n ],\n \"iat\": 0.5,\n \"message\": {\n \"Data\": {\n \"BaseConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"RefundAccount\": {\n \"SchemeName\": \"IBAN\",\n \"Identification\": \"string\",\n \"Name\": {\n \"en\": \"string\",\n \"ar\": \"string\"\n }\n },\n \"Links\": {\n \"Self\": \"/payment-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa/refund\"\n },\n \"Meta\": {}\n }\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4.7 The TPP Uses the ","type":"text"},{"text":"BaseConsentId","type":"text","marks":[{"type":"code"}]},{"text":" to Link Consents","type":"text"}]},{"type":"paragraph","content":[{"text":"A TPP may update the parameters of an existing consent, by (1) revoking the existing consent, and (2) creating a new consent for the User with the new agreed consent parameters. The ","type":"text"},{"text":"BaseConsentId","type":"text","marks":[{"type":"code"}]},{"text":" allows TPPs to chain and link consents together, so that there is a history of linked consents.","type":"text"}]},{"type":"paragraph","content":[{"text":"This flow gives an example of how a TPP will link consents together.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.7.1 TPP Creates a new Consent as the Base Consent","type":"text"}]},{"type":"paragraph","content":[{"text":"The authorization_details contain the User’s service initiation consent details, and a UUID v4 which is a unique identifier for the Service Initiation 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\": \"openid payments\",\n \"state\": \"2616df22-899e-468b-b7af-927145b067cc\",\n \"authorization_details\": [\n {\n \"type\": \"urn:openfinanceuae:service-initiation-consent:v1.1\",\n \"consent\": {\n \"BaseConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"ConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"IsSingleAuthorization\": true,\n \"AuthorizationExpirationDateTime\": \"2024-05-01T03:00:00.000Z\",\n \"ExpirationDateTime\": \"2024-10-01T00:00:00.000Z\",\n \"ControlParameters\": {\n \"ConsentSchedule\": {\n \"MultiPayment\": {\n \"MaximumCumulativeNumberOfPayments\": 10,\n \"PeriodicSchedule\": {\n \"Type\": \"VariablePeriodicSchedule\",\n \"PeriodType\": \"Day\",\n \"PeriodStartDate\": \"2024-05-01\",\n \"MaximumIndividualAmount\": {\n \"Amount\": \"100.00\",\n \"Currency\": \"AED\"\n }\n }\n }\n }\n } \n }\n ]\n}","type":"text"}]},{"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.1/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.eyJpc3MiOiJzNkJoZFJrcXQzIiwiYXVkIjoiaHR0cHM6Ly9zZXJ2ZXIuZXhhbXBsZS5jb20iLCJyZXNwb25zZV90eXBlIjoiY29kZSIsInJlZGlyZWN0X3VyaSI6Imh0dHBzOi8vb3BlbmJhbmtpbmcudHBwMS5hZS9zaW1wbGUtcmVkaXJlY3QtdXJsIiwic2NvcGUiOiJvcGVuaWQgcGF5bWVudHMiLCJzdGF0ZSI6IjI2MTZkZjIyLTg5OWUtNDY4Yi1iN2FmLTkyNzE0NWIwNjdjYyIsImF1dGhvcml6YXRpb25fZGV0YWlscyI6W3sidHlwZSI6InVybjpvcGVuZmluYW5jZXVhZTpzZXJ2aWNlLWluaXRpYXRpb24tY29uc2VudDp2MS4wLWRyYWZ0MyIsImNvbnNlbnQiOnsiQ29uc2VudElkIjoiYWFjLTY5MjU1ZDk4LWFiMGUtNDc1OC05MmE3LWNhY2JmMzA3M2VmYSIsIkFjY2VwdGVkQXV0aG9yaXphdGlvblR5cGUiOiJVQUVPRi5TaW5nbGUiLCJBdXRob3JpemF0aW9uRXhwaXJhdGlvblRpbWVXaW5kb3ciOiI3MjA6MDA6MDAiLCJFeHBpcmF0aW9uRGF0ZVRpbWUiOiIyMDI0LTEwLTAxVDAwOjAwOjAwLjAwMFoiLCJDb250cm9sUGFyYW1ldGVycyI6eyJJc1BheUJ5QWNjb3VudCI6ZmFsc2UsIkNvbnNlbnRTY2hlZHVsZSI6eyJGaWxlUGF5bWVudCI6eyJGaWxlVHlwZSI6IlVBRU9GLnBhaW4uMDAxLjAwMS4wOCIsIkZpbGVIYXNoIjoibTVhaC9oMVVqTHZKWU14cUFvWm1qOWRLZGpabnNHTm0reU1rSnAvS3VxUSIsIk51bWJlck9mVHJhbnNhY3Rpb25zIjo1LCJDb250cm9sU3VtIjoiMTAwMDMuNDAifX19fX1dfQ.RnWw0gKOQNb8D0nYvaduiYURhFmIx-gnK6awBg_gF80","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.7.2 Standard Authorization Flow","type":"text"}]},{"type":"paragraph","content":[{"text":"The standard authorization flow proceeds with the User authorizing the consent. The TPP now has a valid consent in an ","type":"text"},{"text":"Authorized","type":"text","marks":[{"type":"code"}]},{"text":" state.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.7.3 Alternative Flow - the TPP may Revoke the Existing Consent","type":"text"}]},{"type":"paragraph","content":[{"text":"In the scenario that the TPP wants to update the consent parameters in the original consent - the TPP would take steps to:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Revoke the original consent","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a new consent that the User would authorise this new consent (as per 4.7.1)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the TPP would like to link the original consent with the new consent - the TPP would populate the ","type":"text"},{"text":"BaseConsentId","type":"text","marks":[{"type":"code"}]},{"text":" with the ","type":"text"},{"text":"BaseConsentId","type":"text","marks":[{"type":"code"}]},{"text":" of the original consent","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.7.3.1 TPP Revokes Original Consent","type":"text"}]},{"type":"codeBlock","content":[{"text":"PATCH /open-finance/payment/v1.1/payment-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa HTTP/1.1\nHost: rs1.openfinanceplatform.ae\nContent-Type: application/jwt\nAccept: application/jwt\nx-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602\nx-idempotency-key: 78dae4513b8847f98e2d4173b4ed0eb6\nAuthorization: Bearer caa1b60d-61ff-4cd8-a4e1-2d18c8696de0\n{\n \"alg\": \"PS256\",\n \"kid\": \"e1be6bf3-76e6-4e53-92b9-c46423757ab1\"\n}\n.\n{\n \"iss\": \"string\",\n \"exp\": 0.5,\n \"nbf\": 0.5,\n \"aud\": [\n \"string\"\n ],\n \"iat\": 0.5,\n \"message\": {\n \"Data\": {\n \"Status\": \"Revoked\"\n }\n }\n}\n.\n<>","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.5.3.2 TPP Creates a new Consent with the same ","type":"text"},{"text":"BaseConsentId","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"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\": \"openid payments\",\n \"state\": \"00e8460b-167e-44b9-a9d1-e1f79d998d27\",\n \"authorization_details\": [\n {\n \"type\": \"urn:openfinanceuae:service-initiation-consent:v1.1\",\n \"consent\": {\n \"BaseConsentId\": \"aac-69255d98-ab0e-4758-92a7-cacbf3073efa\",\n \"ConsentId\": \"28ec6225-d9f4-4d8a-8904-bb62ce7e6cff\",\n \"IsSingleAuthorization\": true,\n \"ControlParameters\": {\n \"ConsentSchedule\": {\n \"MultiPayment\": {\n \"PeriodicSchedule\": {\n \"Type\": \"VariablePeriodicSchedule\",\n \"PeriodType\": \"Day\",\n \"PeriodStartDate\": \"2024-07-01\",\n \"MaximumIndividualAmount\": {\n \"Amount\": \"200.00\",\n \"Currency\": \"AED\"\n }\n }\n }\n }\n } \n }\n ]\n}","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"5. Open API Specification","type":"text"}]},{"type":"paragraph","content":[{"text":"See the ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://openfinanceuae.atlassian.net/wiki/spaces/standardsv1dot2draft1/pages/266374725"}},{"text":" ","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"page.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"6. Service Initiation Notes","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"6.1 Staging a Service Initiation Consent","type":"text"}]},{"type":"paragraph","content":[{"text":"To manage the creation and execution of a Single Instant payment;","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST provide a ","type":"text"},{"text":"ConsentId","type":"text","marks":[{"type":"code"}]},{"text":" in the Consent object within the ","type":"text"},{"text":"authorization_details","type":"text","marks":[{"type":"code"}]},{"text":" of a Rich Authorization Request.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST include the response from the Confirmation operation at the Confirmation of Payee API in the property ","type":"text"},{"text":"ConfirmationOfPayeeResponse","type":"text","marks":[{"type":"code"}]},{"text":" when Confirmation of Payee has been performed by the TPP for the ","type":"text"},{"text":"CreditorAccount","type":"text","marks":[{"type":"code"}]},{"text":" details. This property must be included in the value of the JWE created to populate the property ","type":"text"},{"text":"PersonalIdentifiableInformation","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MAY use ","type":"text"},{"text":"PATCH","type":"text","marks":[{"type":"code"}]},{"text":" to manage any Webhook configurations for the entire duration of a payment consent.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MAY use a ","type":"text"},{"text":"GET","type":"text","marks":[{"type":"code"}]},{"text":" to the ","type":"text"},{"text":"/payments/{PaymentId}","type":"text","marks":[{"type":"code"}]},{"text":" resource to poll for Payment Statuses.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The OFP:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST reject the Service Initiation consent if a globally unique UUID v4 ","type":"text"},{"text":"ConsentId","type":"text","marks":[{"type":"code"}]},{"text":" does not exist in the RAR object.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST validate the Consent parameters and create a Consent resource (","type":"text"},{"text":"ConsentId","type":"text","marks":[{"type":"code"}]},{"text":") that is ","type":"text"},{"text":"AwaitingAuthorization","type":"text","marks":[{"type":"code"}]},{"text":" when a valid RAR object is staged at the PAR endpoint.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST immediately stage the payment with the LFI once a valid Service Initiation resource is created by the TPP.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST send payment status events to the TPP if an active Webhook Subscription is registered within the Consent object.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The LFI:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST immediately stage the payment with the Payment Rails once a valid payment is staged by the OFP.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST emit payment status events to the OFP.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"6.2 Service Initiation Consent Parameters","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"6.2.1 Single Payment Consent Parameters","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"6.2.1.1 Single Instant Payment","type":"text"}]},{"type":"paragraph","content":[{"text":"A Single Instant Payment MUST meet the following criteria:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"code"}]},{"text":" MUST be set to ","type":"text"},{"text":"SingleInstantPayment","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Consent Start date is the ","type":"text"},{"text":"CreationDateTime","type":"text","marks":[{"type":"code"}]},{"text":". The Consent end date (","type":"text"},{"text":"ExpirationDateTime","type":"text","marks":[{"type":"code"}]},{"text":") MUST be set to the current date.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"6.2.1.2 Single Future Dated Payment","type":"text"}]},{"type":"paragraph","content":[{"text":"A Single Future Dated Payment MUST meet the following criteria:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"code"}]},{"text":" MUST be set to ","type":"text"},{"text":"SingleFutureDatedPayment","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Consent Start date is the ","type":"text"},{"text":"CreationDateTime","type":"text","marks":[{"type":"code"}]},{"text":". The Consent end date (","type":"text"},{"text":"ExpirationDateTime","type":"text","marks":[{"type":"code"}]},{"text":") MUST NOT exceed 1 year from the current date. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RequestedExecutionDate","type":"text","marks":[{"type":"code"}]},{"text":" MUST NOT be set to the current day. It MUST be set to a future date/time beyond the current day when the payment is to be scheduled for execution.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"6.2.2 Multi-Payment Consent Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"These consent parameters are defined to control the limits for a long lived Multi-Payment consent:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MaximumCumulativeValueOfPayments","type":"text","marks":[{"type":"code"}]},{"text":" MUST be set to confirm the total payment amount for the whole consent duration. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MaximumCumulativeNumberOfPayments","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"MUST be set to confirm the total number of payments for the whole consent duration.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"PeriodicSchedule","type":"text","marks":[{"type":"code"}]},{"text":" MAY further define any period specific maximum payment numbers and/or amounts, and is one of these Types:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FixedDefinedSchedule","type":"text","marks":[{"type":"code"}]},{"text":" - a Payment Schedule denoting a list of pre-defined future dated payments each with a fixed amount and date.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"VariableDefinedSchedule","type":"text","marks":[{"type":"code"}]},{"text":" - a Payment Schedule denoting a list of pre-defined future dated payments each with a fixed date and maximum amount.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FixedPeriodicSchedule","type":"text","marks":[{"type":"code"}]},{"text":" - The payments for this consent have a fixed amount and must be executed only on the PeriodStartDate, and dates recurring based on the PeriodType.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"VariablePeriodicSchedule","type":"text","marks":[{"type":"code"}]},{"text":" - The payments for this consent have a variable amount and must be executed only on the PeriodStartDate, and dates recurring based on the PeriodType.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FixedOnDemand","type":"text","marks":[{"type":"code"}]},{"text":" - The payments for this consent have a fixed amount and may be executed on any date, as long as they are within the Controls for a PeriodType.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"VariableOnDemand","type":"text","marks":[{"type":"code"}]},{"text":" - The payments for this consent have a variable amount and may be executed on any date, as long as they are within the Controls for a PeriodType.","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"6.2.3 Combined Payment Consent Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"A Combined Service Initiation MUST be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Any one Type of Single Payment","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Any one Type of Multi-Payment","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"6.2.4 File Payment Consent Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"A File Payment consent MUST contain these metadata fields of the file being uploaded:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FileType","type":"text","marks":[{"type":"code"}]},{"text":" MUST be set to the file payment type that is accepted by the LFI.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FileHash","type":"text","marks":[{"type":"code"}]},{"text":" MUST be set to the base64 encoding of a SHA256 hash of the file to be uploaded. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"NumberOfTransactions","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"MUST be set to the number of payments contained in the file.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ControlSum","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"MUST be set to the total of all individual amounts included in the file, irrespective of currencies.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"6.3 OFP Service Initiation Responsibilities","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST associate all TPP requests (including retries) with an ","type":"text"},{"text":"X-Idempotency-Key","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST reject all requests where an ","type":"text"},{"text":"X-Idempotency-Key","type":"text","marks":[{"type":"code"}]},{"text":" is not provided by the TPP for the ","type":"text"},{"text":"/payments","type":"text","marks":[{"type":"code"}]},{"text":" resource ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On receiving the RAR request from the TPP, MUST proceed to:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a Service Initiation Consents resource (","type":"text"},{"text":"ConsentId","type":"text","marks":[{"type":"code"}]},{"text":"). ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set Consent Status to ","type":"text"},{"text":"AwaitingAuthorization","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"Meta.MultipleAuthorizers","type":"text","marks":[{"type":"code"}]},{"text":" where multiple authorizations are required to authorize the Service Initiation","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On a User Authorizing the Service Initiation, MUST set the following Consent Status to confirm Service Initiation details:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set Consent Status to ","type":"text"},{"text":"Authorized","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On Payment rails completion, MUST set the following status based on the Payment rails outcome:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"Status","type":"text","marks":[{"type":"code"}]},{"text":" to either ","type":"text"},{"text":"Pending","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"AcceptedSettlementCompleted","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"AcceptedCreditSettlementCompleted","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"AcceptedWithoutPosting","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Rejected","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When all Service Initiations have been successfully completed in a consent, the OFP MUST set the Service Initiation Consent Status to ","type":"text"},{"text":"Completed","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST set the ","type":"text"},{"text":"Links","type":"text","marks":[{"type":"code"}]},{"text":" object across both the Payment resource and Consent resource enabling the TPP to locate those resources","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST validate that a Payment is within any of the Consent Control parameter limits authorized by the User.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST send payment status Events to the TPP where a Webhook subscription has been received in the Payment request","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MAY return an HTTP ","type":"text"},{"text":"Location","type":"text","marks":[{"type":"code"}]},{"text":" header for the ","type":"text"},{"text":"201","type":"text","marks":[{"type":"code"}]},{"text":" Status code indicating the URI of the primary resource that has been created (","type":"text"},{"text":"rfc9110","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.rfc-editor.org/rfc/rfc9110#name-201-created"}}]},{"text":") ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MUST use ","type":"text"},{"text":"PaymentConsumption","type":"text","marks":[{"type":"code"}]},{"text":" to provide the TPP with up-to-date cumulative number and value totals of Payments (initiated under the consent schedule, excluding instructions in a Rejected state) associated with the ","type":"text"},{"text":"Authorized","type":"text","marks":[{"type":"code"}]},{"text":" Consent.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"7. Security","type":"text"}]},{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"payments","type":"text","marks":[{"type":"code"}]},{"text":" scope (with the ","type":"text"},{"text":"ConsentId","type":"text","marks":[{"type":"code"}]},{"text":") is used for ","type":"text"},{"text":"POST /payments","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}],"version":1}