---
title: "Search for Reward Banks"
method: GET
path: "/banks/pointsreward"
tags: ["Reward Bank"]
---

# Search for Reward Banks

`GET /banks/pointsreward`

This API endpoint allows the calling application to retrieve a set of Points Exchange Banks details fulfilling an optional filtering criteria

## Query parameters

- `mode` 'PUBLIC' | 'PERSONAL', string
- `status` union
  - string, string
  - string[]
- `reference` string, string
- `orderBy[]` 'pointsRewardBankId,ASC' | 'pointsRewardBankId,DESC', string
- `offset` string, int32
- `limit` string, int32

## 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

- object
  - `offset` integer, required — Result set pagination offset
  - `limit` integer, required — Results per page (up to 100)
  - `total` integer, required — Results count
  - `orderBy` object[], nullable, required
    - `name` string, string — Field used for sorting results
    - `order` 'ASC' | 'DESC', string — Sorting order (ascending, descending)
  - `results` PointsRewardBankEntity[], required
    - `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. Request Payload is unprocessable, Mandatory Request Parameter value is not provided, etc.)
- `401` — EES AIR refuse to process that particular Request due to Authentication error(s). This could be caused by missing one or more of mandatory AUTH headers, invalid Hash calculation, invalid or inactive API Key used, etc.
- `403` — EES AIR refuse to process that particular Request due to Authorisation error(s). Please note nothing is wrong with Authentication nor hash Calculation, it is simply due to lack of permission to perform that particular action (e.g. Issuance Partner attempts to Redeem a Token or Redemption Partner attempts to Issue a Token, etc.)
- `404` — EES AIR refuse to process that particular Request as requested Resource could not be found or referenced Resource is not active.
- `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 refuse to process that particular Request as requested `Mime-Type` is not supported (Currently only `application/json` is supported
- `429` — EES AIR refuses to process that particular Request as Client's API Requests Limit was exceeded.
- `500` — EES AIR is not able 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.net/eagleeye/apis/wallet-api.md) · [All operations](https://skmtc.net/eagleeye/apis/wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeye/wallet-api/revisions/90a122bb14cc/schema)