---
title: "Get Reward Bank"
method: GET
path: "/banks/pointsreward/{bankId}"
tags: ["Reward Bank"]
---

# Get Reward Bank

`GET /banks/pointsreward/{bankId}`

## Request

- Base URL: `https://resources.uk.eagleeye.com`
- URL: `https://resources.uk.eagleeye.com/banks/pointsreward/{bankId}`
- Auth: none declared. Required headers: `X-EES-AUTH-CLIENT-ID`, `X-EES-AUTH-HASH`

This API endpoint allows the calling application to retrieve a Points Exchange Bank details by Bank ID

## Path parameters

- `bankId` string, string, required

## Headers

- `Accept-Encoding` '''' | ''gzip'' | ''deflate'' | ''gzip,deflate'' | ''deflate,gzip'', string
- `Connection` 'keep-alive' | 'close', string
- `Content-Type` string, string
- `X-EES-AUTH-CLIENT-ID` string, string, required
- `X-EES-AUTH-HASH` string, string, required
- `X-EES-TRANSACTION-ID` string, string
- `X-CUSTOM-SUBSYSTEM-ID` string, string
- `X-CUSTOM-KEY` string, string

## Response `200`

EES AIR has successfully processed a Request

- PointsRewardBankEntity
  - `pointsRewardBankId` string, string, required: EES AIR Points Exchange Bank ID
  - `status` 'ACTIVE' | 'INACTIVE' | 'SUSPENDED', string, required: Points Exchange Bank Status
  - `mode` 'PUBLIC' | 'PERSONAL', string, required: Bank's mode: `PERSONAL` - only nominated Consumers can see and exchange rewards from this Bank, (nominee list could change while running a Scheme and/or Reward Bank); `PUBLIC` - all Consumers could see and exchange rewards using this Reward Bank)
  - `name` string, string, required: Bank Name
  - `reference` string, string, required: Points Exchange Bank External Reference
  - `dateCreated` string, ees-datetime, required: Points Exchange Bank Created Date-time (ATOM format)
  - `lastUpdated` string, ees-datetime, required: Points Exchange Bank Last updated Date-time (ATOM format)
  - `exchangeLimit` integer, nullable, required: Number of times a Wallet or Wallet Link can exchange rewards from this Bank

## Other responses

- `400`: EES AIR Refuse to process that particular Request as there is something wrong with the Request (e.g., missing Mandatory Request parameter or Mandatory Request Payload attribute is missing, Request payload cannot be processed, etc)
- `401`: EES AIR Refuse to process that particular Request due to Authentication error. This could be caused by missing mandatory AUTH header(s), invalid Hash calculation, invalid or inactive API Key used, etc
- `403`: EES AIR Refuse to process that particular Request due to Request Authorization error(s). This indicates that used API Key has not got required permissions to perform this operation.
- `404`: EES AIR Refuse to process that particular Request as requested/referenced resource could not be found.
- `409`: EES AIR understands this request, but refuse to process it, due to present Conflict with the current state of the target resource or because performing this operation would lead to a Conflict within AIR.
- `415`: EES AIR is not able to understand that request due to not supported `Content-Type` value.
- `429`: EES AIR refuses to process that particular Request as Client's API Requests Limit was exceeded.
- `500`: EES AIR refuses to process that particular Request due to Unexpected Server Error.
- `503`: EES AIR refuses to process that particular Request due to Service(s) being Unavailable (i.e. Scheduled Maintenance)
- `504`: EES AIR refuses to process that particular Request due to Networking Issues

---

[API](https://skmtc.dev/eagleeye/apis/resource-api.md) - [All operations](https://skmtc.dev/eagleeye/apis/resource-api/llms.txt) - [OpenAPI document](https://skmtc.dev/eagleeye/apis/resource-api/revisions/10217d37fdc5?raw)