Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{
    "typ": "JWT",
    "alg": "PS256",
    "kid": "e4ce77c498e77000a25aa7b40e4a83f9"
}
.
{
    "iss": "s6BhdRkqt3",
    "aud": "https://server.example.com",
    "response_type": "code",
    "redirect_uri": "https://openbanking.tpp1.ae/simple-redirect-url",
    "scope": "accounts",
    "state": "2616df22-899e-468b-b7af-927145b067cc",
    "authorization_details": [
        {
            "Typetype": "https://www.openfinance.ae/urn:openfinanceuae:account-access-consent:v1.0-draft2",
            "Dataconsent": {
                "ConsentId": "399e0065-9907-42cc-82b9-1ec4f273e3e9",
                "CreationDateTime": "2024-03-27T15:27:13+0300",
                "ConsentStatus": "Authorized",
                "ConsentStatusUpdateDateTime": "2024-03-27T16:27:13+0300",
                "Permissions": [
                    "ReadAccountsBasic",
                    "ReadAccountsDetail",
                    "ReadBalances",
                    "ReadBeneficiariesBasic",
                    "ReadBeneficiariesDetail",
                    "ReadTransactionsBasic",
                    "ReadTransactionsDetail",
                    "ReadTransactionsCredits",
                    "ReadTransactionsDebits",
                    "ReadScheduledPaymentsBasic",
                    "ReadScheduledPaymentsDetail",
                    "ReadDirectDebits",
                    "ReadStandingOrdersBasic",
                    "ReadStandingOrdersDetail"
                ],
                "AuthorizationExpirationTimeWindow": "720:00:00",
                "ExpirationDateTime": "2024-03-28T15:27:13+0300",
                "TransactionFromDateTime": "2024-03-25T12:19:24+0300",
                "TransactionToDateTime": "2024-03-27T12:19:24+0300",
                "AccountType": ["UAEOF.Retail"],
                "AccountSubType": ["CurrentAccount"],
                "ConsentPurpose": ["Account Aggregation", "E-Statement"]
            }
        }
    ]
}

...

Code Block
GET /open-finance/account-information/2024v1.03.110-draft1draft2/accounts HTTP/1.1
Host: rs1.openfinanceplatform.ae
Accept: application/json
x-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602
Authorization: Bearer caa1b60d-61ff-4cd8-a4e1-2d18c8696de0

...

Code Block
HTTP/1.1 200 OK
Content-Type: application/json
x-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602
{
  "Data": {
    "Account": [
      {
        "AccountId": "f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115",
        "AccountHolderName": "Hamad Ali",
        "AccountHolderShortName": "",
        "Status": "Active",
        "Currency": "AED",
        "AccountType": "UAEOF.Retail",
        "AccountSubType": "CurrentAccount",
        "Nickname": "CurrentAC",
        "OpeningDate": "2021-01-28T15:27:13+0300",
        "AccountIdentifiers": [
          {
            "IdentificationType": "UAEOF.IBAN",
            "Identification": "SA4420000001234567891234",
            "Name": "Hamad Ali"
          }
        ],
        "Servicer": {
          "IdentificationType": "UAEOF.BICFI",
          "Identification": "SASAMA"
        }
      },
      {
        "AccountId": "g91d07d0-6d8f-4e0e-9fb4-0ac61f84e444",
        "AccountHolderName": "Hamad Ali",
        "AccountHolderShortName": "",
        "Status": "Active",
        "Currency": "USD",
        "AccountType": "UAEOF.Retail",
        "AccountSubType": "Savings",
        "Nickname": "SavingsAC",
        "OpeningDate": "2021-01-28T15:27:13+0300",
        "AccountIdentifiers": [
          {
            "IdentificationType": "UAEOF.IBAN",
            "Identification": "SA4420000001234567890001",
            "Name": "Hamad Ali"
          }
        ],
        "Servicer": {
          "IdentificationType": "UAEOF.BICFI",
          "Identification": "SASAMA"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://rs1.openfinanceplatform.ae/open-finance/account-information/2024v1.03.110-draft1draft2/accounts"
  },
  "Meta": {}
}

...

Code Block
GET /open-finance/account-information/2024.03v1.110-draft1draft2/accounts/f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115/balances HTTP/1.1
Host: rs1.lab.api.openbanking.ae
Accept: application/json
x-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602
Authorization: Bearer caa1b60d-61ff-4cd8-a4e1-2d18c8696de0

...

Code Block
HTTP/1.1 200 OK
Content-Type: application/json
x-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602
{
  "Data": {
    "AccountId": "f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115",
    "Balance": [
      {
        "CreditDebitIndicator": "UAEOF.Credit",
        "Type": "UAEOF.ClosingAvailable",
        "DateTime": "2023-01-28T15:27:13+0300",
        "Amount": {
          "Amount": "10000.00",
          "Currency": "AED"
        },
        "CreditLine": [
          {
            "Included": true,
            "Type": "UAEOF.Available",
            "Amount": {
              "Amount": "45000.00",
              "Currency": "AED"
            }
          }
        ]
      }
    ]
  },
  "Links": {
    "Self": "https://rs1.openfinanceplatform.ae/open-finance/account-information/2024v1.03.110-draft1draft2/accounts/f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115/balances"
  },
  "Meta": {}
}

...

Code Block
GET /open-finance/account-information/2024v1.03.110-draft1draft2/accounts/f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115/transactions HTTP/1.1
Host: rs1.lab.api.openbanking.ae
Accept: application/json
x-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602
Authorization: Bearer caa1b60d-61ff-4cd8-a4e1-2d18c8696de0

...

Code Block
HTTP/1.1 200 OK
Content-Type: application/json
x-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602
{
  "Data": {
    "AccountId": "f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115",
    "Transaction": [
      {
        "TransactionId": "19ee5b71-e70a-4a97-8cc2-c235c7274beb",
        "TransactionDateTime": "2023-01-26T16:18:32+0300",
        "LocalTimeZone": "UTC+04:00",
        "StatementReference": "502fec1c-ed4f-4524-a477-13b9802c03d",
        "TransactionReference": "20230126SAMA1234567812345678123456",
        "TransactionType": "UAEOF.POS",
        "SubTransactionType": "UAEOF.Purchase",
        "TerminalId": "1234567812345678",
        "Flags": [
          "UAEOF.Cashback"
        ],
        "PaymentModes": "UAEOF.Online",
        "CreditDebitIndicator": "UAEOF.Debit",
        "Status": "UAEOF.Booked",
        "TransactionMutability": "UAEOF.Mutable",
        "BookingDateTime": "2023-01-26T16:18:32+0300",
        "ValueDateTime": "2023-01-26T16:18:32+0300",
        "Amount": {
          "Amount": "100.00",
          "Currency": "AED"
        },
        "ChargeAmount": {
          "Amount": "10.00",
          "Currency": "AED",
          "ChargeIncluded": true
        },
        "ChargeAmountVat": {
          "Amount": "0.00",
          "Currency": "AED"
        },
        "CurrencyExchange": {
          "SourceCurrency": "AED",
          "TargetCurrency": "AED",
          "UnitCurrency": "1",
          "ExchangeRate": "1.02",
          "InstructedAmount": {
            "Amount": "102.00",
            "Currency": "AED"
          }
        },
        "Balance": {
          "CreditDebitIndicator": "UAEOF.Credit",
          "Type": "UAEOF.ClosingAvailable",
          "Amount": {
            "Amount": "9900.00",
            "Currency": "AED"
          }
        },
        "MerchantDetails": {
          "MerchantId": "1234567890",
          "MerchantName": "Rand's Cafe",
          "MerchantCategoryCode": "5812"
        },
        "CreditorAccount": {
          "IdentificationType": "UAEOF.IBAN",
          "Identification": "SA4420000001234567899876",
          "Name": "Rand's Cafe"
        },
        "DebtorAccount": {
          "IdentificationType": "UAEOF.IBAN",
          "Identification": "SA4420000001234567891234",
          "Name": "Hamad Ali"
        },
        "CardInstrument": {
          "CardSchemeName": "UAEOF.mada",
          "InstrumentType": "UAEOF.madaPay",
          "Name": "Mr. Hamad Ali",
          "Identification": "1234********4321"
        },
        "BillDetails": {
          "BillerId": "0",
          "BillNumber": "",
          "BillPaymentType": ""
        }
      },
      {
        "TransactionId": "c68d98ea-6e91-4a3b-8459-f12a9d7ecba4",
        "TransactionDateTime": "2023-01-26T16:18:32+0300",
        "LocalTimeZone": "UTC+04:00",
        "StatementReference": "502fec1c-ed4f-4524-a477-13b9802c03d",
        "TransactionReference": "20230126SASAMASAMA2BMOB11444064073",
        "TransactionType": "UAEOF.LocalBankTransfer",
        "SubTransactionType": "UAEOF.MoneyTransfer",
        "PaymentModes": "UAEOF.Online",
        "CreditDebitIndicator": "UAEOF.Credit",
        "Status": "UAEOF.Booked",
        "TransactionMutability": "UAEOF.Immutable",
        "BookingDateTime": "2023-01-26T16:18:32+0300",
        "ValueDateTime": "2023-01-26T16:18:32+0300",
        "Amount": {
          "Amount": "100.00",
          "Currency": "AED"
        },
        "ChargeAmount": {
          "Amount": "0.00",
          "Currency": "AED",
          "ChargeIncluded": true
        },
        "ChargeAmountVat": {
          "Amount": "0.00",
          "Currency": "AED"
        },
        "Balance": {
          "CreditDebitIndicator": "UAEOF.Credit",
          "Type": "UAEOF.ClosingAvailable",
          "Amount": {
            "Amount": "10000.00",
            "Currency": "AED"
          }
        },
        "CreditorAccount": {
          "IdentificationType": "UAEOF.IBAN",
          "Identification": "SA4420000001234567899876",
          "Name": "Rand Ali"
        },
        "DebtorAccount": {
          "IdentificationType": "UAEOF.IBAN",
          "Identification": "SA4420000001234567891234",
          "Name": "Abdulelah Alyahya"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://rs1.openfinanceplatform.ae/open-finance/account-information/2024v1.03.110-draft1draft2/accounts/f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115/transactions"
  },
  "Meta": {
    "FirstAvailableDateTime": "2023-01-25T12:19:24+0300",
    "LastAvailableDateTime": "2023-01-27T12:19:24+0300"
  }
}

...

Code Block
GET /open-finance/account-information/2024v1.03.110-draft1draft2/account-access-consents/aac-1a672e83-d1e5-42bc-b8e1-60a490ec52fd HTTP/1.1
Host: rs1.openfinanceplatform.ae
Content-Type: application/json
x-fapi-interaction-id: 2e974f01-d111-4078-9a19-7a9b385e637c
Authorization: Bearer e6156449-6f27-4c42-aa5b-36602f73eac9

...

Code Block
HTTP/1.1 200 OK
Content-Type:application/json
x-fapi-interaction-id: 2e974f01-d111-4078-9a19-7a9b385e637c
{
  "Data": {
    "ConsentId": "aac-69255d98-ab0e-4758-92a7-cacbf3073efa",
    "CreationDateTime": "2023-01-27T15:27:13+0300",
    "ConsentStatus": "Authorized",
    "ConsentFlags": {
      "PartlyAuthorized": "2023-01-27T16:27:13+0300"
    },
    "ConsentStatusUpdateDateTime": "2023-01-27T16:27:13+0300",
    "Permissions": [
      "ReadAccountsBasic",
      "ReadAccountsDetail",
      "ReadBalances",
      "ReadBeneficiariesBasic",
      "ReadBeneficiariesDetail",
      "ReadTransactionsBasic",
      "ReadTransactionsDetail",
      "ReadTransactionsCredits",
      "ReadTransactionsDebits",
      "ReadScheduledPaymentsBasic",
      "ReadScheduledPaymentsDetail",
      "ReadDirectDebits",
      "ReadStandingOrdersBasic",
      "ReadStandingOrdersDetail"
    ],
    "AuthorizationExpirationTimeWindow": "720:00:00",
    "ExpirationDateTime": "2023-01-28T15:27:13+0300",
    "TransactionFromDateTime": "2023-01-25T12:19:24+0300",
    "TransactionToDateTime": "2023-01-27T12:19:24+0300",
    "AccountType": [
      "UAEOF.Retail"
    ],
    "AccountSubType": [
      "CurrentAccount"
    ],
    "ConsentPurpose": [
      "Account Aggregation",
      "E-Statement"
    ]
  },
  "Subscription": {
    "Webhook": {
      "Url": "https://api.tpp1.com/webhook/callbackUrl",
      "IsActive": false
    }
  },
  "Links": {
    "Self": "https://rs1.openfinanceplatform.ae/open-finance/account-information/2024v1.03.110-draft1draft2/account-access-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa"
  },
  "Meta": {}
}

...

Code Block
GET /open-finance/account-information/2024v1.03.110-draft1draft2/accounts HTTP/1.1
Host: rs1.openfinanceplatform.ae
Content-Type: application/json
x-fapi-interaction-id: 9a371b79-4e79-4d7d-a77d-380c528ab8c0
Authorization: Bearer caa1b60d-61ff-4cd8-a4e1-2d18c8696de0

...

Code Block
{
    "typ": "JWT",
    "alg": "PS256",
    "kid": "e4ce77c498e77000a25aa7b40e4a83f9"
}
.
{
    "iss": "s6BhdRkqt3",
    "iat": 1669393154,
    "exp": 1669393496,
    "nbf": 1669393154,
    "aud": "https://server.example.com",
    "response_type": "code",
    "redirect_uri": "https://openbanking.tpp1.ae/simple-redirect-url",
    "scope": "accounts",
    "state": "2616df22-899e-468b-b7af-927145b067cc",
    "authorization_details": [
        {
            "Typetype": "https://www.openfinance.ae/urn:openfinanceuae:account-access-consent:v1.0-draft2",
            "Dataconsent": {
                "ConsentId": "399e0065-9907-42cc-82b9-1ec4f273e3e9",
                "CreationDateTime": "2024-03-27T15:27:13+0300",
                "ConsentStatus": "Authorized",
                "ConsentStatusUpdateDateTime": "2024-03-27T16:27:13+0300",
                "Permissions": [
                    "ReadAccountsBasic",
                    "ReadAccountsDetail",
                    "ReadBalances",
                    "ReadBeneficiariesBasic",
                    "ReadBeneficiariesDetail",
                    "ReadTransactionsBasic",
                    "ReadTransactionsDetail",
                    "ReadTransactionsCredits",
                    "ReadTransactionsDebits",
                    "ReadScheduledPaymentsBasic",
                    "ReadScheduledPaymentsDetail",
                    "ReadDirectDebits",
                    "ReadStandingOrdersBasic",
                    "ReadStandingOrdersDetail"
                ],
                "AuthorizationExpirationTimeWindow": "720:00:00",
                "ExpirationDateTime": "2024-03-28T15:27:13+0300",
                "TransactionFromDateTime": "2024-03-25T12:19:24+0300",
                "TransactionToDateTime": "2024-03-27T12:19:24+0300",
                "AccountType": ["UAEOF.Retail"],
                "AccountSubType": ["CurrentAccount"],
                "ConsentPurpose": ["Account Aggregation", "E-Statement"]
            },
            "Subscription": {
              "Webhook": {
                "Url": "https://api.tpp1.com/webhook/callbackUrl",
                "IsActive": false
              }
            }
        }
    ]
}

...

Code Block
PATCH /open-finance/account-information/2024v1.03.110-draft1draft2/account-access-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa HTTP/1.1
Host: rs1.lab.api.openbanking.ae
Content-Type: application/json
x-fapi-interaction-id: 3424a379-8274-4686-99bd-f420d08acead
Authorization: Bearer ad297304-1057-4c68-9e76-a96f300a27f1
{
  "Subscription": {
    "Webhook": {
      "IsActive": true
    }
  }
}

...

Code Block
PATCH /open-finance/account-information/2024v1.03.110-draft1draft2/account-access-consents/aac-69255d98-ab0e-4758-92a7-cacbf3073efa HTTP/1.1
Host: rs1.lab.api.openbanking.ae
Content-Type: application/json
x-fapi-interaction-id: 3424a379-8274-4686-99bd-f420d08acead
Authorization: Bearer ad297304-1057-4c68-9e76-a96f300a27f1
{
  "Subscription": {
    "Webhook": {
      "IsActive": false
    }
  }
}

...

Code Block
{
  "alg": "PS256",
  "kid": "e1be6bf3-76e6-4e53-92b9-c46423757ab1"
}
.
{
  "iss": "string",
  "exp": 1664950125,
  "nbf": 1664950125,
  "aud": [
    "6uC8HSQ8C59SDSw43Cdm9YWxxjJmDV"
  ],
  "iat": 1661378036,
  "message": {
    "Data": {
      "AccountId": "f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115",
      "Account": [
        {   
          "Currency": "AED",
          "Status": "Active",          
          "AccountIdentifiers": [
            {
              "Name": "Account 1",
              "IdentificationType": "UAEOF.IBAN",
              "Identification": "00003130000001"
            }
          ]
        }
      ]
    },
    "Links": {
      "Self": "https://rs1.openfinanceplatform.ae/open-finance/account-information/2024v1.03.110-draft1draft2/accounts/f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115"
    },
    "EventMeta": {
      "EventDateTime": "2022-08-24T07:28:00.556Z",
      "EventResource": "accounts",
      "EventType": "UAEOF.Resource.Created",
      "ConsentId": "aac-1a672e83-d1e5-42bc-b8e1-60a490ec52fd"
    }
  }
}
.
<<signature>>

...

Code Block
{
  "alg": "PS256",
  "kid": "e1be6bf3-76e6-4e53-92b9-c46423757ab1"
}
.
{
  "iss": "string",
  "exp": 1664950125,
  "nbf": 1664950125,
  "aud": [
    "6uC8HSQ8C59SDSw43Cdm9YWxxjJmDV"
  ],
  "iat": 1661378036,
  "message": {
    "Data": {
      "AccountId": "f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115",
      "Transaction": [
        {
          "TransactionId": "668f2fc8-7aa8-411b-bb9f-7571a90e7512",
          "TransactionReference": "1852efce-bedc-4fda-ba51-0f76c9137f91",
          "CreditDebitIndicator": "Debit",
          "Status": "Booked",
          "TransactionMutability": "",
          "BookingDateTime": "2022-08-24T07:27:00.556Z",
          "ValueDateTime": "2022-08-24T07:27:00.556Z",
          "TransactionInformation": "Foo Group ",
          "Amount": {
            "Amount": "41.10",
            "Currency": "AED"
          },
          "BankTransactionCode": {
            "Code": "CustomerCardTransactions",
            "SubCode": "CashWithdrawal"
          },
          "ProprietaryBankTransactionCode": {
            "Code": ""
          }
        },
        {
          "TransactionId": "05b6bfde-ce5a-48e1-a448-66d75518f1e8",
          "TransactionReference": "b5a6a869-730f-449d-badf-14ebf3980147",
          "CreditDebitIndicator": "Debit",
          "Status": "Booked",
          "TransactionMutability": "",
          "BookingDateTime": "2022-08-24T07:28:00.556Z",
          "ValueDateTime": "2022-08-24T07:28:00.556Z",
          "TransactionInformation": "Bar Holding",
          "Amount": {
            "Amount": "32.40",
            "Currency": "AED"
          },
          "BankTransactionCode": {
            "Code": "CustomerCardTransactions",
            "SubCode": "CashWithdrawal"
          },
          "ProprietaryBankTransactionCode": {
            "Code": ""
          }
        }
      ]
    },
    "Links": {
      "Self": "https://rs1.openfinanceplatform.ae/open-finance/account-information/2024v1.03.110-draft1draft2/accounts/f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115/transactions"
    },
    "EventMeta": {
      "EventDateTime": "2022-08-24T08:28:00.556Z",
      "EventResource": "transactions",
      "EventType": "UAEOF.Resource.Created",
      "ConsentId": "aac-1a672e83-d1e5-42bc-b8e1-60a490ec52fd"
    }
  }
}
.
<<signature>>

...