> ## 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 sent ACH transactions

> List sent ACH transactions



## OpenAPI

````yaml openapi.json get /ach
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: 0.208.0
servers:
  - description: Sandbox (no real world financial impact)
    url: https://api-sandbox.synctera.com/v0
  - description: Production
    url: https://api.synctera.com/v0
security:
  - bearerAuth: []
tags:
  - description: Lookup merchant information
    name: Merchants
  - description: Requests to generate simulated webhooks
    name: Card Webhook Simulations
  - description: >-
      Account programs define configurations for payment rails and transaction
      capabilities across different account types.
    name: Account Programs
  - description: Simulate receiving ACH transactions and returns
    name: ACH Transaction Simulations
  - description: Requests for risk evaluation and decisioning
    name: Risk Evaluations
  - description: Requests to link and manage External Cards
    name: External Cards
  - description: |
      The disclosures resource is used to track the status of disclosures and
      ensure that all parties have been shown the necessary disclosures to meet
      regulatory obligations.
    name: Disclosures
  - description: Create and manage Cash Order and Cash Deposit transfers
    name: Cash Orders and Deposits (alpha)
  - description: Requests to initiate customer verification.
    name: KYC Verification (deprecated)
  - description: Request to create and manage users
    name: Users
  - description: See balance history
    name: BalanceHistory
  - description: >-
      Migration mappings associate resources from an old tenant identity with a
      new tenant identity.
    name: Migration Mappings
  - description: |
      The External Account resource is used for managing links to accounts
      that operate outside of the Synctera ecosystem.
    name: External Accounts
  - description: Requests to create and manage account products, including fees, interest.
    name: Account Products
  - description: Requests to create and manage webhooks
    name: Webhooks
  - description: Create and manage documents.
    name: Documents
  - description: >-
      Create and manage same currency and multi-currency international wire
      transfers
    name: International Wires (alpha)
  - description: Requests for transaction risk detection
    name: Transaction risk
  - description: >-
      Used to configure bank accounts for which synctera accounts are considered
      a "subledger" to
    name: Bank Account
  - description: Request to create and manage party groups and party group members
    name: Party Groups
  - description: Requests to manage addresses
    name: Addresses
  - description: Requests to manage monitoring subscriptions and alerts for customers.
    name: Monitoring
  - description: Requests to search and manage compliance searches
    name: Compliance Searches
  - description: Requests to create and manage customers
    name: Customers
  - description: |
      The internal account resource is used for managing links to internal
      accounts where the funds are managed by integrators.
    name: Internal Accounts
  - description: Create and manage spending controls
    name: Spend Controls
  - description: Retrieve user identity information
    name: Identity
  - description: Requests to manage banks
    name: Banks
  - description: |
      The Disclosures resource is used to track the status of disclosures and
      ensure that customers have been shown the necessary disclosures to meet
      regulatory obligations.
    name: Disclosures (deprecated)
  - description: Create and manage wire transfers
    name: Wires
  - description: Requests to issue and manage Cards
    name: Cards
  - description: Request to create and manage edd
    name: Trust
  - description: Request to enroll, renew, or cancel watchlist monitors
    name: Watchlist (deprecated)
  - description: Endpoints for modifying or fetching posting dates
    name: Posting Dates
  - description: Transaction lines API
    name: transactions
  - description: Request to create and manage accounts
    name: Accounts
  - description: Requests to create and manage notes
    name: Notes
  - description: Account Template
    name: Account Templates
  - description: API for effective balances
    name: effective_balances
  - description: Requests to create and manage personal ID configurations
    name: Personal ID Configuration
  - description: >
      A natural person (individual human) that is relevant to the Synctera
      platform in some way: e.g. a personal customer or a director/officer/owner
      of a business.
    name: Persons
  - description: >
      Represents the relationships between parties. A relationship can exist
      between personal customers, business customers, or non-customer
      persons/organizations.
    name: Relationships
  - description: >
      A legal entity (corporation, partnership, etc.) that is relevant to the
      Synctera platform in some way: a business customer or some other
      organization that has an ownership share in such a business customer.
    name: Businesses
  - description: Request to create and manage payment_schedules
    name: Cronut
  - description: Requests to manage partners
    name: Partners
  - description: Request to create and manage deposits using remote deposit capture
    name: Remote Check Deposit
  - description: Requests to create and manage API keys
    name: API Keys
  - description: Requests to create and manage ban rules
    name: Ban Rules
  - description: Admin API for Middesk configuration using the tenants API keys.
    name: Middesk
  - description: Request to create and manage exclusions
    name: Stately
  - description: Request to create and manage partner configurations
    name: Quickstart
  - description: Manage contacts for bank and fintech partners
    name: Contacts
  - description: Create and manage transactions
    name: Transactions
  - description: Request to create and manage rdc configurations
    name: RDC Config
  - description: Create and manage holds
    name: Hold
  - description: Requests to create and manage roles
    name: Roles
  - description: Simulate receiving Wire transactions and returns
    name: Wire Transaction Simulations
  - description: Requests to create licenses
    name: Licenses
  - description: Requests to Admins to grant permissions to user
    name: Request Permissions
  - description: Configure vendor secrets for egress requests
    name: Egress Gateway Vendor Secret CRUD API
  - description: Requests to screen parties against sanctions watchlists
    name: Sanctions Screening
  - description: Create and manage payments
    name: ACH
  - description: Requests to calculate and manage CRR
    name: CRR
  - description: Requests to search financial institutions
    name: Institutions (Beta)
  - description: Create and manage tenant configurations
    name: Tenant Configs
  - description: Create and manage sweep configurations
    name: Configs
  - description: >
      Represents the compliance rules that are used to verify certain kinds of
      money movement.
    name: Compliance Rules
  - description: Configure webhook secrets for egress requests
    name: Egress Gateway Webhook Secret CRUD API
  - description: Create and manage transactions
    name: Transactions (internal)
  - description: History
    name: History
  - description: Create and manage EFT Canada transfers
    name: EFT Canada (Beta)
  - description: Requests to generate simulated transactions
    name: Card Transaction Simulations
  - description: Requests to initiate customer verification.
    name: KYC/KYB Verifications
paths:
  /ach:
    summary: Sent ACH
    description: |
      The ACH object represents your sent ACH.
    get:
      tags:
        - ACH
      summary: List sent ACH transactions
      description: List sent ACH transactions
      operationId: listTransactionsOut
      parameters:
        - $ref: '#/components/parameters/incoming_ach_id'
        - $ref: '#/components/parameters/trace_nos'
        - $ref: '#/components/parameters/end_effective_date'
        - $ref: '#/components/parameters/start_effective_date'
        - $ref: '#/components/parameters/page_token'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/effective_date'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/outgoing_ach_list'
          description: List of sent ACH transactions.
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '500':
          $ref: '#/components/responses/internal_server_error'
components:
  parameters:
    incoming_ach_id:
      description: >-
        ID of the linked incoming ACH entry. This is filled only for outgoing
        ACH entries that are returns and links to the originally received
        incoming entry.
      in: query
      name: incoming_ach_id
      schema:
        example: b01db9c7-78f2-4a99-8aca-1231d32f9b96
        format: uuid
        type: string
    trace_nos:
      description: Comma-separated list of trace numbers to filter by. Maximum 100 values.
      explode: false
      in: query
      name: trace_nos
      schema:
        items:
          type: string
        maxItems: 100
        type: array
      style: form
    end_effective_date:
      description: End of the effective date range query
      in: query
      name: end_effective_date
      schema:
        example: '2022-03-25'
        format: date
        type: string
    start_effective_date:
      description: Start of the effective date range query
      in: query
      name: start_effective_date
      schema:
        example: '2022-03-15'
        format: date
        type: string
    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
    effective_date:
      description: Effective date of the transaction
      in: query
      name: effective_date
      schema:
        example: '2022-03-15'
        format: date
        type: string
  schemas:
    outgoing_ach_list:
      allOf:
        - properties:
            transactions:
              description: Array of sent ACH transactions.
              items:
                $ref: '#/components/schemas/outgoing_ach'
              type: array
          required:
            - transactions
          type: object
        - $ref: '#/components/schemas/paginated_response'
    outgoing_ach:
      description: Represents a sent ACH transaction.
      properties:
        account_id:
          description: >-
            Receiving account uuid. This links to the external account resource
            (represented by 'receiving_account_id' in the request to send
            outgoing ACH).
          example: b01db9c7-78f2-4a99-8aca-1231d32f9b96
          format: uuid
          type: string
        account_name:
          description: Receiving account name
          example: Bruce Wayne
          type: string
        account_no:
          description: Receiving account number
          example: '122455799'
          type: string
        amount:
          description: Transaction amount in cents
          example: 1560
          type: integer
        bank_id:
          example: 1
          type: integer
        company_entry_description:
          description: >-
            Company Entry Description field in ACH batch header. Originator
            inserts this field's value to provide the Receiver with a
            description of the entry's purpose. NACHA Operating Rules dictate
            that Payroll or E-Commerce Purchase ACH transactions require setting
            this field to PAYROLL or PURCHASE respectively.
          example: PAYROLL
          type: string
        company_name:
          description: Company Name field in ACH batch header.
          example: Asdf Finance
          type: string
        effective_date:
          description: Effective date of the transaction
          example: '2022-03-25'
          format: date
          type: string
        external_id:
          description: Transaction ID in the ledger
          example: b01db9c7-78f2-4a99-8aca-1231d32f9b96
          format: uuid
          type: string
        hold:
          $ref: '#/components/schemas/hold_data'
        id:
          example: b01db9c7-78f2-4a99-8aca-1231d32f9b96
          format: uuid
          type: string
        incoming_ach_id:
          description: >-
            ID of the linked incoming ACH entry. This is filled only for
            outgoing ACH entries that are returns and links to the originally
            received incoming entry.
          example: b01db9c7-78f2-4a99-8aca-1231d32f9b96
          format: uuid
          type: string
        is_same_day:
          description: Was initiated as same-day ACH transaction
          type: boolean
        memo:
          type: string
        partner_id:
          example: 2
          type: integer
        reference_info:
          description: Transaction reference info
          type: string
        return_data:
          $ref: '#/components/schemas/return_data'
        source_account_id:
          description: >-
            Originating account uuid. This links to the customer account on
            Synctera platform (represented by 'originating_account_id' in the
            request to send outgoing ACH).
          example: b01db9c7-78f2-4a99-8aca-1231d32f9b96
          format: uuid
          type: string
        source_account_name:
          description: Originating account name
          example: Thomas Anderson
          type: string
        source_account_no:
          description: Originating account number
          example: '123638791329'
          type: string
        status:
          enum:
            - CANCELED
            - COMPLETE
            - DECLINED
            - INIT
            - PENDING
          type: string
        trace_no:
          description: Trace number of the transaction
          example: '123456780000069'
          type: string
      required:
        - account_no
        - amount
        - bank_id
        - effective_date
        - external_id
        - id
        - is_same_day
        - memo
        - partner_id
        - source_account_no
        - status
        - trace_no
      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
    error:
      description: >-
        Synctera error responses in API v0 follow [RFC
        7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that
        standard, the field for a machine-readable "error code" in API v0 is
        `type`.

        In our future API v1, we are phasing out RFC 7807 and adopting a custom
        error format. That format will be documented in our API v1 spec. But you
        may see some v0 error responses with a machine-readable `code` field
        while we are making the transition from v0 to v1.
      properties:
        code:
          description: >-
            An optional “sneak preview” of our future API v1 error responses.
            This is provided to give integrators a chance to work with our
            future error codes. Error codes for the same error may change
            between v0 and v1.
          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: the HTTP status code for this response
          example: 400
          type: integer
        title:
          description: >
            A human-readable string for this general category of error, which
            corresponds 1-to-1 with error types (`title` is the human-readable
            version of `type`). There can be multiple distinct titles for the
            same HTTP status code, and the same `title` can result in many
            different `detail` strings.

            This field will be removed in API v1.
          example: Bad Request Body
          type: string
        type:
          description: >
            A machine-readable string that identifies the error for programmatic
            use. This is a URI, i.e. a globally unique identifier. It is _not_
            necessarily a URL, so do not expect it to resolve to a web page. You
            can use this whole string as an error code, or just everything after
            the last slash.

            This field will be removed in API v1.
          example: https://dev.synctera.com/errors/bad-request-body
          type: string
      title: Standard error response (RFC 7807 problem report)
      type: object
    hold_data:
      properties:
        amount:
          type: integer
        availability_time:
          example: '2010-05-06T12:23:34.321Z'
          format: date-time
          type: string
      required:
        - amount
        - availability_time
      type: object
    return_data:
      description: Filled if the entry is a return.
      properties:
        code:
          description: Return reason code, i.e. why is the entry being returned.
          example: R01
          type: string
        dishonored_return_code:
          description: >-
            Code of the original dishonored return (without "R"). Filled only if
            this is a contested return.
          example: '69'
          type: string
        dishonored_return_settlement_date:
          description: >-
            Settlement date of the original dishonored return. Filled only if
            this is a contested return. Formatted as an ordinal date, a single
            day-of-year number between 1-366.
          example: '256'
          type: string
        dishonored_return_trace:
          description: >-
            Trace number of the original dishonored return. Filled only if this
            is a contested return.
          example: '123456780000069'
          type: string
        field_errors:
          description: >-
            Required for return reason code R69. Contains the code(s) to
            indicate the field(s) in which erroneous information in the original
            return is located.
          example: '05'
          type: string
        original_dfi_no:
          description: Receiving financial institution of the original entry.
          example: '364275034'
          type: string
        original_trace:
          description: Trace number of the original entry that is being returned.
          example: '123456780000069'
          type: string
        return_code:
          description: >-
            Return reason code of the original return (just the number). Filled
            only if this is a dishonored return.
          example: '13'
          type: string
        return_settlement_date:
          description: >-
            Settlement date of the original return. Filled only if this is a
            dishonored return. Formatted as an ordinal date, a single
            day-of-year number between 1-366.
          example: '256'
          type: string
        return_trace:
          description: >-
            Trace number of the original return. Filled only if this is a
            dishonored return.
          example: '123456780000069'
          type: string
      required:
        - code
        - original_dfi_no
        - original_trace
      type: object
  responses:
    unauthorized:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
      description: Unauthorized
    forbidden:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
      description: Forbidden error
    internal_server_error:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
      description: Internal server error
  securitySchemes:
    bearerAuth:
      bearerFormat: api_key
      scheme: bearer
      type: http

````