> ## 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 Incoming Synctera Pay Configurations



## OpenAPI

````yaml openapi-v1.json get /synctera_pay/incoming/configurations
openapi: 3.0.3
info:
  description: >-
    This is the official reference documentation for Synctera APIs. If you need
    something specific or have a question, <a class='text-blue-600'
    href='https://synctera.com/contact-us' target='_blank'
    rel='noreferrer'>contact us</a>.</p>
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: Synctera API
  version: 1.181.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: |
      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:
  /synctera_pay/incoming/configurations:
    get:
      tags:
        - Incoming SyncteraPay (beta)
      summary: List Incoming Synctera Pay Configurations
      operationId: listIncomingSyncteraPayConfigurations
      parameters:
        - in: query
          name: enabled
          schema:
            type: boolean
        - explode: false
          in: query
          name: settlement_account_id
          schema:
            items:
              format: uuid
              type: string
            type: array
          style: form
        - explode: false
          in: query
          name: currency
          schema:
            items:
              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: settlement_account_owner_id
          schema:
            items:
              format: uuid
              type: string
            type: array
          style: form
        - 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
        - in: query
          name: from_last_updated_time
          schema:
            format: date-time
            type: string
        - explode: false
          in: query
          name: sort_by
          schema:
            items:
              enum:
                - creation_time:asc
                - creation_time:desc
                - last_updated_time:asc
                - last_updated_time:desc
              type: string
            type: array
          style: form
        - in: query
          name: to_last_updated_time
          schema:
            format: date-time
            type: string
        - in: query
          name: payer_must_be_payee
          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'
        - $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/incoming_synctera_pay_configuration_list'
          description: List of Incoming Synctera Pay Configurations
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '500':
          $ref: '#/components/responses/internal_server_error'
components:
  schemas:
    tenant_id:
      description: |
        The id of the tenant containing the resource.
      example: abcdef_ghijkl
      type: string
    incoming_synctera_pay_configuration_list:
      allOf:
        - $ref: '#/components/schemas/paginated_response'
        - properties:
            configurations:
              items:
                $ref: >-
                  #/components/schemas/incoming_synctera_pay_configuration_response
              type: array
          required:
            - configurations
          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
    incoming_synctera_pay_configuration_response:
      properties:
        creation_time:
          description: The timestamp representing when the dispute was created
          example: '2010-05-06T12:23:34.321Z'
          format: date-time
          type: string
        currency:
          description: >-
            ISO 4217 Alpha-3 code representing the currency to be credited to
            the Synctera account.
          example: USD
          maxLength: 3
          minLength: 3
          type: string
        enabled:
          description: >-
            Determines if this Incoming Synctera Pay Configuration can be used
            to create new transfers.
          type: boolean
        id:
          description: The unique ID of the Incoming Synctera Pay configuration
          format: uuid
          type: string
        last_updated_time:
          description: The timestamp representing when the dispute was last modified
          example: '2010-05-06T12:23:34.321Z'
          format: date-time
          type: string
        name:
          description: User-supplied name for the configuration
          type: string
        payer_must_be_payee:
          description: >-
            If true, transfers using this config must have the same payer and
            payee ("me-to-me") and peer-to-peer transfers can not use this
            configuration.
          type: boolean
        settlement_account_id:
          description: >-
            Account used for settlement of all transfers that use this
            configuration.
          format: uuid
          type: string
        settlement_account_owner_id:
          description: >-
            Business or Person that owns the settlement account for all
            transfers that use this configuration.
          format: uuid
          type: string
        tenant:
          $ref: '#/components/schemas/tenant_id'
        transaction_subtype:
          $ref: '#/components/schemas/incoming_synctera_pay_subtype'
      required:
        - creation_time
        - currency
        - enabled
        - id
        - last_updated_time
        - name
        - payer_must_be_payee
        - settlement_account_id
        - settlement_account_owner_id
        - tenant
        - transaction_subtype
      title: Incoming Synctera Pay Configuration
      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
    incoming_synctera_pay_subtype:
      description: >-
        Transaction sub-type to be recorded in the Synctera ledger for
        transactions using this configuration.
      enum:
        - INCOMING_INTERNATIONAL_WIRE
      type: string
  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
    internal_server_error:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
      description: Internal server error
  securitySchemes:
    bearerAuth:
      bearerFormat: api_key
      scheme: bearer
      type: http

````