> ## 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. # Redeem Credits > Spends chosen rewards from this person's balance with one supplier, by submitting the reward bank's redeem event. The event is only accepted here - the redemption happens afterwards, and its outcome arrives as a signal rather than in this response. Read Current Balance and Transaction History until the redemption appears in redemption_history. ## OpenAPI ````yaml /feature-specific-apis/reward-bank.json post /events 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: /events: post: tags: - ACTION summary: Redeem Credits description: >- Spends chosen rewards from this person's balance with one supplier, by submitting the reward bank's redeem event. The event is only accepted here - the redemption happens afterwards, and its outcome arrives as a signal rather than in this response. Read Current Balance and Transaction History until the redemption appears in redemption_history. operationId: redeem_rewards requestBody: required: true content: application/json: schema: type: object required: - event_name - data properties: data: type: object required: - rewards - reward_supplier_id properties: labels: type: string description: The program label the redemption belongs to. rewards: type: array items: type: string description: >- The reward_id of each reward being spent, taken from eligible_rewards. reward_supplier_id: type: string description: >- The supplier to redeem with, taken from redemption_suppliers. description: What to redeem and what to redeem it for. event_name: enum: - redeem_rewards type: string description: >- Always redeem_rewards. This event is what the reward bank listens for. text/plain: schema: type: object required: - event_name - data properties: data: type: object required: - rewards - reward_supplier_id properties: labels: type: string description: The program label the redemption belongs to. rewards: type: array items: type: string description: >- The reward_id of each reward being spent, taken from eligible_rewards. reward_supplier_id: type: string description: >- The supplier to redeem with, taken from redemption_suppliers. description: What to redeem and what to redeem it for. event_name: enum: - redeem_rewards type: string description: >- Always redeem_rewards. This event is what the reward bank listens for. application/x-www-form-urlencoded: schema: type: object required: - event_name - data properties: data: type: object required: - rewards - reward_supplier_id properties: labels: type: string description: The program label the redemption belongs to. rewards: type: array items: type: string description: >- The reward_id of each reward being spent, taken from eligible_rewards. reward_supplier_id: type: string description: >- The supplier to redeem with, taken from redemption_suppliers. description: What to redeem and what to redeem it for. event_name: enum: - redeem_rewards type: string description: >- Always redeem_rewards. This event is what the reward bank listens for. multipart/form-data: schema: type: object required: - event_name - data properties: data: type: object required: - rewards - reward_supplier_id properties: labels: type: string description: The program label the redemption belongs to. rewards: type: array items: type: string description: >- The reward_id of each reward being spent, taken from eligible_rewards. reward_supplier_id: type: string description: >- The supplier to redeem with, taken from redemption_suppliers. description: What to redeem and what to redeem it for. event_name: enum: - redeem_rewards type: string description: >- Always redeem_rewards. This event is what the reward bank listens for. responses: '200': description: Success content: application/json: schema: type: object required: - id properties: id: type: string description: >- Identifier of the redeem event. The outcome is published as a signal named success or error against reward-, and an error signal carries the reason in its data.message. The browser library renames this field to event_id, so a caller reading the raw response reads id. description: >- Acceptance of the event, not the result of the redemption. A redemption that cannot go through - too little balance, a reward no longer redeemable - still answers here and fails afterwards. '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 - [Reward Bank](/technical/platform-integrations/extensions/reward-bank.md) - [Get reward redeems](/api-reference/rewards/get-reward-redeems.md) - [Boulevard (BLVD)](/technical/partners/appointment-management/boulevard-blvd.md) - [API Overview](/api-reference/getting-started/api-overview.md) - [Rewards Overview and FAQ](/guides/rewards-management/setting-up-your-rewards/rewards-overview-and-faq.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.