Open Banking Read-Write API

https://openbankinguk.github.io/read-write-api-site3/v4.0/
Admin
Open Banking Read-Write API is a RESTful API specification that enables third-party providers to...
Tokens:535,641
Snippets:758
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Other Product Request Example

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/other-product-data-model

Example HTTP GET request to retrieve product information for a specific account. It includes authorization headers and API-specific fields like x-fapi-auth-date and x-fapi-interaction-id.

```HTTP
GET /accounts/22389/product HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

```

--------------------------------

### Get Accounts Product Request - HTTP

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/Products

Example of an HTTP GET request to retrieve product information for a specific account. Includes necessary headers for authorization and API interaction.

```HTTP
GET /accounts/22289/product HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json


```

--------------------------------

### Get Other Product with Fees and Charges Request Example

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/other-product-data-model

Example HTTP GET request to retrieve product information, including fees and charges, for a specific account. This request includes standard authorization and API-specific headers.

```HTTP
GET /accounts/22390/product HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

```

--------------------------------

### Get Products Request - HTTP

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/Products

Example of an HTTP GET request to retrieve a list of all available products. This endpoint is used for bulk product information retrieval.

```HTTP
GET /products HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json


```

--------------------------------

### Funds Confirmation GET Request - HTTP Example

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/pisp/international-scheduled-payment-consents

An example of an HTTP GET request to the funds-confirmation endpoint for international scheduled payment consents. This includes necessary headers for authorization and interaction tracking.

```http
GET /international-scheduled-payment-consents/58923/funds-confirmation HTTP/1.1
Authorization: Bearer Jhingapulaav
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

```

--------------------------------

### Get Offers Request - HTTP

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/Offers

Example of an HTTP GET request to retrieve offers for a specific account. It includes necessary headers for authorization and interaction tracking.

```http
GET /accounts/22289/offers HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json


```

--------------------------------

### Account Statements GET Request Example

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/Statements

Example of an HTTP GET request to retrieve account statements. It includes necessary headers for authorization and API interaction.

```HTTP
GET /accounts/22289/statements HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json


```

--------------------------------

### POST Account Access Consents Request Example

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/account-access-consents

Demonstrates how to make a POST request to set up an account access consent, including all possible permissions. This example shows the HTTP request headers and the JSON payload.

```HTTP
POST /account-access-consents HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
Accept: application/json

```

```JSON
{
  "Data": {
    "Permissions": [
      "ReadAccountsDetail",
      "ReadBalances",
      "ReadBeneficiariesDetail",
      "ReadDirectDebits",
      "ReadProducts",
      "ReadStandingOrdersDetail",
      "ReadTransactionsCredits",
      "ReadTransactionsDebits",
      "ReadTransactionsDetail",
      "ReadOffers",
      "ReadPAN",
      "ReadParty",
      "ReadPartyPSU",
      "ReadScheduledPaymentsDetail",
      "ReadStatementsDetail"
    ],
    "ExpirationDateTime": "2017-05-02T00:00:00+00:00",
    "TransactionFromDateTime": "2017-05-03T00:00:00+00:00",
    "TransactionToDateTime": "2017-12-03T00:00:00+00:00"
  }
}

```

--------------------------------

### Payment Initiation API

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/references/usage-examples/vrp-usage-examples

This section details the endpoints related to initiating payments, including required parameters and response formats.

```APIDOC
## POST /open-banking/v4.0/payments

### Description
Initiates a payment transaction between accounts. Requires detailed information about the creditor, debtor, and instructed amount.

### Method
POST

### Endpoint
/open-banking/v4.0/payments

### Parameters
#### Request Body
- **PaymentType** (string) - Required - Type of payment (e.g., DOMESTIC_PAYMENT, INTERNATIONAL_PAYMENT).
- **CreditorAccount** (object) - Required - Details of the creditor's account.
  - **SchemeName** (string) - Required - The payment scheme (e.g., SORTCODE, IBAN).
  - **Identification** (string) - Required - The account number or IBAN.
  - **Name** (string) - Optional - The account holder's name.
- **DebtorAccount** (object) - Optional - Details of the debtor's account.
  - **SchemeName** (string) - Required - The payment scheme.
  - **Identification** (string) - Required - The account number or IBAN.
  - **Name** (string) - Optional - The account holder's name.
- **InstructedAmount** (object) - Required - The amount and currency of the payment.
  - **Amount** (string) - Required - The payment amount.
  - **Currency** (string) - Required - The currency code (e.g., GBP, EUR).
- **RemittanceInformation** (object) - Optional - Information for remittance.
  - **Structured** (array) - Optional - Structured remittance details.
    - **ReferredDocumentType** (string) - Optional - Type of document.
    - **ReferredDocumentAmount** (string) - Optional - Amount of the document.
    - **CreditorReferenceInformation** (object) - Optional - Creditor reference details.
      - **Reference** (string) - Required - The reference string.
  - **Unstructured** (array) - Optional - Unstructured remittance details.
    - **AdditionalRemittanceInformation** (string) - Optional - Additional information.

### Request Example
```json
{
  "PaymentType": "DOMESTIC_PAYMENT",
  "CreditorAccount": {
    "SchemeName": "SORTCODE",
    "Identification": "10-20-30",
    "Name": "Example Corp"
  },
  "InstructedAmount": {
    "Amount": "100.00",
    "Currency": "GBP"
  },
  "RemittanceInformation": {
    "Unstructured": [
      {
        "AdditionalRemittanceInformation": "Invoice #12345"
      }
    ]
  }
}
```

### Response
#### Success Response (201 Created)
- **PaymentId** (string) - The unique identifier for the initiated payment.
- **Status** (string) - The current status of the payment.

#### Response Example
```json
{
  "PaymentId": "pay_abc123xyz789",
  "Status": "Pending"
}
```

#### Error Response (400 Bad Request)
- **Code** (string) - Error code.
- **Message** (string) - Error message.

#### Error Response Example
```json
{
  "Code": "INVALID_REQUEST",
  "Message": "Missing required field: CreditorAccount.Identification"
}
```
```

--------------------------------

### GET Domestic Payment Consents Request Example (HTTP)

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/pisp/domestic-payment-consents

Example of an HTTP GET request to retrieve domestic payment consent details. It includes necessary headers like Authorization, x-fapi-auth-date, x-fapi-customer-ip-address, x-fapi-interaction-id, and Accept.

```HTTP
GET /domestic-payment-consents/58923 HTTP/1.1
Authorization: Bearer Jhingapulaav
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

```

--------------------------------

### Get Products Response - JSON

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/Products

Example of a successful HTTP response (200 OK) containing a list of products. The JSON payload can include multiple product entries, with variations for 'Other' product types.

```JSON
{
  "Data": {
    "Product": [
      {
        "AccountId": "22289",
        "ProductId": "51B",
        "ProductType": "PersonalCurrentAccount",
        "SecondaryProductId": "CA78",
        "MarketingStateId": "22878123", 
        "ProductName": "321 Product",
        "PCA": { .. }
      },
      {
        "AccountId": "31820",
        "ProductId": "001",
        "SecondaryProductId": "OTH453",
        "ProductType": "Other",
        "OtherProductType":{
          "Type": "e-Wallet", 
          "Description": "Virtual wallet",
        },
        "ProductName": "123 Product",
        "MarketingStateId": "22878123",
        "BCA": { .. }
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v4.0/aisp/products/"
  },
  "Meta": {
    "TotalPages": 1
  }
}


```

--------------------------------

### Get Accounts Product Response - JSON

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/Products

Example of a successful HTTP response (200 OK) containing product details for an account. The JSON payload includes account and product identifiers, types, and associated data.

```JSON
{
  "Data": {
    "Product": [
      {
        "AccountId": "22289",
        "ProductId": "51B",
        "SecondaryProductId": "CA78",
        "MarketingStateId": "22878123", 
        "ProductType": "PersonalCurrentAccount",
        "ProductName": "321 Product",
        "PCA": { .. },
        "BCA": { .. }
	    }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/product"
  },
  "Meta": {
    "TotalPages": 1
  }
}


```

--------------------------------

### GET /accounts Response Example (JSON)

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/Accounts

Example HTTP response for the GET /accounts request. It includes a JSON payload detailing account information such as AccountId, Status, Currency, and Servicer details. This response allows AISPs to discover accounts.

```json
{
  "Data": {
    "Account": [
      {
        "AccountId": "22289",
        "Status": "Enabled",
        "MaturityDate": "2019-01-01T06:06:06+00:00",
        "StatusUpdateDateTime": "2019-01-01T06:06:06+00:00",
        "Currency": "GBP",
        "AccountCategory": "Personal",
        "AccountTypeCode": "CACC",
        "Description" :  "For paying bills",
        "Nickname": "Bills",
        "OpeningDate": "01-05-2002",
        "SwitchStatus": "UK.CASS.NotSwitched",
        "StatementFrequencyAndFormat": [
          {
            "Frequency": "YEAR",
            "CommunicationMethod": "EMAL",
            "Format": "DPDF",
            "DeliveryAddress": {
              "AddressType": "HOME",
              "StreetName": "Bank Street",
              "BuildingNumber": "11",
              "Floor": "6",
              "PostCode": "Z78 4TY",
              "TownName": "London",
              "Country": "UK"
            }
          }
        ],
        "Servicer": {
          "SchemeName": "UK.OBIE.BICFI",
          "Identification": "8020441910203345",
          "Name": "ServicerName"
        },
        "Account": [
          {
            "SchemeName": "UK.OBIE.SortCodeAccountNumber",
            "Identification": "80200110203345",
            "Name": "Mr Kevin",
            "SecondaryIdentification": "00021",
            "LEI": "9193001QZMP2PQT4AK86"
          }
        ]
      },
      {
        "AccountId": "31820",
        "Status": "Enabled",
        "StatusUpdateDateTime": "2018-01-01T06:06:06+00:00",
        "Currency": "GBP",
        "AccountCategory": "Personal",
        "AccountTypeCode": "CACC",
        "Nickname": "Household",
        "Account": [
          {
            "SchemeName": "UK.OBIE.SortCodeAccountNumber",
            "Identification": "80200110203348",
            "Name": "Mr Kevin"
          }
        ]
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v4.0/aisp/accounts/"
  },
  "Meta": {
    "TotalPages": 1
  }
}

```

--------------------------------

### GET /accounts/{AccountId}/statements Request Example

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/Statements

This example demonstrates how to make a GET request to retrieve statements for a specific account. It includes necessary headers such as Authorization, x-fapi-auth-date, x-fapi-customer-ip-address, and x-fapi-interaction-id. The Accept header specifies the desired response format.

```http
GET /accounts/22289/statements HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
```

--------------------------------

### Get Products

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/Products

Retrieves a list of all available products.

```APIDOC
## GET /products

### Description
Retrieves a list of all available products across all accounts, including details like account ID, product ID, product type, and associated PCA/BCA data.

### Method
GET

### Endpoint
`/products`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET /products HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
```

### Response
#### Success Response (200)
- **Data** (object) - Contains product information.
  - **Product** (array) - List of all available products.
    - **AccountId** (string) - The unique identifier for the account.
    - **ProductId** (string) - The unique identifier for the product.
    - **SecondaryProductId** (string) - An optional secondary identifier for the product.
    - **MarketingStateId** (string) - The unique identifier for the product's marketing state.
    - **ProductType** (string) - The category of the product (e.g., PersonalCurrentAccount).
    - **ProductName** (string) - The marketing name of the product.
    - **PCA** (object) - Personal Current Account specific data (if applicable).
    - **BCA** (object) - Business Current Account specific data (if applicable).
    - **OtherProductType** (object) - Details for 'Other' product types.
      - **Type** (string) - The specific type of 'Other' product.
      - **Description** (string) - A description of the 'Other' product type.
- **Links** (object) - Links related to the response.
  - **Self** (string) - The URL for the current request.
- **Meta** (object) - Metadata about the response.
  - **TotalPages** (integer) - The total number of pages for the results.

#### Response Example
```json
{
  "Data": {
    "Product": [
      {
        "AccountId": "22289",
        "ProductId": "51B",
        "ProductType": "PersonalCurrentAccount",
        "SecondaryProductId": "CA78",
        "MarketingStateId": "22878123", 
        "ProductName": "321 Product",
        "PCA": { }
      },
      {
        "AccountId": "31820",
        "ProductId": "001",
        "SecondaryProductId": "OTH453",
        "ProductType": "Other",
        "OtherProductType":{
          "Type": "e-Wallet", 
          "Description": "Virtual wallet"
        },
        "ProductName": "123 Product",
        "MarketingStateId": "22878123",
        "BCA": { }
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v4.0/aisp/products/"
  },
  "Meta": {
    "TotalPages": 1
  }
}
```
```

--------------------------------

### Get Account Access Consents Request Example (Status AWAU)

Source: https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/account-access-consents

This example shows a GET request to retrieve account access consent details when the consent status is 'AWAU' (Awaiting Authorisation). It includes standard headers for API authentication and identification.

```http
GET /account-access-consents/urn-alphabank-intent-88379 HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

```
Tokens:
Raw