> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # List reward configs > Get a paginated list of all reward configs ## OpenAPI ````yaml openapi-v1.json get /reward_configs openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 1.188.0 servers: - description: Production url: https://api.synctera.com/v1 - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v1 security: - bearerAuth: [] tags: - description: | Requests to create and manage Rewards name: Rewards (beta) - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Testing endpoints to simulate in-store cash deposits. Available in sandbox environments only. name: In-Store Cash Deposit Simulations - description: Create and manage spending controls name: Spend Controls (beta) - description: Rates name: Rates - description: Requests to create and manage webhooks name: Webhooks - description: Tenant Config name: Tenant Config - description: FDX authentication and data transfer using Plaid Core Exchange name: Plaid Core Exchange (beta) - description: Create and manage disputes name: Disputes - description: Requests to simulate card payments name: Card Simulations - description: >- Aggregated write-off amounts for lending accounts, computed from posted transactions. name: Write Off Amounts - description: | Manage fee products and fee configs for automated fee collection name: Fee Products - description: Apple Pay APIs name: Apple Pay - description: Lending Config name: Lending Config - description: Payments related to lending accounts name: Payments - description: Manage negative balance processes name: Negative Balance - description: Configuration for mapping LoanPro events to Payola transaction parameters name: LoanPro Transaction Event Config - description: Requests to generate simulated transactions name: Cash Transaction Simulations (alpha) - description: Create and manage transactions name: Transactions (beta) - description: Autopay payment records for billing periods name: Autopays - description: Create and manage accounts name: Accounts - description: | Requests to create and manage batch payments name: Batch Payments (alpha) - description: Billing rates name: Billing Rates - description: Bank Delinquency Configuration name: Bank Delinquency Configuration - description: >- Rules that map a posted payment transaction (bank/partner + transaction attributes) to a regulatory payment code. NULL match columns act as wildcards. name: Payment Code Configuration - description: Create and manage Synctera Pay templates name: SyncteraPay - description: | Manage reward products and reward configs for automated cashback rewards name: Reward Products - description: Requests to create and manage card disputes name: Card Disputes - description: >- Per bank/partner account-type mapping to FFIEC collateral codes used for regulatory call report furnishment. name: Collateral Code Configuration - description: Bulk card issuance name: Bulk Issuance - description: Autopay configuration management for lending accounts name: Autopay Configs - description: Request to create and manage exclusions name: Statements - description: Create and manage barcodes for in-store cash deposits name: In-Store Cash Deposits - description: Customer Service Details for disputes and billing inquiries name: Customer Service Details - description: Create a credit application. name: Applications (beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Billing period summaries name: Billing Period Summaries - description: Requests to issue and manage cards name: Cards - description: Push and pull from cards name: External Cards - description: | Requests to create and manage fees name: Fees (beta) paths: /reward_configs: summary: Reward Configs description: Manage reward configs for automated cashback rewards get: tags: - Reward Products summary: List reward configs description: Get a paginated list of all reward configs operationId: listRewardConfigs parameters: - explode: false in: query name: template_id schema: items: format: uuid type: string type: array style: form - explode: false in: query name: name schema: items: type: string type: array style: form - explode: false in: query name: status schema: items: $ref: '#/components/schemas/reward_product_status' type: array style: form - description: >- Case insensitive wildcard search for reward_category, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed. in: query name: reward_category_like schema: type: string - description: >- Case insensitive wildcard search for description, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed. in: query name: description_like schema: type: string - in: query name: from_creation_time schema: format: date-time type: string - description: >- Case insensitive wildcard search for name, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed. in: query name: name_like schema: type: string - explode: false in: query name: description schema: items: type: string type: array style: form - in: query name: from_last_updated_time schema: format: date-time type: string - description: >- Case insensitive wildcard search for status, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed. in: query name: status_like schema: type: string - in: query name: to_last_updated_time schema: format: date-time type: string - in: query name: reverse_with_parent schema: type: boolean - explode: false in: query name: tenant schema: items: $ref: '#/components/schemas/tenant_id' type: array style: form - $ref: '#/components/parameters/page_token' - explode: false in: query name: reward_category schema: items: $ref: '#/components/schemas/reward_category' type: array style: form - explode: false in: query name: sort_by schema: items: enum: - creation_time:asc - creation_time:desc - reward_category:asc - reward_category:desc type: string type: array style: form - $ref: '#/components/parameters/limit' - in: query name: to_creation_time schema: format: date-time type: string - explode: false in: query name: id schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/reward_config_list' description: List of reward configs '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_server_error' components: schemas: reward_product_status: enum: - active - inactive type: string tenant_id: description: | The id of the tenant containing the resource. example: abcdef_ghijkl type: string reward_category: description: > The category of event that triggers this reward. Trigger-based categories fire when a matching card transaction is posted. enum: - cashback:card:mcc type: string reward_config_list: allOf: - $ref: '#/components/schemas/paginated_response' - properties: reward_configs: description: Array of reward configs items: $ref: '#/components/schemas/reward_config_response' type: array required: - reward_configs type: object type: object paginated_response: properties: next_page_token: description: >- If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows. example: a8937a0d type: string title: Paginated List response type: object reward_config_response: allOf: - $ref: '#/components/schemas/reward_config_base' - required: - amount_config - creation_time - id - last_updated_time - name - reward_category - status - tenant - properties: creation_time: example: '2024-01-15T10:00:00Z' format: date-time readOnly: true type: string id: description: Unique identifier for this reward config. example: 5c943c51-e4ff-4e57-9558-08cab6b96398 format: uuid type: string last_updated_time: example: '2024-06-01T12:00:00Z' format: date-time readOnly: true type: string tenant: $ref: '#/components/schemas/tenant_id' type: object error: description: Synctera error responses in API v1 implement a custom error schema. properties: code: description: > A machine-readable string that identifies the error for programmatic use. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'Missing required fields: first_name, dob' type: string status: description: HTTP status code for this response example: 400 type: integer title: Synctera error response type: object reward_config_base: properties: amount_config: $ref: '#/components/schemas/fee_amount_config' description: description: Description of this reward rule. example: 1% cashback on all grocery purchases type: string name: description: Human-readable name for this reward rule. example: Grocery Store Cashback type: string reverse_with_parent: description: >- When true, reversals of the triggering transaction also reverse this reward. example: false type: boolean reward_category: $ref: '#/components/schemas/reward_category' reward_type: $ref: '#/components/schemas/reward_type' rule_config: $ref: '#/components/schemas/reward_rule_config' status: $ref: '#/components/schemas/reward_product_status' template_id: description: >- ID of the reward template that provides accounting setup for automated reward posting. Required for trigger-based rewards. example: 8b943c51-e4ff-4e57-9558-08cab6b96234 format: uuid type: string type: object fee_amount_config: description: | Amount calculation parameters for a fee config. amount_type determines which config field is used. properties: amount_type: $ref: '#/components/schemas/fee_amount_type' config: $ref: '#/components/schemas/fee_amount_config_details' required: - amount_type - config type: object reward_type: description: > How the reward is delivered to the account holder. instant_cashback = credited to the account on every qualifying transaction. Future types (not yet implemented): accrued_cashback, vendor_points. enum: - instant_cashback type: string reward_rule_config: description: | Category-specific rule parameters. Provide the field that matches the reward_config's reward_category; all other fields must be omitted. properties: mcc_cashback: $ref: '#/components/schemas/reward_rule_config_mcc_cashback' type: object fee_amount_type: enum: - fixed - percentage - transaction_amount_tiered type: string fee_amount_config_details: description: > Sub-config for fee amount calculation. The populated field must match the parent amount_type: fixed → fixed_amount, percentage → percentage, transaction_amount_tiered → transaction_amount_tiered. properties: fixed_amount: $ref: '#/components/schemas/fee_amount_fixed' percentage: $ref: '#/components/schemas/fee_amount_percentage' transaction_amount_tiered: $ref: '#/components/schemas/fee_amount_transaction_tiered' type: object reward_rule_config_mcc_cashback: description: | Rule config for the cashback:card:mcc category. An empty mcc_ranges list matches all merchant category codes. properties: mcc_ranges: description: >- MCC ranges that qualify for this reward. Empty list matches all MCCs. example: - lower: '5411' upper: '5499' items: $ref: '#/components/schemas/mcc_range' type: array type: object fee_amount_fixed: description: Fixed fee sub-config. properties: amount: description: Fee amount in minor currency units. example: 300 format: int64 type: integer required: - amount type: object fee_amount_percentage: description: Percentage fee sub-config. properties: basis_points: description: Percentage fee in basis points (e.g. 300 = 3%). example: 300 format: int64 type: integer required: - basis_points type: object fee_amount_transaction_tiered: description: Tiered fee sub-config. properties: tiers: description: Ordered list of tiers; last tier has no upper bound (up_to null). items: $ref: '#/components/schemas/fee_config_tier' type: array required: - tiers type: object mcc_range: description: | An inclusive range of MCC (Merchant Category Code) strings. Both bounds must be 4-digit ASCII (0000-9999) so lexicographic and numeric ordering agree. Server enforces lower <= upper. properties: lower: description: Lower bound of the MCC range (inclusive), 4-digit string. example: '5411' maxLength: 4 minLength: 4 pattern: ^\d{4}$ type: string upper: description: Upper bound of the MCC range (inclusive), 4-digit string. example: '5499' maxLength: 4 minLength: 4 pattern: ^\d{4}$ type: string required: - lower - upper type: object fee_config_tier: description: A single tier in a tiered fee structure. properties: amount_type: $ref: '#/components/schemas/fee_amount_type' config: $ref: '#/components/schemas/fee_scalar_amount' up_to: description: > Upper bound of the transaction amount (inclusive) in minor currency units. Null means this is the last (catch-all) tier with no upper bound. example: 10000 format: int64 nullable: true type: integer required: - amount_type - config type: object fee_scalar_amount: description: | Scalar (non-tiered) fee amount options. Exactly one of fixed_amount or percentage should be set. properties: fixed_amount: $ref: '#/components/schemas/fee_amount_fixed' percentage: $ref: '#/components/schemas/fee_amount_percentage' type: object parameters: page_token: in: query name: page_token schema: description: >- Optional pagination token to be provided to retrieve subsequent pages, returned from previous get example: a8937a0d type: string limit: in: query name: limit schema: default: 100 description: > Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100. example: 100 minimum: 1 type: integer responses: bad_request: content: application/json: schema: $ref: '#/components/schemas/error' description: Bad request unauthorized: content: application/json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/json: schema: $ref: '#/components/schemas/error' description: Forbidden internal_server_error: content: application/json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````