openapi: 3.1.0
info:
  title: Business Transfers Administration
  description: |-
    This API provides administrative applications access to business transfers for the financial institution.

    This API provides the following operations:
      * [`getBusinessTransfers`](#op-getBusinessTransfers) to return details of
        business ACH debit/credit batches. In this release of the API, only ACH
        transfers are supported, not wires or NACHA pass through files.
      * [`getWireTransferAccounts`](#op-getWireTransferAccounts)
        to look up the source and target accounts for wire transfers.

    The operations in this API are authorized with the OAuth2 Client Credentials flow. Clients must be secure server-side applications, not web or mobile applications.
  version: 0.5.0
  contact:
    name: Apiture
    url: https://developer.apiture.com/help/support/
    email: api@apiture.com
  termsOfService: https://developer.apiture.com/docs/Apiture-API-License-Agreement.pdf
  license:
    name: Apiture API License
    url: https://developer.apiture.com/docs/Apiture-API-License-Agreement.pdf
x-apiture-namespace: bankingAdminBusinessTransfers
servers:
  - url: /bankingAdmin
tags:
  - name: Business Transfers Administration
    description: Banking Business Transfers Administration
paths:
  /businessTransfers:
    get:
      operationId: getBusinessTransfers
      x-apiture-api: bankingAdminBusinessTransfers
      summary: Return a list of specific business transfer resources.
      description: Return the details of a list of business transfers resources for the IDs passed in the `transfers` request parameter.
      x-apiture-note: This uses the `operationId` `getBusinessTransfers` to reserve the `operationId` `listBusinessTransfers` for a future generic paginated/filtered collection operation. This operation is more specialized by accepting a fixed list of business transfer IDs to fetch. The response schemas for this operation uses the name `businessTransferList` to reserve the schema name `businessTransfers` for that (possible future) `listBusinessTransfers` operation's paginated response.
      tags:
        - Business Transfers Administration
      x-apiture-group: adminBusinessTransfers
      parameters:
        - name: transfers
          description: Fetch business transfer details for the business transfers identified in this comma-separated list of IDs.
          in: query
          required: true
          style: form
          explode: false
          schema:
            $ref: '#/components/schemas/businessTransferIdSelection'
      security:
        - clientCredentials:
            - bankingAdmin/read
      responses:
        '200':
          description: OK. The response contains the account information for the requested account IDs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/businessTransferList'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/clientCredentials403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          description: |-
            Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

            This problem response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidBusinessTransferIds/v1.0.0`](https://static.api.apiture.com/errors/invalidBusinessTransferIds/v1.0.0)<br>
              One or more business transfer IDs are invalid and do not correspond to any business transfers.
              Remediation: Remove the invalid business transfer IDs from the request and try again.
            The `attributes` object in the error may have the properties defined for [`invalidBusinessTransferIds`](https://static.api.apiture.com/errors/invalidBusinessTransferIds/v1.0.0).
          x-apiture-errors:
            - invalidBusinessTransferIds
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /businessTransfers/{businessTransferId}/achBatchInstructions:
    parameters:
      - $ref: '#/components/parameters/businessTransferIdPathParam'
    get:
      summary: Return a list of ACH business transfer batch instructions
      description: Return a collection of debit/credit instructions for an ACH batch business transfer.
      operationId: listBusinessTransferAchBatchInstructions
      x-apiture-api: bankingAdminBusinessTransfers
      x-apiture-group: adminBusinessTransfersAchBatchInstructions
      tags:
        - Business Transfers Administration
      responses:
        '200':
          description: |
            Ok.

            This response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/missingPaymentInstructionAmount/v1.0.0`](https://static.api.apiture.com/errors/missingPaymentInstructionAmount/v1.0.0)<br>
              The payment amount for this instruction is missing.
              Remediation: Set a valid, non-zero payment amount.
          x-apiture-errors:
            - $ref: '#/components/x-apiture-errors/missingPaymentInstructionAmount'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/businessTransferAchBatchInstructions'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/clientCredentials403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          description: |
            Conflict. The request conflicts with the state of the application.

            This problem response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/paymentInstructionsNotAvailable/v1.0.0`](https://static.api.apiture.com/errors/paymentInstructionsNotAvailable/v1.0.0)<br>
              Payment instructions are not available for NACHA pass-through payments.
              Remediation: Do not access payment instructions for NACHA pass-through payments.
          x-apiture-errors:
            - $ref: '#/components/x-apiture-errors/paymentInstructionsNotAvailable'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - clientCredentials:
            - bankingAdmin/read
  /wireTransferAccounts:
    parameters:
      - $ref: '#/components/parameters/institutionIdHeaderParam'
    post:
      summary: Get accounts for a list of wire transfers.
      description: |-
        Return the source and target (beneficiary) account location and account numbers for one or more wire transfers. The operation allows looking up wire transfer either by the wire transfer resource ID or by tracking numbers.

        This operation applies a "`GET` over `POST`" pattern: it is a safe, idempotent operation, but passes data via a request body rather than via query parameters.
      tags:
        - Business Transfers Administration
      operationId: getWireTransferAccounts
      x-apiture-api: bankingAdminBusinessTransfers
      x-apiture-group: adminWireTransfers
      security:
        - clientCredentials:
            - bankingAdmin/read
      requestBody:
        required: true
        description: A list of wire transfer IDs.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/wireTransferReferences'
      responses:
        '200':
          description: OK. The response is the mapping of the requested wire transfer references to wire transfer source and target accounts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wireTransferAccountsList'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/clientCredentials403'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
components:
  parameters:
    businessTransferIdPathParam:
      name: businessTransferId
      description: The unique identifier of a business transfer. This is an opaque string.
      in: path
      schema:
        $ref: '#/components/schemas/resourceId'
      required: true
    institutionIdHeaderParam:
      name: Institution-Id
      description: The unique identifier of the financial institution.
      in: header
      schema:
        $ref: '#/components/schemas/institutionId'
      x-resolved-from: ../../common/openapi.yaml#/components/parameters/institutionIdHeaderParam
  schemas:
    businessTransferAchBatchInstructions:
      x-apiture-version: 1.1.1
      $comment: This API uses the resource name "businessTransfer" rather than "paymentBatch" as is used in the Payments API. This prevents conflicting schema names.
      title: ACH Batch Instruction Collection (v1.1.1)
      description: Collection of payment instructions for an ACH business transfer batch. The items in the collection are ordered in the `items` array.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            items:
              description: An array of ACH payment batch instructions.
              type: array
              maxItems: 1000
              items:
                $ref: '#/components/schemas/businessTransferInstructionItem'
      example:
        items:
          - id: 0399abed-fd3d
            traceNumber: 8706658
            name: Pauline Stonemason
            identifier: C-00523
            amount: '1287.65'
            hold: false
            direction: credit
            ach:
              routingNumber: '123123123'
              accountNumber: '123456789'
              accountType: checking
              reversed: false
              canceled: false
              prenote: false
            methodId: ach0001
            contactId: 3e8375b1-8c34
          - id: 0399abed-fd3d
            traceNumber: 8764783
            name: Pauline Stonemason
            identifier: C-012295
            amount: '2090.35'
            hold: false
            direction: credit
            ach:
              routingNumber: '123123123'
              accountNumber: '234567890'
              accountType: checking
              reversed: false
              canceled: false
              prenote: false
    businessTransferInstructionItem:
      x-apiture-version: 1.1.1
      title: Business Transfer Instruction Item (v1.1.1)
      description: Summary representation of a payment instruction resource in payment instructions collections.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/paymentInstructionFields'
        - $ref: '#/components/schemas/paymentInstructionCommonFields'
        - type: object
          required:
            - id
            - name
            - amount
            - direction
            - hold
            - traceNumber
          properties:
            id:
              description: The unique identifier for this payment instruction resource. This is an immutable opaque string.
              $ref: '#/components/schemas/resourceId'
            traceNumber:
              description: A unique non-negative integer for tracing this payment through the payment system. This is an immutable opaque string of digits, assigned by the system.
              readOnly: true
              type: integer
              format: int32
              minimum: 1
              maximum: 999999999
            direction:
              description: Indicates if this item is a debit or credit, relative to this payment contact. This field is immutable.
              readOnly: true
              allOf:
                - $ref: '#/components/schemas/paymentInstructionDirection'
            ach:
              description: The payment instruction details for an ACH batch business payment. This field is used only if the business transfer `type` is `ach`.
              $ref: '#/components/schemas/achBusinessTransferInstruction'
      example:
        id: 0399abed-fd3d
        traceNumber: 8706658
        name: Pauline Stonemason
        identifier: C-00523
        amount: '1287.65'
        hold: false
        direction: credit
        ach:
          routingNumber: '123123123'
          accountNumber: '123456789'
          type: checking
          prenote: false
          reversed: false
          canceled: false
        methodId: ach0001
        contactId: 3e8375b1-8c34
    achBusinessTransferInstruction:
      title: ACH Batch Instruction (v1.0.0)
      description: The payment bank account number and routing number for paying or drafting from a contact's account by ACH.
      type: object
      required:
        - accountNumber
        - routingNumber
        - prenote
        - canceled
        - reversed
      properties:
        routingNumber:
          description: The financial institution routing number to be used for the payment.
          $ref: '#/components/schemas/accountRoutingNumber'
        accountNumber:
          description: The financial institution full account number to be used for the payment.
          $ref: '#/components/schemas/fullAchAccountNumber'
        accountType:
          description: The type of banking account for the financial institution, if known.
          $ref: '#/components/schemas/achPaymentMethodAccountType'
        addenda:
          description: Addenda records.
          type: array
          minItems: 0
          maxItems: 9999
          items:
            type: string
            maxLength: 80
            format: text
        prenote:
          description: 'If `true`, this item requires prenote validation to validate the routing number and account number. When submitting a prenote batch from a business transfer, all the ACH instructions tagged with `prenote: true` are submitted with `amount: "0.00"`.'
          type: boolean
        canceled:
          description: '`true` if the payment instruction was canceled.'
          type: boolean
        reversed:
          description: '`true` if the payment instruction was reversed.'
          type: boolean
        rePresentedCheck:
          description: |-
            A re-presented check (RCK) ACH payment instruction. This field is only used if the payment `direction` is `debit` and the payment `secCode` is `rck`.

            This object is omitted when in a `paymentInstructionItem`, even if the item is a RCK instance.
          $ref: '#/components/schemas/rePresentedCheck'
      example:
        routingNumber: '123123123'
        accountNumber: '123456789'
        accountType: checking
        reversed: false
        canceled: false
        prenote: false
      x-apiture-version: 1.0.0
    businessTransferIdSelection:
      title: Business Transfer ID Selection (v1.0.0)
      description: A comma-separated list of unique opaque business transfer IDs. Each value is the `id` of a resource in the Payments API. The list is limited to 100 business transfer IDs.
      type: array
      minItems: 1
      maxItems: 100
      $comment: This maxItems must match businessTransferList.items.maxItems
      uniqueItems: true
      items:
        $ref: '#/components/schemas/resourceId'
      example:
        - 6f2625952ad00ef4f701
        - f73e992e4230a6e8ef64
        - d1aa5570846beb619dfa
        - ed202975b84b7acd5161
        - b39069bdbc65c83c58ed
      x-apiture-version: 1.0.0
    businessTransferList:
      x-apiture-version: 1.1.0
      title: Business Transfer List (v1.1.0)
      description: A list of business transfers.
      type: object
      required:
        - items
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          required:
            - items
          properties:
            items:
              description: An array of business transfers.
              minItems: 1
              maxItems: 100
              $comment: This maxItems must match businessTransferIdSelection.maxItems
              type: array
              items:
                $ref: '#/components/schemas/businessTransferItem'
      example:
        items:
          - id: 0399abed-fd3d
            type: ach
            state: pendingApproval
            toSummary: 12 payees
            fromSummary: Payroll Checking *7890
            direction: credit
            customerId: d1b95731fb029fec062c
            ach:
              secCode: ppd
              companyName: Well's Roofing
              imported: false
              sameDay: false
              confidentialCustomers:
                - id: 64446f8d-780f
                  name: Philip F. Duciary
                - id: 58853981-24bb
                  name: Alice A. Tuary
              approvalDueAt: '2022-06-09T20:30:00.000Z'
              sameDayApprovalDue:
                - '2022-06-09T15:00:00.000Z'
                - '2022-06-09T18:00:00.000Z'
                - '2022-06-09T20:30:00.000Z'
            trackingNumber: '15474162'
            remainingApprovalsCount: 2
            approvalCount: 1
            creditTotal: '2640.60'
            debitTotal: '0.00'
            creditCount: 12
            debitCount: 30
            reversalDebitTotal: '0.00'
            reversalCreditTotal: '0.00'
            settlementAccount:
              label: Payroll Checking *7890
              maskedNumber: '*7890'
              id: bf23bc970-91e8
              risk: normal
            schedule:
              scheduledOn: '2023-05-01'
              effectiveOn: '2023-04-30'
            createdAt: '2023-04-28T07:48:20.375Z'
            updatedAt: '2023-04-28T07:48:49.375Z'
            createdBy:
              id: 0399abed-fd3d
              name: Benny Billings
              username: bbillings
            updatedBy:
              id: 0399abed-fd3d
              name: Benny Billings
              username: bbillings
    businessTransferItem:
      x-apiture-version: 1.1.0
      title: Business Transfer Item (v1.1.0)
      description: Overview of a business transfer.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/paymentBatchCommonFields'
        - $ref: '#/components/schemas/paymentBatchFields'
        - $ref: '#/components/schemas/paymentBatchSummaryFields'
        - $ref: '#/components/schemas/timestampFields'
        - type: object
          required:
            - id
            - type
            - state
            - direction
            - creditTotal
            - debitTotal
            - creditCount
            - debitCount
            - reversalCreditTotal
            - reversalDebitTotal
            - trackingNumber
            - remainingApprovalsCount
            - approvalCount
            - customerId
            - createdAt
            - updatedAt
            - createdBy
            - updatedBy
          properties:
            type:
              $ref: '#/components/schemas/paymentBatchType'
            reversalCreditTotal:
              description: The total of all credit payment instructions that have been reversed.
              allOf:
                - $ref: '#/components/schemas/creditOrDebitValue'
              readOnly: true
              example: '2467.50'
            reversalDebitTotal:
              description: The total of all credit payment instructions that have been reversed.
              allOf:
                - $ref: '#/components/schemas/creditOrDebitValue'
              readOnly: true
              example: '2467.50'
            ach:
              description: ACH-specific details of the business transfer. This object is present if and only if the business transfer's `type` is `ach`.
              readOnly: true
              allOf:
                - $ref: '#/components/schemas/achPaymentBatch'
      example:
        id: 0399abed-fd3d
        type: ach
        state: pendingApproval
        toSummary: 12 payees
        fromSummary: Payroll Checking *7890
        direction: credit
        customerId: d1b95731fb029fec062c
        ach:
          secCode: ppd
          companyName: Well's Roofing
          imported: false
          sameDay: false
          confidentialCustomers:
            - id: 64446f8d-780f
              name: Philip F. Duciary
            - id: 58853981-24bb
              name: Alice A. Tuary
          approvalDueAt: '2022-06-09T20:30:00.000Z'
          sameDayApprovalDue:
            - '2022-06-09T15:00:00.000Z'
            - '2022-06-09T18:00:00.000Z'
            - '2022-06-09T20:30:00.000Z'
        trackingNumber: '15474162'
        remainingApprovalsCount: 2
        approvalCount: 1
        creditTotal: '2640.60'
        debitTotal: '0.00'
        creditCount: 12
        debitCount: 30
        reversalDebitTotal: '0.00'
        reversalCreditTotal: '0.00'
        settlementAccount:
          label: Payroll Checking *7890
          maskedNumber: '*7890'
          id: bf23bc970-91e8
          risk: normal
        schedule:
          scheduledOn: '2023-05-01'
          effectiveOn: '2023-04-30'
        createdAt: '2023-04-28T07:48:20.375Z'
        updatedAt: '2023-04-28T07:48:49.375Z'
        createdBy:
          id: 0399abed-fd3d
          name: Benny Billings
          username: bbillings
        updatedBy:
          id: 0399abed-fd3d
          name: Benny Billings
          username: bbillings
    wireTransferReference:
      title: Wire Transfer Reference (v1.0.0)
      description: The resource ID or tracking number of a wire transfer.
      type: string
      pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
      minLength: 6
      maxLength: 48
      x-apiture-version: 1.0.0
    wireTransferReferences:
      x-apiture-version: 1.0.2
      title: Wire Transfer References (v1.0.2)
      description: A list of unique wire transfer references. Each value contains either the resource ID or tracking number of a wire transfer.
      type: object
      required:
        - items
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            items:
              description: The array of wire transfer IDs or tracking numbers.
              type: array
              minItems: 1
              $comment: This maxItems must match wireTransferAccountsList.items.maxItems
              maxItems: 1000
              uniqueItems: true
              items:
                $ref: '#/components/schemas/wireTransferReference'
      example:
        items:
          - 9fe04b71360e2a1a1293
          - dc617d4fd715bac02ee1
          - '678345003'
          - '103678345'
    wireTransferSourceAccountReference:
      x-apiture-version: 1.0.1
      title: Wire Transfer Source Account Reference (v1.0.1)
      description: Identifying properties of a wire transfer source account.
      type: object
      required:
        - id
        - accountNumber
      properties:
        id:
          description: |-
            The unique identifier for the source (debit) account resource.

            If the source account is no longer available (for example, it has been closed and then removed from the system), the `id` value `no-such-account` is returned.
          $ref: '#/components/schemas/readOnlyResourceId'
        accountNumber:
          description: The full account number of the source (debit) account.
          $ref: '#/components/schemas/fullAccountNumber'
      example:
        id: 89b19e14f7b602d79240
        accountNumber: '123456789'
    wireTransferBeneficiaryAccountReference:
      x-apiture-version: 2.0.0
      title: Wire Transfer Beneficiary Account Reference (v2.0.0)
      description: The beneficiary's (target) account where the wire transfer is transferred (credited).
      type: object
      required:
        - locatorType
        - accountNumber
      properties:
        locator:
          description: The [American Bankers Association routing number](https://www.aba.com/about-us/routingnumber), [SWIFT Business Identifier Code (BIC) code](https://www.swift.com/standards/data-standards/bic-business-identifier-code), or [IBAN account number](https://www.ecbs.org/iban.htm) of the financial institution hosting the wire transfer beneficiary's (target) account.
          type: string
          maxLength: 36
          format: text
        locatorType:
          description: The type of the `locator` used to identify the financial institution hosting the wire transfer beneficiary's (target) account.
          $ref: '#/components/schemas/wireTransferInstitutionLocatorType'
        accountNumber:
          description: The account number for the beneficiary's (target) account. For domestic wire transfers, this is the US Bank Account number. For international wire transfers, this is the International Bank Account Number (IBAN).
          type: string
          format: text
          maxLength: 50
      example:
        locatorType: abaRoutingNumber
        locator: '123123123'
        accountNumber: '123456789'
    wireTransferAccounts:
      x-apiture-version: 2.0.0
      title: Wire Transfer Accounts (v2.0.0)
      description: The source and target (beneficiary) banking accounts associated with a wire transfer. If no wire transfer exists for the wire transfer reference given in the request body, only the `notFound` property is present.
      type: object
      properties:
        id:
          description: The ID of the requested wire transfer resource.
          $ref: '#/components/schemas/readOnlyResourceId'
        trackingNumber:
          description: An optional tracking number for wire transfer. Unlike the `id`, this numeric value is visible to the customer and is used to track the wire transfer in downstream processing.
          $ref: '#/components/schemas/paymentBatchTrackingNumber'
        sourceAccount:
          description: The source account where funds are debited for the wire transfer.
          $ref: '#/components/schemas/wireTransferSourceAccountReference'
        targetAccount:
          description: The target (beneficiary) account where the wire transfer funds are transferred.
          $ref: '#/components/schemas/wireTransferBeneficiaryAccountReference'
        notFound:
          description: The reference (ID or tracking number) of a wire transfer that was not found for the financial institution. This property is only present if no wire transfer was found for the corresponding wire transfer reference in the request.
          $ref: '#/components/schemas/wireTransferReference'
      example:
        id: 9fe04b71360e2a1a1293
        trackingNumber: '122966'
        sourceAccount:
          id: 89b19e14f7b602d79240
          accountNumber: '123456789'
        targetAccount:
          locatorType: abaRoutingNumber
          locator: '123123123'
          accountNumber: '1123456789'
    wireTransferAccountsList:
      x-apiture-version: 2.0.0
      title: Wire Transfer Accounts List (v2.0.0)
      description: The source and target (beneficiary) banking accounts associated with a list of wire transfers. The `items` in the response correspond 1-to-1 with the each query value in the request. If no wire transfer exists for the wire transfer reference in the request body, only the `notFound` property is present in the corresponding response item; the `notFound` value is the corresponding wire transfer reference from the request. (In the example, no wire transfer was found for the input values `'dc617d4fd715bac02ee1'` and `'678345003'`.)
      type: object
      required:
        - items
      properties:
        items:
          description: The array of details about the requested wire transfers' source and target accounts.
          type: array
          minItems: 1
          $comment: This maxItems must match wireTransferReferences.items.maxItems
          maxItems: 1000
          items:
            $ref: '#/components/schemas/wireTransferAccounts'
      example:
        items:
          - id: 9fe04b71360e2a1a1293
            trackingNumber: '122966'
            sourceAccount:
              id: 89b19e14f7b602d79240
              accountNumber: '123456789'
            targetAccount:
              locatorType: abaRoutingNumber
              locator: '123123123'
              accountNumber: '1123456789'
          - notFound: dc617d4fd715bac02ee1
          - notFound: '678345003'
          - id: bab5c032f56dfe535680
            trackingNumber: '103678345'
            sourceAccount:
              id: 89b19e14f7b602d79240
              accountNumber: '123456789'
            targetAccount:
              locatorType: swiftBicCode
              accountNumber: BARCGB22113
    problemResponse:
      title: Problem Response (v0.4.1)
      x-apiture-version: 0.4.1
      description: API problem or error response, as per [RFC 9457 application/problem+json](https://tools.ietf.org/html/rfc9457).
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/apiProblem'
      example:
        id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
        type: https://static.api.apiture.com/errors/noSuchAccount/v1.0.0
        title: Account Not Found
        status: 422
        occurredAt: '2022-04-25T12:42:21.375Z'
        detail: No account exists for the given account reference
        instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/problemResponse
    resourceId:
      x-apiture-version: 1.0.1
      title: Resource Identifier (v1.0.1)
      description: The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.
      type: string
      pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
      minLength: 6
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/resourceId
    institutionId:
      x-apiture-version: 1.1.0
      title: Institution ID (v1.1.0)
      description: The unique immutable identifier of a financial institution.
      type: string
      pattern: ^[A-Z0-9_]{2,8}$
      maxLength: 8
      minLength: 2
      example: TIBURON
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/institutionId
    abstractBody:
      title: Abstract Body (v0.2.0)
      x-apiture-version: 0.2.0
      description: An abstract schema used to define other request and response body model schemas.
      x-apiture-fragment: true
      type: object
      properties: {}
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/abstractBody
    paymentInstructionFields:
      x-apiture-version: 2.0.0
      title: Payment Instruction Fields (v2.0.0)
      description: Common fields of the payment instruction resource used to build other model schemas.
      x-apiture-fragment: true
      type: object
      properties:
        name:
          description: The name of the payment contact being paid or drafted.
          type: string
          minLength: 1
          maxLength: 35
          format: text
        identifier:
          description: A optional string, such as an employee ID, which distinguishes this payment contact from others with the same `name`.
          type: string
          maxLength: 15
          format: text
        amount:
          description: The amount of money to send or draft from this payment contact.
          $ref: '#/components/schemas/monetaryValue'
        contactId:
          description: If this payment instruction is derived from a contact in the list of payment contacts, this is the contact's `id`.
          $ref: '#/components/schemas/resourceId'
        methodId:
          description: If this payment instruction is derived from a contact in the list of payment contacts, this is the `id` of that contact's payment method.
          $ref: '#/components/schemas/resourceId'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentInstructionFields
    paymentInstructionCommonFields:
      title: Payment Instruction Common Fields (v1.0.0)
      description: Common fields of the payment instruction resource used to build other model schemas.
      x-apiture-fragment: true
      type: object
      properties:
        hold:
          description: If `true`, do not process this instruction.
          type: boolean
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentInstructionCommonFields
      x-apiture-version: 1.0.0
    paymentInstructionDirection:
      title: Payment Instruction Direction (v1.0.0)
      description: |+
        Indicates the direction of money flow for a payment instruction.

        <strong><code>paymentInstructionDirection</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>credit</code></strong></td><td>credit: <p>Payment is a credit in the external account, debit to the settlement account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>debit</code></strong></td><td>debit: <p>Payment is a debit in the external account, credit to the settlement account</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: paymentInstructionDirection
      enum:
        - credit
        - debit
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentInstructionDirection
      x-apiture-version: 1.0.0
    accountRoutingNumber:
      title: Account Routing Number (v1.0.0)
      description: An account ABA routing and transit number.
      type: string
      minLength: 9
      maxLength: 9
      pattern: ^[0-9]{9}$
      example: '123123123'
      x-resolved-from: ../../accounts/openapi.yaml#/components/schemas/accountRoutingNumber
      x-apiture-version: 1.0.0
    fullAchAccountNumber:
      title: Full ACH Account Number (v1.0.0)
      description: A full account number used in ACH account processing.
      type: string
      minLength: 2
      maxLength: 17
      pattern: ^[- a-zA-Z0-9.]{2,17}$
      examples:
        - '123456789'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/fullAchAccountNumber
      x-apiture-version: 1.0.0
    achPaymentMethodAccountType:
      x-apiture-version: 1.1.0
      title: ACH Payment Method Account Type (v1.1.0)
      description: |+
        The product type of the ACH payment method account.

        <strong><code>achPaymentMethodAccountType</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>checking</code></strong></td><td>Checking: <p>The ACH payment method is sourced from a checking account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>savings</code></strong></td><td>Savings: <p>The ACH payment method is sourced from a savings account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>loan</code></strong></td><td>Loan: <p>The ACH payment method is sourced from a loan account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>generalLedger</code></strong></td><td>General Ledger: <p>The ACH payment method is sourced from a general ledger account</p>
        </td>
            </tr>
        </table>

      type: string
      enum:
        - checking
        - savings
        - loan
        - generalLedger
      x-apiture-enum: achPaymentMethodAccountType
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/achPaymentMethodAccountType
    rePresentedCheck:
      x-apiture-version: 1.1.0
      title: Re-Presented Check (v1.1.0)
      description: A re-presented check (RCK) ACH payment instruction. An RCK instruction represents a check that was returned for non-sufficient or uncollected funds and is being presented again for payment.
      allOf:
        - $ref: '#/components/schemas/rePresentedCheckFields'
      required:
        - checkNumber
      example:
        checkNumber: 43318
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/rePresentedCheck
    paymentBatchCommonFields:
      x-apiture-version: 1.1.0
      title: Payment Batch Common Fields (v1.1.0)
      description: Common fields of payment batch objects, used to compose other schemas.
      x-apiture-fragment: true
      type: object
      properties:
        id:
          description: The unique identifier for this payment batch resource. This is an immutable opaque string.
          $ref: '#/components/schemas/readOnlyResourceId'
        trackingNumber:
          description: A unique tracking number for this batch. Unlike the `id`, this numeric value is visible to the customer, and can be used to lookup a batch by this ID.
          $ref: '#/components/schemas/paymentBatchTrackingNumber'
        fromSummary:
          description: A short summary string describing where the payment batch originates, such as a description of the settlement account for `credit` payments, or for `debit` payments, a description of the draft account (if only one) or the number of payees.
          type: string
          format: text
          maxLength: 80
          readOnly: true
        toSummary:
          description: A short summary string describing where the funds are credited, such as a description of the settlement account for `debit` payments, or for `credit` payments, a description of the payee (if only one) or the number of payees.
          type: string
          format: text
          maxLength: 80
          readOnly: true
        state:
          description: The state of this payment batch.
          readOnly: true
          allOf:
            - $ref: '#/components/schemas/paymentBatchState'
        reasonCode:
          description: The reason code associated with the payment batch state.
          readOnly: true
          allOf:
            - $ref: '#/components/schemas/paymentBatchReasonCode'
        stateReason:
          description: The `reason` given when someone rejected the batch, reversed the batch, or removed approvals. This string is only present if a `reason` was given and the `state` has not changed since the reason was given.
          type: string
          format: text
          maxLength: 80
          readOnly: true
        customerId:
          description: 'The ID of the banking customer that this payment batch is for. This is typically a business customer ID. Note: This is not the login or access ID of the customer.'
          readOnly: true
          $ref: '#/components/schemas/readOnlyResourceId'
        information:
          description: A text string with additional information about the status of the batch.
          type: string
          format: text
          maxLength: 100
          readOnly: true
        remainingApprovalsCount:
          description: The number of the remaining approvals that are required before the batch can be scheduled. This property only applies if the `state` of the payment batch is `pendingApproval`.
          type: integer
          format: int32
          minimum: 0
          maximum: 3
          readOnly: true
        approvalCount:
          description: The number of approvals given for the batch.
          type: integer
          format: int32
          minimum: 0
          maximum: 3
          readOnly: true
          x-apiture-note: The maximum here must match the maxItems in paymentBatch.approvals array
        derivedFrom:
          readOnly: true
          description: If this batch was copied from another, this object describes that source payment batch. This field is only present when the payment batch was created via the [copy operation](#op-copyPaymentBatch).
          $ref: '#/components/schemas/paymentBatchDerivation'
        createdBy:
          description: The customer who created this payment batch.
          $ref: '#/components/schemas/customerAccountReference'
        updatedBy:
          description: The customer who last updated this payment batch.
          $ref: '#/components/schemas/customerAccountReference'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchCommonFields
    paymentBatchFields:
      x-apiture-version: 3.1.2
      title: Payment Batch Fields (v3.1.2)
      description: Common fields of the payment batch resource used to build other model schemas.
      x-apiture-fragment: true
      type: object
      allOf:
        - $ref: '#/components/schemas/commonPaymentBatchFields'
        - type: object
          properties:
            settlementAccount:
              description: The account where the payment funds are drawn or credited.
              $ref: '#/components/schemas/paymentSettlementAccountReference'
            settlementType:
              description: Whether the payments in the batch are applied to the settlement account as `detailed` transactions per payment instruction or as one `summary` transaction. This value is initially derived from the customer's ACH preferences. When payment batch processing begins, the preference is assigned to the payment.
              readOnly: true
              $ref: '#/components/schemas/paymentBatchSettlementType'
            schedule:
              description: The date when the payment should be processed, and any recurrence.
              $ref: '#/components/schemas/paymentBatchSchedule'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchFields
    paymentBatchSummaryFields:
      x-apiture-version: 1.2.0
      title: Payment Batch Summary Fields (v1.2.0)
      description: Payment batch summary fields.
      x-apiture-fragment: true
      type: object
      properties:
        direction:
          description: The direction in which funds flow for this payment batch.
          readOnly: true
          allOf:
            - $ref: '#/components/schemas/paymentBatchDirection'
        creditTotal:
          description: The total of all the payment credit amounts in this batch's payment instructions, expressed as a decimal value. These amounts are credits to the remote accounts and a debit to the settlement account. The total omits instructions where `hold` is `true`.
          allOf:
            - $ref: '#/components/schemas/creditOrDebitValue'
          readOnly: true
          example: '2467.50'
        debitTotal:
          description: The total of all the payment debit amounts in this batch's payment instructions, expressed as a decimal value.  These amounts are debits to the remote accounts and a credit to the settlement account. The total omits instructions where `hold` is `true`.
          allOf:
            - $ref: '#/components/schemas/creditOrDebitValue'
          readOnly: true
          example: '0.00'
        creditCount:
          description: The number of all the credit instructions in this payment batch. The count omits instructions where `hold` is `true`.
          type: integer
          format: int32
          readOnly: true
          minimum: 0
          maximum: 10000
          example: 12
        debitCount:
          description: The number of all the debit instructions in this payment batch. The count omits instructions where `hold` is `true`.
          type: integer
          format: int32
          minimum: 0
          maximum: 10000
          readOnly: true
          example: 30
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchSummaryFields
    timestampFields:
      x-apiture-version: 1.1.0
      title: Timestamp Fields (v1.1.0)
      description: Timestamps which describe when a resource was created or last updated.
      x-apiture-fragment: true
      allOf:
        - $ref: '#/components/schemas/createdAtField'
        - type: object
          properties:
            updatedAt:
              description: The date-time when the resource was last updated, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable.
              $ref: '#/components/schemas/readOnlyTimestamp'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/timestampFields
    paymentBatchType:
      x-apiture-version: 1.1.0
      title: Payment Batch Type (v1.1.0)
      description: |+
        Defines the type of this payment batch.

        <strong><code>paymentBatchType</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>ach</code></strong></td><td>ACH: <p>One or more ACH batches</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>nachaPassThrough</code></strong></td><td>NACHA Pass-through: <p>A single NACHA file with debit/credit payments</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>wireTransfer</code></strong></td><td>Wire Transfer: <p>Wire transfer</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-todo: Add other types, such as billPay, p2p
      x-apiture-enum: paymentBatchType
      enum:
        - ach
        - nachaPassThrough
        - wireTransfer
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchType
    creditOrDebitValue:
      x-apiture-version: 1.1.1
      title: Credit Or Debit Value (v1.1.1)
      description: The monetary value representing a credit (positive amounts with no prefix or a `+` prefix) or debit (negative amounts with a `-` prefix). The numeric value is  represented as a string so that it can be exact with no loss of precision.
      example: '3456.78'
      type: string
      format: decimal
      pattern: ^(-|\+)?(0|[1-9][0-9]*)\.[0-9][0-9]$
      maxLength: 16
      x-apiture-since: 0.4.0
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/creditOrDebitValue
    achPaymentBatch:
      x-apiture-version: 1.6.0
      title: ACH Payment Batch (v1.6.0)
      description: Properties unique to ACH payment batches.
      type: object
      required:
        - secCode
        - sameDay
        - imported
      allOf:
        - $ref: '#/components/schemas/confidentialAchCustomers'
        - $ref: '#/components/schemas/mutableAchPaymentBatchFields'
        - $ref: '#/components/schemas/achApprovalDateTimeFields'
        - type: object
          properties:
            type:
              description: Optionally defines a specific type of ACH payment batch. Used for Vendor Credit batches.
              readOnly: true
              $ref: '#/components/schemas/achPaymentBatchType'
            secCode:
              description: The SEC code for these ACH payments. This is derived from `type`.
              readOnly: true
              allOf:
                - $ref: '#/components/schemas/paymentBatchAchSecCode'
            imported:
              description: If true, this batch was imported from a NACHA file. Imported batches only allow changing the `hold` boolean property in payment instructions.
              type: boolean
              default: false
            reversedPaymentId:
              description: If this payment is a reversal of another batch, this is the `id` of that reversed payment batch.
              $ref: '#/components/schemas/readOnlyResourceId'
              readOnly: true
            template:
              description: The ACH template that this ACH payment bach was created from. This property is present only if the ACH payment batch was created from a template.
              allOf:
                - $ref: '#/components/schemas/achTemplateDerivation'
      example:
        secCode: ppd
        sameDay: false
        imported: true
        companyName: Well's Roofing
        confidentialCustomers:
          - id: 64446f8d-780f
            name: Philip F. Duciary
          - id: 58853981-24bb
            name: Alice A. Tuary
        approvalDueAt: '2022-06-09T20:30:00.000Z'
        sameDayApprovalDue:
          - '2022-06-09T15:00:00.000Z'
          - '2022-06-09T18:00:00.000Z'
          - '2022-06-09T20:30:00.000Z'
        template:
          id: b728c27e-5176
          name: Payroll
          lockedProperties:
            - achSettlementAccount
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/achPaymentBatch
    readOnlyResourceId:
      x-apiture-version: 1.0.1
      title: Read-only Resource Identifier (v1.0.1)
      description: The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.
      readOnly: true
      allOf:
        - $ref: '#/components/schemas/resourceId'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/readOnlyResourceId
    fullAccountNumber:
      title: Full Account Number (v1.0.0)
      description: A full account number. This is the number that the customer uses to reference the account within the financial institution.
      type: string
      minLength: 1
      maxLength: 32
      pattern: ^[- a-zA-Z0-9.]{1,32}$
      examples:
        - '123456789'
      x-resolved-from: ../../accounts/openapi.yaml#/components/schemas/fullAccountNumber
      x-apiture-version: 1.0.0
    wireTransferInstitutionLocatorType:
      title: Wire Transfer Institution Locator Type (v1.0.0)
      description: |+
        Indicates the type of the institution `locator` for a wire transfer.

        <strong><code>wireTransferInstitutionLocatorType</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>abaRoutingNumber</code></strong></td><td>ABA Routing Number: <p>The <a href="https://www.aba.com/about-us/routing-number">American Bankers Association routing number</a> of a financial institution</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>swiftBicCode</code></strong></td><td>SWIFT/BIC Code: <p>The <a href="https://www.swift.com/standards/data-standards/bic-business-identifier-code">SWIFT Business Identifier Code (BIC) code</a> of a financial institution</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>other</code></strong></td><td>Other: <p>A financial institution identifier other than ABA Routing Number or SWIFT Business Identifier Code (BIC)</p>
        </td>
            </tr>
        </table>

      x-apiture-enum: wireTransferInstitutionLocatorType
      type: string
      enum:
        - abaRoutingNumber
        - swiftBicCode
        - other
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/wireTransferInstitutionLocatorType
      x-apiture-version: 1.0.0
    paymentBatchTrackingNumber:
      title: Payment Batch Tracking Number (v1.0.0)
      readOnly: true
      description: A unique tracking number for this batch. Unlike the `id`, this numeric value is visible to the customer, and can be used to lookup a batch by this ID.
      type: string
      pattern: ^[0-9]+$
      minLength: 6
      maxLength: 9
      example: '15474162'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchTrackingNumber
      x-apiture-version: 1.0.0
    apiProblem:
      x-apiture-version: 1.2.1
      title: API Problem (v1.2.1)
      description: API problem or error, as per [RFC 7807 application/problem+json](https://tools.ietf.org/html/rfc7807).
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: |
            A [URI reference (RFC3986)](https://tools.ietf.org/html/rfc3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`.
          example: https://static.api.apiture.com/errors/forbidden/v1.0.0
          maxLength: 2048
        title:
          type: string
          description: |
            A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`.
          maxLength: 120
          format: text
          example: User is not authorized to perform the requested action or access the requested resource.
        status:
          type: integer
          format: int32
          description: |
            The [HTTP status code](https://datatracker.ietf.org/doc/html/rfc7231#section-6) for this occurrence of the problem.
          minimum: 100
          maximum: 599
          example: 403
        detail:
          type: string
          description: |
            A human-readable explanation specific to this occurrence of the problem.
          maxLength: 256
          format: text
          example: User is not authorized to perform this operation.
        instance:
          type: string
          format: uri-reference
          description: |
            A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
          example: https://prduction.api.apiture.com/banking/accounts/ad80fc3e722q5402a#189c13ff-c54c-45f7-b8e0-c88984ba724d
          maxLength: 2048
        id:
          description: The unique identifier for this problem. This is an immutable opaque string.
          $ref: '#/components/schemas/readOnlyResourceId'
        occurredAt:
          description: The timestamp when the problem occurred, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC.
          $ref: '#/components/schemas/readOnlyTimestamp'
        problems:
          description: Optional root-causes if there are multiple problems in the request or API call processing.
          type: array
          maxItems: 128
          items:
            $ref: '#/components/schemas/apiProblem'
        attributes:
          type: object
          description: Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.
      example:
        id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
        type: https://static.api.apiture.com/errors/accountNotFound/v1.0.0
        title: Account Not Found
        status: 422
        occurredAt: '2022-04-25T12:42:21.375Z'
        detail: No account exists at the given account_url
        instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/apiProblem
    monetaryValue:
      x-apiture-version: 1.1.1
      title: Monetary Value (v1.1.1)
      description: The monetary value, supporting only positive amounts. The numeric value is  represented as a string so that it can be exact with no loss of precision.
      example: '3456.78'
      format: decimal
      type: string
      pattern: ^(0|[1-9][0-9]*)\.[0-9][0-9]$
      maxLength: 16
      x-apiture-since: 0.4.0
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/monetaryValue
    rePresentedCheckFields:
      x-apiture-version: 1.1.0
      title: Re-Presented Check Fields (v1.1.0)
      description: Fields of a re-presented check (RCK) ACH payment instruction. This is a fragment schema, use to compose other schemas.
      x-apiture-fragment: true
      type: object
      properties:
        checkNumber:
          description: The check number that was presented again.
          type: integer
          format: int32
          minimum: 1
          maximum: 999999999999999
      example:
        checkNumber: 43318
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/rePresentedCheckFields
    paymentBatchState:
      title: Payment Batch State (v1.0.0)
      description: |+
        Defines the state of this payment batch.

        <strong><code>paymentBatchState</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>pending</code></strong></td><td>Pending: <p>A batch that has incomplete or erroneous data or has not yet be submitted for approval</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>pendingApproval</code></strong></td><td>Pending Approval: <p>At least one approval is necessary before the payment batch may be scheduled</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>rejected</code></strong></td><td>Rejected: <p>An approver rejected a payment batch</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>scheduled</code></strong></td><td>Scheduled: <p>A payment batch that is scheduled to be processed</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>processing</code></strong></td><td>Processing: <p>A payment patch that has begun payment processes</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>processed</code></strong></td><td>Processed: <p>A payment batch that has completed its payment processing</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>reversalPending</code></strong></td><td>Reversal Pending: <p>A customer has requested reversal which has not yet started</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>partiallyReversed</code></strong></td><td>Partially Reversed: <p>Some of the payment instructions in a payment batch have been reversed</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>reversed</code></strong></td><td>Reversed: <p>The entire batch has been fully reversed</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>canceled</code></strong></td><td>Canceled: <p>A reversed batch has been canceled before an account has been debited</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>failed</code></strong></td><td>Failed: <p>A batch which has failed validation business rules</p>
        </td>
            </tr>
        </table>

      type: string
      $comment: 'Now that Wire Transfers have a separate state, we should revisit refactoring to move some of these to #achPaymentBatch'
      x-apiture-enum: paymentBatchState
      enum:
        - pending
        - pendingApproval
        - rejected
        - scheduled
        - processing
        - processed
        - reversalPending
        - partiallyReversed
        - reversed
        - canceled
        - failed
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchState
      x-apiture-version: 1.0.0
    paymentBatchReasonCode:
      x-apiture-version: 1.2.0
      title: Payment Batch Reason Code (v1.2.0)
      description: |+
        The reason that a payment batch is in its current [`state`](#paymentBatchState). Normally, this explains why the state is still `pending` and not eligible to be submitted or approved.

        Some `reasonCode` values may only be associated with specific `state` values.
        * `state: pending` may have these `reasonCode` values:
          * `incomplete`
          * `notScheduled`
          * `pastCutoff`
          * `sameDayRequired`
          * `none`
        * `state: pendingApproval` may have these `reasonCodes` values:
          * `locked`

        <strong><code>paymentBatchReasonCode</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>incomplete</code></strong></td><td>Incomplete: <p>The payment batch is missing one or more field values required for submission</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>notScheduled</code></strong></td><td>Not Scheduled: <p>The payment batch was created but does not have an assigned <code>schedule.scheduledOn</code></p>
        </td>
            </tr>
        <tr>
            <td><strong><code>pastCutoff</code></strong></td><td>Past Cutoff: <p>The payment batch&#39;s scheduled date has exceeded the processing cutoff time and is no longer eligible for processing</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>sameDayRequired</code></strong></td><td>Same Day Required: <p>The payment batch requires Same Day ACH processing</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>locked</code></strong></td><td>Locked: <p>The payment batch has been submitted and is unable to be modified</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>none</code></strong></td><td>None: <p>The payment batch has no problems and is eligible for submission and approval</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: paymentBatchReasonCode
      enum:
        - incomplete
        - notScheduled
        - pastCutoff
        - sameDayRequired
        - locked
        - none
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchReasonCode
    paymentBatchDerivation:
      x-apiture-version: 1.0.1
      title: Payment Batch Derivation (v1.0.1)
      description: If this batch was copied from another, this object describes that source payment batch. This field is only be present when the payment batch was created via the [copy operation](#op-copyPaymentBatch).
      required:
        - id
        - trackingNumber
        - type
      type: object
      properties:
        id:
          description: The unique identifier for the origin payment batch resource. This is an immutable opaque string.
          $ref: '#/components/schemas/readOnlyResourceId'
        trackingNumber:
          description: The unique tracking number for the batch this was copied from.
          type: string
          pattern: ^[0-9]+$
          minLength: 6
          maxLength: 9
          example: '15474162'
        type:
          $ref: '#/components/schemas/paymentBatchCopyType'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchDerivation
    customerAccountReference:
      x-apiture-version: 2.0.0
      title: Customer Account Reference (v2.0.0)
      description: The representation of a customer account.
      type: object
      required:
        - id
        - name
        - username
      properties:
        id:
          description: The immutable, unique, opaque identifier for the user.
          $ref: '#/components/schemas/resourceId'
        name:
          description: The user's full name.
          type: string
          format: text
          maxLength: 20
        username:
          description: The user's login name.
          $ref: '#/components/schemas/customerUsername'
      example:
        id: 0399abed-fd3d
        name: Benny Billings
        username: bbillings
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/customerAccountReference
    commonPaymentBatchFields:
      title: Common Payment Batch Fields (v0.10.0)
      description: Fields shared for composing payment batch resources.
      x-apiture-fragment: true
      type: object
      x-apiture-version: 0.10.0
      properties:
        name:
          description: The user-assigned name of this payment batch.
          type: string
          format: text
          maxLength: 10
          example: Payroll 03
        description:
          description: The user-assigned detailed description of this payment batch.
          type: string
          format: text
          maxLength: 100
          example: 2022-03 Employee Payroll
        company:
          description: Identification of the company making this payment batch.
          $ref: '#/components/schemas/paymentBatchCompany'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/commonPaymentBatchFields
    paymentSettlementAccountReference:
      x-apiture-version: 3.1.0
      title: Payment Settlement Account Reference (v3.1.0)
      description: Descriptive fields that identify a payment's internal settlement account.
      type: object
      required:
        - id
      properties:
        id:
          description: The account's unique, opaque resource ID.
          $ref: '#/components/schemas/nullableReadOnlyResourceId'
        label:
          description: A text label which describes this account. This is derived from the `account.label`.
          type: string
          format: text
          maxLength: 80
          example: Checking *1008
          readOnly: true
        risk:
          description: 'The risk level determines how the batch processes: how many days it takes to process the batch ( 2, 3 or 4 days ), when the customer gets debited, and how early the batch has to look ahead of the effective date. This is normally determined from the risk associated with the settlement account.'
          $ref: '#/components/schemas/achAccountRisk'
        maskedNumber:
          description: The account number, masked for partial display.
          readOnly: true
          allOf:
            - $ref: '#/components/schemas/maskedAccountNumber'
      examples:
        - label: Payroll Checking *1008
          maskedNumber: '*1008'
          id: bf23bc970b78d27691e
          risk: normal
        - id: null
          risk: float
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentSettlementAccountReference
    paymentBatchSettlementType:
      title: Settlement Type (v1.0.0)
      description: |+
        How the payment processing is applied to the settlement account.

        <strong><code>paymentBatchSettlementType</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>summary</code></strong></td><td>Summary: <p>All the payments in the batch are combined into one transaction against the account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>detailed</code></strong></td><td>Detailed: <p>Each payments in the batch is recorded as individual transactions against the account</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: paymentBatchSettlementType
      enum:
        - summary
        - detailed
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchSettlementType
      x-apiture-version: 1.0.0
    paymentBatchSchedule:
      x-apiture-version: 1.3.2
      title: Payment Batch Schedule (v1.3.2)
      description: |-
        The scheduled date when the payment should be completed, the recurrence, if any, and other derived dates based on the scheduled date.

        If the payment is a NACHA pass-through, the schedule is read-only and reflects the earliest `scheduledOn` and `effectiveOn` dates from the NACHA file with a recurrenceType of `once`.
      type: object
      properties:
        recurrenceType:
          $ref: '#/components/schemas/paymentRecurrenceType'
        scheduledOn:
          description: The payment's target completion date, in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. For recurring batches, this date get recalculated after each recurrence is processed.
          $ref: '#/components/schemas/date'
        frequency:
          $ref: '#/components/schemas/paymentFrequency'
        endsOn:
          description: The optional date when the recurring batch schedule ends, in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. Subsequent recurring payments may be scheduled up to and including this date, but not after. This property is omitted if `frequency` is `once`.
          $ref: '#/components/schemas/date'
        effectiveOn:
          description: The target date when the batch payment or draft should be processed, in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. This is derived from the `scheduledOn` date. For recurring batches, this date get recalculated after each recurrence is processed.
          $ref: '#/components/schemas/date'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchSchedule
    paymentBatchDirection:
      title: Batch Payment Direction (v1.0.0)
      description: |+
        Indicates the direction of money flow for a payment batch.

        <strong><code>paymentBatchDirection</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>none</code></strong></td><td>None: <p>No payment instructions to determine direction</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>credit</code></strong></td><td>credit: <p>Payments are credit in the external accounts, debit to the settlement account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>debit</code></strong></td><td>debit: <p>Payments are debits in the external accounts, credit to the settlement account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>both</code></strong></td><td>both: <p>Payment instructions include both debits and credits</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: paymentBatchDirection
      enum:
        - none
        - credit
        - debit
        - both
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchDirection
      x-apiture-version: 1.0.0
    createdAtField:
      description: A field used to represent the `createdAt` date-time for a resource.
      x-apiture-fragment: true
      type: object
      properties:
        createdAt:
          description: The date-time when this resource was created, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable.
          $ref: '#/components/schemas/readOnlyTimestamp'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/createdAtField
      x-apiture-version: 1.0.0
      title: ' (v1.0.0)'
    readOnlyTimestamp:
      title: Read-Only Timestamp (v1.0.0)
      description: 'A readonly or derived timestamp (an instant in time) formatted in [RFC 3339](https://tools.ietf.org/html/rfc3339) `date-time` UTC format: `YYYY-MM-DDThh:mm:ss.sssZ`.'
      type: string
      minLength: 20
      maxLength: 30
      format: date-time
      readOnly: true
      example: '2021-10-30T19:06:04.250Z'
      x-apiture-since: 0.4.0
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/readOnlyTimestamp
      x-apiture-version: 1.0.0
    confidentialAchCustomers:
      x-apiture-version: 1.1.0
      title: Confidential ACH Customers (v1.1.0)
      description: Defines the `confidentialCustomers` property, for use in composing other schemas.
      x-apiture-fragment: true
      type: object
      properties:
        confidentialCustomers:
          description: A list of customers entitled to view and manage this confidential payment batch. If this property is omitted, the batch is not confidential. To remove confidential customers in a batch and make the batch non-confidential, set this property to `null` in a [`patchPaymentBatch`](#op-patchPaymentBatch) operation.
          type:
            - array
            - 'null'
          minItems: 1
          maxItems: 1000
          items:
            $ref: '#/components/schemas/confidentialAchCustomer'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/confidentialAchCustomers
    mutableAchPaymentBatchFields:
      x-apiture-version: 1.1.0
      title: Mutable ACH Payment Batch Fields (v1.1.0)
      description: Fields of a mutable ACH payment batch, used to compose other schemas.
      x-apiture-fragment: true
      type: object
      properties:
        companyName:
          description: The name of the company associated with this ACH batch. This short form of the business name is included in the corresponding NACHA file which imposes a maximum length of 16 characters.
          type: string
          format: text
          maxLength: 16
        discretionaryData:
          description: Discretionary text data which is carried over to the settlement entry.
          type: string
          format: text
          maxLength: 20
        sameDay:
          description: The ACH payment should be processed on the same day, if enabled by the financial institution.
          type: boolean
          default: false
        sendRemittanceOnly:
          description: If `true`, send only the payment remittance information with this ACH payment. This property applies only if `secCode` is `ccd` or `ctx` and this batch is not an ACH (NACHA) import, and is otherwise ignored.
          type: boolean
          default: false
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/mutableAchPaymentBatchFields
    achApprovalDateTimeFields:
      title: ACH Approval DateTime Fields (v1.0.0)
      description: Common approval date-time fields for ACH payments.
      type: object
      properties:
        approvalDueAt:
          description: The date and time when the payment must be fully approved so that it can be processed in time to complete by the `scheduledOn` date. The time component of this timestamp is the financial institution's cutoff time. This is expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) `YYYY-MM-DDThh:mm:ss.sssZ` date-time format in UTC time zone.
          $ref: '#/components/schemas/readOnlyTimestamp'
        sameDayApprovalDue:
          description: A list of date-times when a same day payment must be fully approved so that it can be processed that day. The financial institution may process same-day ACH batches multiple times per day. The time component of each date-time is the financial institution's same-day cutoff time. This is expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) `YYYY-MM-DDThh:mm:ss.sssZ` date-time format in UTC time zone. Same day batches submitted on non-business days are processed the next business day.
          readOnly: true
          type: array
          minItems: 1
          maxItems: 8
          items:
            $ref: '#/components/schemas/timestamp'
          example:
            - '2022-06-09T15:00:00.000Z'
            - '2022-06-09T18:00:00.000Z'
            - '2022-06-09T20:30:00.000Z'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/achApprovalDateTimeFields
      x-apiture-version: 1.0.0
    achPaymentBatchType:
      title: ACH Payment Batch Type (v1.0.0)
      description: |+
        Defines the type of this ACH payment batch.

        <strong><code>achPaymentBatchType</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>other</code></strong></td><td>Other: <p>An other ACH payment type</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>vendorCredit</code></strong></td><td>Vendor Credit: <p>Pay vendor via Corporate Trade Exchange (CTX)</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: achPaymentBatchType
      x-apiture-todo: add other types, such as `eftps` - Electronic Federal Tax Payment System
      enum:
        - other
        - vendorCredit
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/achPaymentBatchType
      x-apiture-version: 1.0.0
    paymentBatchAchSecCode:
      x-apiture-version: 1.0.1
      title: ACH Payment (v1.0.1)
      description: The Standard Entry Class (SEC) code that denotes the ACH payment authorization type.
      allOf:
        - $ref: '#/components/schemas/achSecCode'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchAchSecCode
    achTemplateDerivation:
      x-apiture-version: 2.0.0
      title: ACH Template Derivation (v2.0.0)
      description: If this ACH payment batch was created from a template, this object describes that source template. This field is only present when the ACH payment batch was [created by a template](#op-createAchPaymentBatchFromTemplate).
      required:
        - id
        - name
        - lockedProperties
      allOf:
        - $ref: '#/components/schemas/paymentBatchTemplateReferenceFields'
        - type: object
          properties:
            lockedProperties:
              description: List of the properties of an ACH template that may not be modified.
              type: array
              uniqueItems: true
              items:
                $ref: '#/components/schemas/lockedAchTemplateProperty'
              minItems: 0
              maxItems: 10
              default: []
      example:
        id: 0d5b4d7b0219071a8412
        name: Payroll
        lockedProperties:
          - achSettlementAccount
      x-resolved-from: ../../paymentTemplates/openapi.yaml#/components/schemas/achTemplateDerivation
    paymentBatchCopyType:
      x-apiture-version: 1.1.0
      title: Payment Batch Copy Type (v1.1.0)
      description: |+
        The type of the payment batch copy.

        <strong><code>paymentBatchCopyType</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>prenote</code></strong></td><td>Prenote: <p>A prenote payment batch to validate the ACH routing number and account number</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>copy</code></strong></td><td>Copy: <p>A copy of an existing payment batch</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>recurrence</code></strong></td><td>Recurrence: <p>A payment batch originating from a payment batch recurrence</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>reversal</code></strong></td><td>Reversal: <p>A reversed payment batch</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: paymentBatchCopyType
      enum:
        - prenote
        - copy
        - recurrence
        - reversal
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchCopyType
    customerUsername:
      x-apiture-version: 2.0.0
      title: Customer Username (v2.0.0)
      description: A customer's login username.
      type: string
      format: text
      minLength: 5
      maxLength: 20
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/customerUsername
    paymentBatchCompany:
      x-apiture-version: 1.1.0
      title: Payment Batch Company (v1.1.0)
      description: Identification of the company associated with this payment batch.
      type: object
      required:
        - id
        - type
      properties:
        id:
          description: The company identifier.
          type: string
          format: text
          maxLength: 32
        type:
          description: The type of this company identification number
          $ref: '#/components/schemas/paymentBatchCompanyIdType'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchCompany
    nullableReadOnlyResourceId:
      title: Nullable Read-only Resource Identifier (v1.0.0)
      description: The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is used in properties that reference a resource by ID rather than URL. This can be used in patch operations to detach a resource. Resource IDs are immutable.
      readOnly: true
      allOf:
        - $ref: '#/components/schemas/nullableResourceId'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/nullableReadOnlyResourceId
      x-apiture-version: 1.0.0
    achAccountRisk:
      title: ACH Account Risk (v1.0.0)
      description: |+
        Describes the risk level of a payment batch's settlement account.

        <strong><code>achAccountRisk</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>early</code></strong></td><td>Early: <p>The account is debited three business days before the ACH transfer&#39;s effective date. The account balance is also checked for sufficient funds before the account is debited. A risk limit may apply for commercial accounts with an <code>early</code> risk level.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>normal</code></strong></td><td>Normal: <p>The account is debited two business days before the ACH transfer&#39;s effective date. The account balance is also checked for sufficient funds before the account is debited. A risk limit may apply for commercial accounts with a <code>normal</code> risk level.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>float</code></strong></td><td>Float: <p>The account is debited on the ACH transfer&#39;s effective date. The account balance is not checked for sufficient funds before the account is debited. A risk limit applies for commercial accounts with a <code>float</code> risk level.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>sameDay</code></strong></td><td>Same Day: <p>The account is credited on the ACH transfer&#39;s effective day. The account balance is not checked because <code>sameDay</code> is used for credit. A risk limit and per-transaction limit applies.</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: achAccountRisk
      enum:
        - early
        - normal
        - float
        - sameDay
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/achAccountRisk
      x-apiture-version: 1.0.0
    maskedAccountNumber:
      x-apiture-version: 1.0.1
      title: Masked Account Number (v1.0.1)
      description: 'A masked account number: an asterisk `*` followed by one to four characters of the `fullAccountNumber`.'
      type: string
      minLength: 2
      maxLength: 5
      pattern: ^\*[- _a-zA-Z0-9.]{1,4}$
      examples:
        - '*1008'
        - '*0005'
      x-resolved-from: ../../accounts/openapi.yaml#/components/schemas/maskedAccountNumber
    paymentRecurrenceType:
      x-apiture-version: 1.1.0
      title: Payment Recurrence Type (v1.1.0)
      description: |+
        Describes whether the payment instruction amounts in the batch vary or are fixed when the payment recurs. This is ignored if the payment frequency is `once`.

        <strong><code>paymentRecurrenceType</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>fixed</code></strong></td><td>Fixed: <p>The payment amounts are the same each time a payment recurs</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>variable</code></strong></td><td>Variable: <p>The payment amounts vary and must be entered/verified each time a payment recurs</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>automaticallyRecur</code></strong></td><td>Automatically Recur: <p>The payment batch will automatically recur after processing (but with no scheduled date)</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: paymentRecurrenceType
      enum:
        - fixed
        - variable
        - automaticallyRecur
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentRecurrenceType
    date:
      title: Date (v1.0.0)
      description: A date formatted in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` UTC format.
      type: string
      minLength: 10
      maxLength: 10
      format: date
      example: '2021-10-30'
      x-apiture-since: 0.5.0
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/date
      x-apiture-version: 1.0.0
    paymentFrequency:
      x-apiture-version: 1.1.1
      title: Payment Frequency (v1.1.1)
      description: For recurring payments and drafts, the interval at which the money movement recurs.
      allOf:
        - $ref: '#/components/schemas/transferFrequency'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentFrequency
    confidentialAchCustomer:
      title: Confidential ACH Customer (v1.0.0)
      description: A reference to a customer that is entitled to view and manage a confidential ACH payment batch.
      allOf:
        - $ref: '#/components/schemas/customerReference'
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/confidentialAchCustomer
      x-apiture-version: 1.0.0
    timestamp:
      title: Timestamp (v1.0.0)
      description: A timestamp (an instant in time) formatted in `YYYY-MM-DDThh:mm:ss.sssZ` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date-time` UTC format.
      type: string
      minLength: 20
      maxLength: 30
      format: date-time
      example: '2021-10-30T19:06:04.250Z'
      x-apiture-since: 0.4.0
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/timestamp
      x-apiture-version: 1.0.0
    achSecCode:
      title: ACH SEC Code (v1.0.0)
      description: |+
        The ACH transfer type.

        <strong><code>achSecCode</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>arc</code></strong></td><td>Accounts Receivable</td>
            </tr>
        <tr>
            <td><strong><code>boc</code></strong></td><td>Back Office Conversion</td>
            </tr>
        <tr>
            <td><strong><code>ccd</code></strong></td><td>Credit or Debit</td>
            </tr>
        <tr>
            <td><strong><code>cie</code></strong></td><td>Customer-Initiated</td>
            </tr>
        <tr>
            <td><strong><code>ctx</code></strong></td><td>Corporate Trade Exchange</td>
            </tr>
        <tr>
            <td><strong><code>pop</code></strong></td><td>Point of Purchase</td>
            </tr>
        <tr>
            <td><strong><code>ppd</code></strong></td><td>Prearranged Payment and Deposit</td>
            </tr>
        <tr>
            <td><strong><code>rck</code></strong></td><td>Re-Presented Check</td>
            </tr>
        <tr>
            <td><strong><code>tel</code></strong></td><td>Telephone-initiated</td>
            </tr>
        <tr>
            <td><strong><code>web</code></strong></td><td>Internet-initiated/Mobile</td>
            </tr>
        </table>

      type: string
      x-apiture-enum: achSecCode
      enum:
        - arc
        - boc
        - ccd
        - cie
        - ctx
        - pop
        - ppd
        - rck
        - tel
        - web
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/achSecCode
      x-apiture-version: 1.0.0
    paymentBatchTemplateReferenceFields:
      x-apiture-version: 1.0.1
      title: Payment Batch Template Reference Fields (v1.0.1)
      description: Fields used to compose a reference to a payment batch template.
      x-apiture-fragment: true
      type: object
      properties:
        id:
          description: The unique identifier for this payment batch template resource. This is an immutable opaque string.
          $ref: '#/components/schemas/readOnlyResourceId'
        name:
          description: The unique, human-readable name of the template.
          type: string
          format: text
          minLength: 1
          maxLength: 50
      example:
        id: 0d5b4d7b0219071a8412
        name: Insurance Premiums
      x-resolved-from: ../../paymentTemplates/openapi.yaml#/components/schemas/paymentBatchTemplateReferenceFields
    lockedAchTemplateProperty:
      x-apiture-version: 2.0.0
      title: Locked ACH Template Property (v2.0.0)
      description: |+
        A property of an ACH payment template that may not be modified when an ACH payment batch is created from the template. Changes made to the template are not applied to any ACH payment batches previously created from the template.

        <strong><code>lockedAchTemplateProperty</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>achPaymentName</code></strong></td><td>ACH Payment Name</td>
            </tr>
        <tr>
            <td><strong><code>achPaymentDescription</code></strong></td><td>ACH Payment Description</td>
            </tr>
        <tr>
            <td><strong><code>achSettlementAccount</code></strong></td><td>ACH Settlement Account</td>
            </tr>
        <tr>
            <td><strong><code>achCompanyType</code></strong></td><td>ACH Company Type</td>
            </tr>
        <tr>
            <td><strong><code>achCompanyName</code></strong></td><td>ACH Company Name</td>
            </tr>
        <tr>
            <td><strong><code>achCompanyId</code></strong></td><td>ACH Company ID</td>
            </tr>
        <tr>
            <td><strong><code>achMemo</code></strong></td><td>ACH Memo</td>
            </tr>
        <tr>
            <td><strong><code>achConfidentialCustomers</code></strong></td><td>ACH Confidential Customers</td>
            </tr>
        <tr>
            <td><strong><code>achRecipientPaymentAmount</code></strong></td><td>ACH Recipient Payment Amount</td>
            </tr>
        <tr>
            <td><strong><code>achRecipientPaymentAddenda</code></strong></td><td>ACH Recipient Payment Addenda</td>
            </tr>
        </table>

      type: string
      x-apiture-enum: lockedAchTemplateProperty
      enum:
        - achPaymentName
        - achPaymentDescription
        - achSettlementAccount
        - achCompanyType
        - achCompanyName
        - achCompanyId
        - achMemo
        - achConfidentialCustomers
        - achRecipientPaymentAmount
        - achRecipientPaymentAddenda
      x-resolved-from: ../../paymentTemplates/openapi.yaml#/components/schemas/lockedAchTemplateProperty
    paymentBatchCompanyIdType:
      title: Payment Batch Company Id Type (v1.0.0)
      description: |+
        An enumeration of allowed company ID types.

        <strong><code>paymentBatchCompanyIdType</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>taxId</code></strong></td><td>Tax Id: <p>Government issued TAX identification ID</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>dunsNumber</code></strong></td><td>DUNS Number: <p>Dunn &amp; Bradstreet company identification number</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>userDefined</code></strong></td><td>User Defined ID</td>
            </tr>
        <tr>
            <td><strong><code>companyId</code></strong></td><td>Company ID</td>
            </tr>
        </table>

      type: string
      x-apiture-enum: paymentBatchCompanyIdType
      enum:
        - taxId
        - dunsNumber
        - userDefined
        - companyId
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/schemas/paymentBatchCompanyIdType
      x-apiture-version: 1.0.0
    nullableResourceId:
      title: Nullable Resource Identifier (v1.0.0)
      description: The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is used in properties that reference a resource by ID rather than URL. This can be used in patch operations to detach a resource.
      type:
        - string
        - 'null'
      pattern: ^[-_:.~$a-zA-Z0-9]+$
      minLength: 6
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/nullableResourceId
      x-apiture-version: 1.0.0
    transferFrequency:
      title: Transfer Frequency (v1.0.0)
      description: |+
        For recurring transfers, the interval at which the money movement recurs.

        <strong><code>transferFrequency</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>once</code></strong></td><td>Once: <p>Transfer does not repeat</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>occasional</code></strong></td><td>Occasional: <p>Transfer recurs but without a new scheduled date</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>daily</code></strong></td><td>Daily: <p>Repeat daily on business days</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>weekly</code></strong></td><td>Weekly: <p>Repeat weekly</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>biweekly</code></strong></td><td>biweekly: <p>Repeat every two weeks (26 times a year)</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>semimonthly</code></strong></td><td>Semimonthly: <p>Repeat twice a month (24 times a year)</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>monthly</code></strong></td><td>Monthly: <p>Repeat monthly</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>monthlyFirstDay</code></strong></td><td>Monthly First Day: <p>Repeat on the first business day of the month</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>monthlyLastDay</code></strong></td><td>Monthly Last Day: <p>Repeat on the last business day of the month</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>bimonthly</code></strong></td><td>Bimonthly: <p>Repeat every other month</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>quarterly</code></strong></td><td>Quarterly: <p>Repeat quarterly (four times a year)</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>semiyearly</code></strong></td><td>Semiyearly: <p>Repeat every six months (twice a year)</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>yearly</code></strong></td><td>Yearly: <p>Repeat once every year</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: transferFrequency
      enum:
        - once
        - occasional
        - daily
        - weekly
        - biweekly
        - semimonthly
        - monthly
        - monthlyFirstDay
        - monthlyLastDay
        - bimonthly
        - quarterly
        - semiyearly
        - yearly
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/transferFrequency
      x-apiture-version: 1.0.0
    customerReference:
      x-apiture-version: 1.1.2
      title: Customer Reference (v1.1.2)
      type: object
      description: A reference to a customer. The `name` property is the customer's `name` at the time this reference was created.
      required:
        - id
        - name
      properties:
        id:
          description: The unique `id` of the customer.
          allOf:
            - $ref: '#/components/schemas/resourceId'
        name:
          description: The customer's full name.
          type: string
          minLength: 1
          maxLength: 50
          format: text
      example:
        id: f48291b6-14ce
        name: Amanda Cummins
      x-resolved-from: ../../customers/openapi.yaml#/components/schemas/customerReference
  x-apiture-errors:
    invalidBusinessTransferIds:
      description: One or more business transfer IDs are invalid and do not correspond to any business transfers.
      remediation: Remove the invalid business transfer IDs from the request and try again.
      attributes:
        properties:
          BusinessTransferIds:
            description: The list of invalid business transfer IDs.
            type: array
            minItems: 1
            maxItems: 100
            $comment: This maxItems must match businessTransferIdSelection.maxItems
            uniqueItems: true
            items:
              $ref: '#/components/schemas/readOnlyResourceId'
    missingPaymentInstructionAmount:
      description: The payment amount for this instruction is missing.
      remediation: Set a valid, non-zero payment amount.
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/x-apiture-errors/missingPaymentInstructionAmount
    paymentInstructionsNotAvailable:
      description: Payment instructions are not available for NACHA pass-through payments.
      remediation: Do not access payment instructions for NACHA pass-through payments.
      x-resolved-from: ../../paymentBatches/openapi.yaml#/components/x-apiture-errors/paymentInstructionsNotAvailable
    badRequest:
      description: The request body and/or parameters was not well-formed.
      remediation: Correct any syntax or schema errors in the request body or parameters.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/badRequest
    unauthorized:
      description: The request lacks valid authentication credentials for the target resource or operation.
      remediation: Authenticate the user and pass the required authorization with the request.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/unauthorized
    notFound:
      description: The resource at the requested URL does not exist.
      remediation: Use the URL of an existing resource.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/notFound
    tooManyRequests:
      description: The client has sent too many requests in a given amount of time, exceeding rate limiting.
      remediation: Slow down the rate of API calls.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/tooManyRequests
    forbidden:
      description: The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access.
      remediation: Check the user's permissions and entitlements before attempting the operation.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/forbidden
  securitySchemes:
    clientCredentials:
      type: oauth2
      description: Client Credentials OAuth2 flow that allows a secure service application to access resources. (This access is not used with insecure clients such as web or mobile applications.) See details at [Secure Access](https://dx.apiture.com/docs/api/guides/secure-access/).
      flows:
        clientCredentials:
          tokenUrl: https://dev-oidc.apiture-comm-nonprod.com/oidc/token
          scopes:
            bankingAdmin/read: Read a wide variety of banking and other financial institution and customer data.
            bankingAdmin/write: Write a wide variety of banking and other financial institution and customer data.
            adminData/read: Read access to non-banking data and resources.
            adminData/write: Read, write, and delete access to non-banking data and resources.
            samlPlatform/write: Write access to security-critical Apiture internal key and certificate data.
            samlPlatform/read: Read access to integration resources, e.g. supported codes.
            samlAdmin/write: Write, delete and execute access to service provider metadata and SAML computation operations.
            systemIntegrations/read: Read access to integration definition resources.
            systemIntegrations/write: Write, delete and execute access to integration definition resources.
      x-resolved-from: ../../common/openapi.yaml#/components/securitySchemes/clientCredentials
  responses:
    '400':
      description: |
        Bad Request. The request body, request headers, and/or query parameters are not well-formed.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/badRequest/v1.0.0`](https://static.api.apiture.com/errors/badRequest/v1.0.0)<br>
          The request body and/or parameters was not well-formed.
          Remediation: Correct any syntax or schema errors in the request body or parameters.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/badRequest'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/badRequest/v1.0.0
              title: Bad Request
              status: 400
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: Input did not parse as JSON
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/badRequest/v1.0.0
              title: Bad Request
              status: 400
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: Input did not parse as JSON
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/400
    '401':
      description: |
        Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/unauthorized/v1.0.0`](https://static.api.apiture.com/errors/unauthorized/v1.0.0)<br>
          The request lacks valid authentication credentials for the target resource or operation.
          Remediation: Authenticate the user and pass the required authorization with the request.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/unauthorized'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/unauthorized/v1.0.0
              title: Unauthorized
              status: 401
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request lacks valid authentication credentials
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/unauthorized/v1.0.0
              title: Unauthorized
              status: 401
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request lacks valid authentication credentials
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/401
    '404':
      description: |
        Not found. There is no such resource at the request URL.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/notFound/v1.0.0`](https://static.api.apiture.com/errors/notFound/v1.0.0)<br>
          The resource at the requested URL does not exist.
          Remediation: Use the URL of an existing resource.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/notFound'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/notFound/v1.0.0
              title: Not Found
              status: 404
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The resource at the request URL does not exist.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/notFound/v1.0.0
              title: Not Found
              status: 404
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The resource at the request URL does not exist.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/404
    '429':
      description: |
        Too Many Requests. The client has sent too many requests in a given amount of time.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/tooManyRequests/v1.0.0`](https://static.api.apiture.com/errors/tooManyRequests/v1.0.0)<br>
          The client has sent too many requests in a given amount of time, exceeding rate limiting.
          Remediation: Slow down the rate of API calls.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/tooManyRequests'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/tooManyRequests/v1.0.0
              title: Too Many Requests
              status: 429
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The user has sent too many requests in a given amount of time.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/tooManyRequests/v1.0.0
              title: Too Many Requests
              status: 429
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The user has sent too many requests in a given amount of time.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/429
    clientCredentials403:
      description: |
        Forbidden. The authenticated caller is not authorized to perform the requested operation.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/forbidden/v1.0.0`](https://static.api.apiture.com/errors/forbidden/v1.0.0)<br>
          The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access.
          Remediation: Check the user's permissions and entitlements before attempting the operation.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/forbidden'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/forbidden/v1.0.0
              title: Forbidden
              status: 403
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request has valid authentication, but the authenticated agent is forbidden from accessing this resource or operation
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/forbidden/v1.0.0
              title: Forbidden
              status: 403
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request has valid authentication, but the authenticated agent is forbidden from accessing this resource or operation
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/clientCredentials403
    4XX:
      description: Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/methodNotAllowed/v1.0.0
              title: Method Not Allowed
              status: 405
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: This HTTP method is not allowed for the given resource URL.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/methodNotAllowed/v1.0.0
              title: Method Not Allowed
              status: 405
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: This HTTP method is not allowed for the given resource URL.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/4XX
    5XX:
      description: Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/gatewayTimeout/v1.0.0
              title: Insufficient Storage
              status: 507
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The server is unable to store the representation needed to successfully complete the request.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/gatewayTimeout/v1.0.0
              title: Insufficient Storage
              status: 507
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The server is unable to store the representation needed to successfully complete the request.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/5XX
x-resolved-from: ../../adminBusinessTransfers/status-codes-openapi.yaml
x-resolved-at: '2024-12-09T22:01:53.766Z'
x-apiture-annotated-at: '2024-12-09T22:01:54.061Z'
