> ## Documentation Index > Fetch the complete documentation index at: https://docs.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # Current Balance and Transaction History > Returns what this person can redeem and what they have redeemed already: the rewards their balance currently reaches, the suppliers those can be redeemed with, the redemption history, and the parameters the bank is configured with. Rendered for the person the access token identifies, so a person only ever sees their own bank. ## OpenAPI ````yaml /feature-specific-apis/reward-bank.json post /api/v6/zones/bankable_rewards openapi: 3.1.0 info: title: Reward Bank version: 1.0.0 description: >- Operations published by Extole Reward Bank components. Generated from the component contracts on my.extole.com. servers: - description: Production - your program domain url: https://{brand}.extole.io variables: brand: default: yourcompany description: >- Your Extole client subdomain (e.g. 'mycompany' for mycompany.extole.io) security: [] paths: /api/v6/zones/bankable_rewards: post: tags: - VIEW summary: Current Balance and Transaction History description: >- Returns what this person can redeem and what they have redeemed already: the rewards their balance currently reaches, the suppliers those can be redeemed with, the redemption history, and the parameters the bank is configured with. Rendered for the person the access token identifies, so a person only ever sees their own bank. operationId: get_bankable_rewards requestBody: required: true content: application/json: schema: type: object description: >- Optional data merged into the zone's rendering context. Send an empty object when there is nothing to add. application/x-www-form-urlencoded: schema: type: object description: >- Optional data merged into the zone's rendering context. Send an empty object when there is nothing to add. responses: '200': description: Success content: application/json: schema: type: object required: - data properties: data: type: object properties: eligible_rewards: type: array items: type: object properties: data: type: object description: The reward's own data entries. name: type: string description: Name of the reward. state: type: string description: >- Where the reward has reached. Only SENT and FULFILLED rewards are eligible to redeem. reward_id: type: string description: >- Identifier of the reward. This is what a redemption sends back in rewards. face_value: type: string description: >- Value of the reward, in the units face_value_type names. campaign_id: type: string description: Campaign that issued it. earned_date: type: string description: When the person earned it. expiry_date: type: string description: When it stops being redeemable. program_label: type: string description: Program the reward belongs to. face_value_type: type: string description: What that value is denominated in. partner_reward_id: type: string description: >- Your own identifier for the reward, when one was supplied. reward_supplier_id: type: string description: Supplier the reward came from. redeemed_reward_ids: type: array items: type: string description: >- For a redemption, the rewards that were spent to make it. description: A reward the person holds. description: >- Rewards this person's balance currently reaches, each redeemable on its own. reward_parameters: type: object properties: max_amount: type: number description: The largest total a redemption may be for. min_amount: type: number description: The smallest total a redemption may be for. face_value_type: type: array items: type: string description: >- The value types this bank accepts, one per supplier it draws from. ratio_of_value_to_dollars: type: number description: >- What one unit of face value is worth, for showing a total. description: How this bank is configured. redemption_history: type: array items: type: object properties: data: type: object description: The reward's own data entries. name: type: string description: Name of the reward. state: type: string description: Where the redemption reward has reached. reward_id: type: string description: >- Identifier of the redemption reward itself. Do not send it back in rewards: redeemed_reward_ids names the eligible rewards it spent. face_value: type: string description: >- Value of the reward, in the units face_value_type names. campaign_id: type: string description: Campaign that issued it. earned_date: type: string description: When the person earned it. expiry_date: type: string description: When it stops being redeemable. program_label: type: string description: Program the reward belongs to. face_value_type: type: string description: What that value is denominated in. partner_reward_id: type: string description: >- Your own identifier for the reward, when one was supplied. reward_supplier_id: type: string description: Supplier the reward came from. redeemed_reward_ids: type: array items: type: string description: >- For a redemption, the rewards that were spent to make it. description: >- A redemption the person has made. redeemed_reward_ids names the rewards it spent. description: >- Redemptions this person has already made, in the same shape as a held reward. Poll this after redeeming: a new entry appearing is how the redemption center knows one landed. redemption_suppliers: type: array items: type: object properties: name: type: string description: Name of the supplier, as the person sees it. type: type: string description: Kind of supplier. face_value_type: type: string description: What this supplier's rewards are denominated in. reward_supplier_id: type: string description: >- Identifier to send as reward_supplier_id when redeeming. description: >- What the balance can be redeemed for. One of these ids is what a redemption names. description: >- The person's reward bank as the redemption center reads it. description: >- A zone render, so the bank is inside the zone's data envelope rather than at the root. '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/RestExceptionResponse' examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestExceptionResponse' examples: access_denied: $ref: '#/components/examples/access_denied' expired_access_token: $ref: '#/components/examples/expired_access_token' invalid_access_token: $ref: '#/components/examples/invalid_access_token' jwt_authentication_error: $ref: '#/components/examples/jwt_authentication_error' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' security: - HEADER: [] - QUERY_PARAM: [] - COOKIE: [] servers: - description: Production - your program domain url: https://{brand}.extole.io variables: brand: default: yourcompany description: >- Your Extole client subdomain (e.g. 'mycompany' for mycompany.extole.io) components: schemas: RestExceptionResponse: type: object description: Represents the API error response properties: code: type: string description: Specific error code for this error type, documented per endpoint http_status_code: type: integer description: >- HTTP status code that was returned with this error, useful if client get response code message: type: string description: User readable English description of the error parameters: type: object description: >- Attributes related to the error, varies be error code, documented per endpoint additionalProperties: type: object description: >- Attributes related to the error, varies be error code, documented per endpoint unique_id: type: string description: >- Unique id associated with this error, useful for discussions with Extole required: - code - http_status_code - message - parameters - unique_id examples: binding_error: summary: binding_error value: unique_id: 00000000-0000-0000-0000-000000000000 http_status_code: 400 code: binding_error message: Argument is not of the expected type parameters: {} invalid_json: summary: invalid_json value: unique_id: 00000000-0000-0000-0000-000000000000 http_status_code: 400 code: invalid_json message: JSON is invalid parameters: {} invalid_parameter: summary: invalid_parameter value: unique_id: 00000000-0000-0000-0000-000000000000 http_status_code: 400 code: invalid_parameter message: Parameter is invalid. parameters: {} missing_request_body: summary: missing_request_body value: unique_id: 00000000-0000-0000-0000-000000000000 http_status_code: 400 code: missing_request_body message: Missing request body parameters: {} access_denied: summary: access_denied value: unique_id: 00000000-0000-0000-0000-000000000000 http_status_code: 403 code: access_denied message: >- The access_token provided is not permitted to access the specified resource. parameters: {} expired_access_token: summary: expired_access_token value: unique_id: 00000000-0000-0000-0000-000000000000 http_status_code: 403 code: expired_access_token message: The access_token provided with this request has expired. parameters: {} invalid_access_token: summary: invalid_access_token value: unique_id: 00000000-0000-0000-0000-000000000000 http_status_code: 403 code: invalid_access_token message: The access_token provided with this request is invalid. parameters: {} jwt_authentication_error: summary: jwt_authentication_error value: unique_id: 00000000-0000-0000-0000-000000000000 http_status_code: 403 code: jwt_authentication_error message: The jwt authentication failed. parameters: {} method_unauthorized: summary: method_unauthorized value: unique_id: 00000000-0000-0000-0000-000000000000 http_status_code: 403 code: method_unauthorized message: Access forbidden to this endpoint parameters: {} missing_access_token: summary: missing_access_token value: unique_id: 00000000-0000-0000-0000-000000000000 http_status_code: 403 code: missing_access_token message: No access_token was provided with this request. parameters: {} securitySchemes: HEADER: type: apiKey in: header name: Authorization description: >- A consumer access token, issued to a single person in the browser or app. Not a client access token - never send a client token from a consumer device. x-bearer-format: bearer QUERY_PARAM: type: apiKey in: query name: access_token description: >- A consumer access token, issued to a single person in the browser or app. Not a client access token - never send a client token from a consumer device. COOKIE: type: apiKey in: cookie name: extole_token description: >- A consumer access token, issued to a single person in the browser or app. Not a client access token - never send a client token from a consumer device. ```` ## Related topics - [Redeem Credits](/api-reference/feature-specific/reward-bank/action/redeem-credits.md) - [Reward Bank](/technical/platform-integrations/extensions/reward-bank.md) - [Stripe](/technical/partners/rewards-and-payments/stripe.md) - [Get a reward](/api-reference/rewards/get-a-reward.md) - [Financial Services](/technical/solutions/extole-solution-guides/financial-services/index.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.