Retrieval of the PSU accounts

GET /api/v1/accounts
oauth

Headers

  • X-Request-ID string Required

    Correlation header to be set in a request and retrieved in the relevant response

Responses

  • 200

    HalAccounts

    Hide response attributes Show response attributes object
    • _links Elixir.OpenBankingWeb.Schemas.HalLinks Required

      HAL Links

    • accounts array[object] Required

      One account of user

      Hide accounts attributes Show accounts attributes array[object]
GET /api/v1/accounts 
curl \
 -X GET https://iban.nash.io/api/v1/accounts \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "X-Request-ID: string"
Response examples (200) 
{
  "_links": {
    "consents": {
      "href": "/v1/consents"
    },
    "endUserIdentity": {
      "href": "/v1/end-user-identity"
    },
    "self": {
      "href": "/v1/accounts"
    },
    "trustedBeneficiaries": {
      "href": "/v1/trusted-beneficiaries"
    }
  },
  "accounts": [
    {
      "_links": {
        "balances": {
          "href": "/v1/accounts/3e16aaee-eddf-4161-a9ef-b2c2e697ce40/balances"
        },
        "overdrafts": {
          "href": "/v1/accounts/3e16aaee-eddf-4161-a9ef-b2c2e697ce40/overdrafts"
        },
        "owners": {
          "href": "/v1/accounts/3e16aaee-eddf-4161-a9ef-b2c2e697ce40/owners"
        },
        "transactions": {
          "href": "/v1/accounts/3e16aaee-eddf-4161-a9ef-b2c2e697ce40/transactions"
        }
      },
      "cash_account_type": "CACC",
      "name": "Current Account",
      "resource_id": "212f9431-f1f0-4808-b3bc-3303d8db91d3"
    }
  ]
}
Response examples (200) 
{
  "_links": {
    "self": {
      "href": "/v1/accounts"
    },
    "consents": {
      "href": "/v1/consents"
    },
    "endUserIdentity": {
      "href": "/v1/end-user-identity"
    },
    "trustedBeneficiaries": {
      "href": "/v1/trusted-beneficiaries"
    }
  },
  "accounts": [
    {
      "name": "Current Account",
      "_links": {
        "owners": {
          "href": "/v1/accounts/3e16aaee-eddf-4161-a9ef-b2c2e697ce40/owners"
        },
        "balances": {
          "href": "/v1/accounts/3e16aaee-eddf-4161-a9ef-b2c2e697ce40/balances"
        },
        "overdrafts": {
          "href": "/v1/accounts/3e16aaee-eddf-4161-a9ef-b2c2e697ce40/overdrafts"
        },
        "transactions": {
          "href": "/v1/accounts/3e16aaee-eddf-4161-a9ef-b2c2e697ce40/transactions"
        }
      },
      "resource_id": "212f9431-f1f0-4808-b3bc-3303d8db91d3",
      "cash_account_type": "CACC"
    }
  ]
}