Home API reference Accounts

Accounts

On this page:

GET[base]/accounts

Get a list of accounts

GET[base]/accounts/{accountId}

Get account details

Get a list of accounts

Use this method to retrieve a full list of accounts and account infromation that the PSU has authorized to access.

Request

Header parameters:

Authorization

The authorization token as per https://tools.ietf.org/html/rfc6750.

x-fapi-financial-id required

The unique identifier of the ASPSP issued by the Open Banking system.

x-fapi-customer-last-logged-time

The date and time when the PSU has last logged in system using a TPP application.

x-fapi-customer-ip-address

The IP address of the PSU who has logged in system using a TPP application.

x-fapi-interaction-id

The unique identifier of the initiating party (as per RFC4122 UID) used as a correlation identifier.

x-customer-user-agent

The user-agent used by the PSU.

GET[base]/accounts

GET /accounts/urn-example HTTP/1.1
Authorization: Bearer <token>
x-fapi-financial-id: b621cec4-e775-49ab-980a-1900c6a09620
x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

Response

Body:

Account object

This object provides the following data:

Expand fields
AccountId string

The account identifier.

Currency string

The currency of an account. This parameter is used when the same account number spans multiple currencies and the initating party needs to specify which currency should be used to settle the account.

AccountType string

The type of an account. Possible values:

  • Business

  • Personal

AccountSubType string

The subtype of an account. Possible values:

  • ChargeCard

  • CreditCard

  • CurrentAccount

  • EMoney

  • Loan

  • Mortgage

  • PrePaidCard

  • Savings

Description string

The description of an account type.

Nickname string

The alias of an account, assigned by the account owner to provide additional identification of the account.

Servicer object

A party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.

This object provides the following data:

Expand fields
SchemeName string

The name of an identification scheme.

Identification string

The identifier of a financial institution.

HTTP status codes:

The eqwire API uses standard HTTP response codes to indicate the success or failure of a request.

To view a full list of valid response codes, refer to HTTP response codes.

RESPONSE EXAMPLE 
{
  "Data": {
    "Account": [
      {
        "AccountId": "22289",
        "Currency": "GBP",
        "AccountType": "Business",
        "AccountSubType": "ChargeCard",
        "Description": "Business",
        "Nickname": "Bills",
        "Account": [
          {
            "SchemeName": [
              "UK.OBIE.BBAN",
              "UK.OBIE.IBAN",
              "UK.OBIE.PAN",
              "UK.OBIE.Paym",
              "UK.OBIE.SortCodeAccountNumber"
            ],
            "Identification": "80200110203345",
            "Name": "Mr Kevin",
            "SecondaryIdentification": "00021"
          }
        ],
        "Servicer": {
          "SchemeName": [
            "UK.OBIE.BICFI"
          ],
          "Identification": "80200110203348"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://example.com",
    "First": "https://example.com",
    "Prev": "https://example.com",
    "Next": "https://example.com",
    "Last": "https://example.com"
  },
  "Meta": {
    "TotalPages": 5,
    "FirstAvailableDateTime": "2022-12-06T08:07:24.540Z",
    "LastAvailableDateTime": "2022-12-06T08:07:24.540Z"
  }
}

Get account details

Use this method to obtain detailed information about a specified account.

Request

Header parameters:

Authorization

The authorization token as per https://tools.ietf.org/html/rfc6750.

x-fapi-financial-id required

The unique identifier of the ASPSP issued by the Open Banking system.

x-fapi-customer-last-logged-time

The date and time when the PSU has last logged in system using a TPP application.

x-fapi-customer-ip-address

The IP address of the PSU who has logged in system using a TPP application.

x-fapi-interaction-id

The unique identifier of the initiating party (as per RFC4122 UID) used as a correlation identifier.

x-customer-user-agent

The user-agent used by the PSU.

Path parameters:

AccountId required

The account identifier.

GET[base]/accounts/{accountId}

GET /accounts/account-Id-example/accountId HTTP/1.1
Authorization: Bearer <token>
x-fapi-financial-id: b621cec4-e775-49ab-980a-1900c6a09620
x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

Response

Body:

Account object

This object provides the following data:

Expand fields
AccountId string

The account identifier.

Currency string

The currency of an account. This parameter is used when the same account number spans multiple currencies and the initating party needs to specify which currency should be used to settle the account.

AccountType string

The type of an account. Possible values:

  • Business

  • Personal

AccountSubType string

The subtype of an account. Possible values:

  • ChargeCard

  • CreditCard

  • CurrentAccount

  • EMoney

  • Loan

  • Mortgage

  • PrePaidCard

  • Savings

Description string

The description of an account type.

Nickname string

The alias of an account, assigned by the account owner to provide additional identification of the account.

Servicer object

A party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.

This object provides the following data:

Expand fields
SchemeName string

The name of an identification scheme.

Identification string

The identifier of a financial institution.

HTTP status codes:

The eqwire API uses standard HTTP response codes to indicate the success or failure of a request.

To view a full list of valid response codes, refer to HTTP response codes.

RESPONSE EXAMPLE 
{
  "Data": {
    "Account": [
      {
        "AccountId": "22289",
        "Currency": "GBP",
        "AccountType": "Business",
        "AccountSubType": "ChargeCard",
        "Description": "Business",
        "Nickname": "Bills",
        "Account": [
          {
            "SchemeName": [
              "UK.OBIE.BBAN",
              "UK.OBIE.IBAN",
              "UK.OBIE.PAN",
              "UK.OBIE.Paym",
              "UK.OBIE.SortCodeAccountNumber"
            ],
            "Identification": "80200110203345",
            "Name": "Mr Kevin",
            "SecondaryIdentification": "00021"
          }
        ],
        "Servicer": {
          "SchemeName": [
            "UK.OBIE.BICFI"
          ],
          "Identification": "80200110203348"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://example.com",
    "First": "https://example.com",
    "Prev": "https://example.com",
    "Next": "https://example.com",
    "Last": "https://example.com"
  },
  "Meta": {
    "TotalPages": 5,
    "FirstAvailableDateTime": "2022-12-06T08:07:24.540Z",
    "LastAvailableDateTime": "2022-12-06T08:07:24.540Z"
  }
}