openapi: 3.1.0
info:
  title: Real-Time Payments
  description: |-
    Real-Time Payments (RTP), also called instant or faster payment, is a payment method that allows banking customers (members) and businesses to send and receive immediate payments, 24/7/365, directly from their banking accounts.

    A _debit_ real-time payment represents a payment that is withdrawn (debited) from the sender's account and deposited to an internal account at the current financial institution, also known as an _incoming_ real-time payment.

    A _credit_ real-time payment represents a payment that is withdrawn from an internal account at the current financial institution and deposited (credited) into the recipient's account, also known as an _outgoing_ real-time payment.
  version: 0.21.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
tags:
  - name: Debit Real-Time Payments
    description: Real-time payments debited from the sender's account and credited to an internal account
  - name: Credit Real-Time Payments
    description: Real-time payments debited from an internal account and credited to the recipient's account
  - name: Credit Real-Time Payment Actions
    description: Actions on credit real-time payments
  - name: Credit Real-Time Payment Recipients
    description: Recipients for credit real-time payments
  - name: Real-Time Payment History Records
    description: History records for real-time payments
servers:
  - url: /banking
x-apiture-namespace: bankingRealTimePayments
x-apiture-package-name: banking-real-time-payments
paths:
  /debitRealTimePayments:
    get:
      summary: Return a collection of debit real-time payments
      description: Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) collection of debit real-time payments. The result is ordered by default in reverse chronological order based on the created date (`createdAt`) of the debit real-time payments.
      operationId: listDebitRealTimePayments
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: debitRealTimePayments
      tags:
        - Debit Real-Time Payments
      parameters:
        - name: senderName
          description: Return only debit real-time payments whose `sender.name` contains this substring of at least two characters, ignoring case.
          in: query
          schema:
            type: string
            format: text
            minLength: 2
            maxLength: 140
        - name: availableAt
          description: 'Return only debit real-time payments whose `availableAt` date matches with the value or date range. Can search up to 2 years in the past. Date ranges use [range notation](https://dx.apiture.com/docs/api/concepts/collection-filtering/#range-filters). Examples: <ul> <li> `[2023-05-01,2023-05-31]` between May 1 and 31, 2023, inclusive</li> <li> `[2023-05-01,2023-06-01)` on or after May 1, but _before_ June 1 (in May, 2023)</li> <li> `[2023-05-19,]` on or after May 19, 2023</li> <li> `[,2023-05-19]` on or before May 19, 2023</li> <li> `2023-05-19`</li> uploaded on May 19, 2023. </ul>'
          in: query
          schema:
            $ref: '#/components/schemas/dateRange'
        - name: accounts
          description: Return only debit real-time payments which were deposited into one of these accounts.
          in: query
          style: form
          explode: false
          schema:
            $ref: '#/components/schemas/bankingAccountIdSelection'
        - name: amount
          description: 'Return only debit real-time payments whose `amount` is in this range. Amount ranges use [range notation](https://dx.apiture.com/docs/api/concepts/collection-filtering/#range-filters). The value may have the following forms: <ul> <li>`1200.50` match the dollar amount 1,200.50 exactly</li> <li>`[1000.00,1200.00)` matches items where `1000.00 <= amount < 1200.00`</li> <li>`[1000.00,1199.99]` matches items where `1000.00 <= amount <= 1199.99`</li> <li>`(999.99,1200.00)` matches items where `999.99 < amount < 1200.00`</li> <li>`[1200.50,]` matches items where `amount >= 1200.50`</li> <li>`(1200.50,)` matches items where `amount > 1200.50`</li> <li>`[,1200.50]` matches items where `amount <= 1200.50`</li> <li>`(,1200.50)` matches items where `amount < 1200.50`</li> </ul>'
          in: query
          schema:
            $ref: '#/components/schemas/amountRange'
        - name: sortBy
          description: The sort order for the items in the response. Use `?sortBy=createdAt` or `?sortBy=-createdAt` to sort by ascending or descending order of the payment's `createdAt` date-time. The default is `-createdAt`.
          in: query
          style: form
          explode: false
          schema:
            type: array
            uniqueItems: true
            $comment: Defined as an array so we can pass multiple sort keys in the future.
            maxItems: 1
            minItems: 1
            items:
              description: The sort key defining which value to sort by. A `-` prefix means descending.
              type: string
              pattern: ^-?(createdAt)
              minLength: 9
              maxLength: 10
        - $ref: '#/components/parameters/startQueryParam'
        - $ref: '#/components/parameters/limitQueryParam'
      responses:
        '200':
          description: OK. A page from the full list of the customer's debit real-time payments. While the `nextPage_url` property is present in the response, the client can fetch the next page of debit real-time payments by performing a `GET` on that URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/debitRealTimePayments'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/debitRealTimePayments'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          description: |-
            Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

            This problem responsemay have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidAccountIds/v1.0.0`](https://static.api.apiture.com/errors/invalidAccountIds/v1.0.0)<br>
              One or more account IDs are invalid and do not correspond to accounts.
              Remediation: Remove the invalid account IDs from the request and try again.
            The `attributes` object in the error may have the properties defined for [`invalidAccountIds`](https://static.api.apiture.com/errors/invalidAccountIds/v1.0.0).
          x-apiture-errors:
            - $ref: '#/components/x-apiture-errors/invalidAccountIds'
          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:
        - accessToken:
            - banking/read
      x-apiture-permission: listDebitRealTimePayments
  /debitRealTimePayments/{debitRealTimePaymentId}:
    parameters:
      - $ref: '#/components/parameters/debitRealTimePaymentIdPathParam'
    get:
      summary: Fetch a representation of this debit real-time payment
      description: Return the JSON representation of this debit real-time payment resource.
      operationId: getDebitRealTimePayment
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: debitRealTimePayments
      tags:
        - Debit Real-Time Payments
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/debitRealTimePayment'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/debitRealTimePayment'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404DebitRealTimePayment'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - accessToken:
            - banking/read
      x-apiture-permission: getDebitRealTimePayment
  /creditRealTimePayments:
    get:
      summary: Return a collection of credit real-time payments
      description: Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) collection of credit real-time payments. The result is ordered by default in reverse chronological order based on the created date (`createdAt`) of the credit real-time payments.
      operationId: listCreditRealTimePayments
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePayments
      tags:
        - Credit Real-Time Payments
      parameters:
        - name: customerId
          description: Restrict payment resources based on the customer ID. This is the ID of the customer that created the real-time payment.
          in: query
          schema:
            $ref: '#/components/schemas/resourceId'
        - name: recipientName
          description: Return only credit real-time payments whose `recipient.name` contains this substring of at least two characters, ignoring case.
          in: query
          schema:
            type: string
            format: text
            minLength: 2
            maxLength: 140
        - name: state
          description: Return only credit real-time payments whose `state` matches one of the items in this pipe-delimited list.
          in: query
          schema:
            type: array
            minItems: 1
            maxItems: 8
            uniqueItems: true
            items:
              $ref: '#/components/schemas/creditRealTimePaymentState'
          style: pipeDelimited
          explode: false
        - name: trackingNumber
          description: Return only credit real-time payments whose `trackingNumber` matches this value.
          in: query
          schema:
            $ref: '#/components/schemas/realTimePaymentTrackingNumber'
        - name: processedAt
          description: 'Return only credit real-time payments whose `processedAt` date matches with the value or date range. Can search up to 2 years in the past. Date ranges use [range notation](https://dx.apiture.com/docs/api/concepts/collection-filtering/#range-filters). Examples: <ul> <li> `[2023-05-01,2023-05-31]` between May 1 and 31, 2023, inclusive</li> <li> `[2023-05-01,2023-06-01)` on or after May 1, but _before_ June 1 (in May, 2023)</li> <li> `[2023-05-19,]` on or after May 19, 2023</li> <li> `[,2023-05-19]` on or before May 19, 2023</li> <li> `2023-05-19`</li> uploaded on May 19, 2023. </ul>'
          in: query
          schema:
            $ref: '#/components/schemas/dateRange'
        - name: accounts
          description: Return only credit real-time payments which were sent from one of these accounts.
          in: query
          style: form
          explode: false
          schema:
            $ref: '#/components/schemas/bankingAccountIdSelection'
        - name: amount
          description: 'Return only credit real-time payments whose `amount` is in this range. Amount ranges use [range notation](https://dx.apiture.com/docs/api/concepts/collection-filtering/#range-filters). The value may have the following forms: <ul> <li>`1200.50` match the dollar amount 1,200.50 exactly</li> <li>`[1000.00,1200.00)` matches items where `1000.00 <= amount < 1200.00`</li> <li>`[1000.00,1199.99]` matches items where `1000.00 <= amount <= 1199.99`</li> <li>`(999.99,1200.00)` matches items where `999.99 < amount < 1200.00`</li> <li>`[1200.50,]` matches items where `amount >= 1200.50`</li> <li>`(1200.50,)` matches items where `amount > 1200.50`</li> <li>`[,1200.50]` matches items where `amount <= 1200.50`</li> <li>`(,1200.50)` matches items where `amount < 1200.50`</li> </ul>'
          in: query
          schema:
            $ref: '#/components/schemas/amountRange'
        - name: sortBy
          description: The sort order for the items in the response. Use `?sortBy=createdAt` or `?sortBy=-createdAt` to sort by ascending or descending order of the payment's `createdAt` date-time. The default is `-createdAt`.
          in: query
          style: form
          explode: false
          schema:
            type: array
            uniqueItems: true
            $comment: Defined as an array so we can pass multiple sort keys in the future.
            maxItems: 1
            minItems: 1
            items:
              description: The sort key defining which value to sort by. A `-` prefix means descending.
              type: string
              pattern: ^-?(createdAt)
              minLength: 9
              maxLength: 10
        - $ref: '#/components/parameters/startQueryParam'
        - $ref: '#/components/parameters/limitQueryParam'
      responses:
        '200':
          description: OK. A page from the full list of the customer's credit real-time payments. While the `nextPage_url` property is present in the response, the client can fetch the next page of credit real-time payments by performing a `GET` on that URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/creditRealTimePayments'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/creditRealTimePayments'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          description: |-
            Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

            This problem responsemay have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidAccountIds/v1.0.0`](https://static.api.apiture.com/errors/invalidAccountIds/v1.0.0)<br>
              One or more account IDs are invalid and do not correspond to accounts.
              Remediation: Remove the invalid account IDs from the request and try again.
            The `attributes` object in the error may have the properties defined for [`invalidAccountIds`](https://static.api.apiture.com/errors/invalidAccountIds/v1.0.0).
          x-apiture-errors:
            - $ref: '#/components/x-apiture-errors/invalidAccountIds'
          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:
        - accessToken:
            - banking/read
      x-apiture-permission: listCreditRealTimePayments
    post:
      summary: Create a new credit real-time payment
      description: |-
        Create a new real-time payment to credit a recipient's account from funds in an internal account.

        Once a commercial user successfully creates a credit real-time payment, the state is set as `pendingApproval` and requires approval in order to transition to the `scheduled` state.

        Once a retail user successfully creates a credit real-time payment, the state is set as `scheduled` and immediately begins processing.
      operationId: createCreditRealTimePayment
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePayments
      tags:
        - Credit Real-Time Payments
      requestBody:
        required: true
        description: The data necessary to create a new credit real-time payment.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/newCreditRealTimePayment'
      responses:
        '201':
          description: Created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/creditRealTimePayment'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/creditRealTimePayment'
          headers:
            Location:
              description: The URI of the new credit real-time payment.
              schema:
                type: string
                format: uri-reference
                maxLength: 2048
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          description: |
            Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

            This problem responsemay have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentSourceAccount/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentSourceAccount/v1.0.0)<br>
              The chosen source account does not exist, is not accessible, or is not entitled for real-time payments.
              Remediation: Choose an existing source account with the correct entitlement for real-time payments.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentAmount/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentAmount/v1.0.0)<br>
              The amount is $0.00, is more than 14 total digits, or the amount of the real-time payment exceeds the allowed limit within a certain period.
              Remediation: Change the amount to a value greater than $0.00 with no more than 14 total digits, that does not exceed the allowed limit and resubmit.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumber/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumber/v1.0.0)<br>
              The routing number for the recipient financial institution is invalid.
              Remediation: Use a valid routing number.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientAccount/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientAccount/v1.0.0)<br>
              The chosen recipient account does not exist, is not accessible, or is not entitled for real-time payments.
              Remediation: Choose an existing recipient account with the correct entitlement for real-time payments.

            * [`https://static.api.apiture.com/errors/emptyRealTimePaymentRecipientAddress/v1.0.0`](https://static.api.apiture.com/errors/emptyRealTimePaymentRecipientAddress/v1.0.0)<br>
              The address object was included for the recipient but no fields were included inside the address object.
              Remediation: Either do not include the address object for the recipient or include at least one field inside the address object.

            * [`https://static.api.apiture.com/errors/emptyRealTimePaymentSenderAddress/v1.0.0`](https://static.api.apiture.com/errors/emptyRealTimePaymentSenderAddress/v1.0.0)<br>
              The address object was included for the sender but no fields were included inside the address object.
              Remediation: Either do not include the address object for the sender or include at least one field inside the address object.

            * [`https://static.api.apiture.com/errors/missingRealTimePaymentRecipientAddressFields/v1.0.0`](https://static.api.apiture.com/errors/missingRealTimePaymentRecipientAddressFields/v1.0.0)<br>
              At least one field has been provided for the recipient address but `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, or `postalCode` is missing.
              Remediation: If any fields are provided for the recipient address, provide `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, and `postalCode`.

            * [`https://static.api.apiture.com/errors/missingRealTimePaymentSenderAddressFields/v1.0.0`](https://static.api.apiture.com/errors/missingRealTimePaymentSenderAddressFields/v1.0.0)<br>
              At least one field has been provided for the sender address but `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, or `postalCode` is missing.
              Remediation: If any fields are provided for the recipient address, provide `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, and `postalCode`.

            * [`https://static.api.apiture.com/errors/remittanceAdviceEmailAddressTooLong/v1.0.0`](https://static.api.apiture.com/errors/remittanceAdviceEmailAddressTooLong/v1.0.0)<br>
              When the remittance advice `method` is `email`, the `address` can be no longer than 255 characters.
              Remediation: Shorten the `address` of the remittance advice to 255 characters or less if the `method` is `email`.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientUsPostalCode/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientUsPostalCode/v1.0.0)<br>
              The recipient's `countryCode` is `US` but the `postalCode` is not in the correct format.
              Remediation: If the recipient's `countryCode` is `US`, provide a value for `postalCode` that is either a five digit US ZIP code or a ten character ZIP+4.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentSenderUsPostalCode/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentSenderUsPostalCode/v1.0.0)<br>
              The sender's `countryCode` is `US` but the `postalCode` is not in the correct format.
              Remediation: If the sender's `countryCode` is `US`, provide a value for `postalCode` that is either a five digit US ZIP code or a ten character ZIP+4.

            * [`https://static.api.apiture.com/errors/institutionDoesNotSupportRealTimePayments/v1.0.0`](https://static.api.apiture.com/errors/institutionDoesNotSupportRealTimePayments/v1.0.0)<br>
              The routing number is valid but the financial institution does not support real-time payments.
              Remediation: Use a routing number for a financial institution that does support real-time payments.
          x-apiture-errors:
            - invalidRealTimePaymentSourceAccount
            - invalidRealTimePaymentAmount
            - invalidRealTimePaymentRecipientRoutingNumber
            - invalidRealTimePaymentRecipientAccount
            - emptyRealTimePaymentRecipientAddress
            - emptyRealTimePaymentSenderAddress
            - missingRealTimePaymentRecipientAddressFields
            - missingRealTimePaymentSenderAddressFields
            - remittanceAdviceEmailAddressTooLong
            - invalidRealTimePaymentRecipientUsPostalCode
            - invalidRealTimePaymentSenderUsPostalCode
            - institutionDoesNotSupportRealTimePayments
          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:
        - accessToken:
            - banking/write
      x-apiture-permission: createCreditRealTimePayment
  /creditRealTimePayments/{creditRealTimePaymentId}:
    parameters:
      - $ref: '#/components/parameters/creditRealTimePaymentIdPathParam'
    get:
      summary: Fetch a representation of this credit real-time payment
      description: Return the JSON representation of this credit real-time payment resource.
      operationId: getCreditRealTimePayment
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePayments
      tags:
        - Credit Real-Time Payments
      parameters:
        - name: unmasked
          description: When requesting a credit real-time payment, `sender.governmentIssuedId` and `recipient.fullAccountNumber` are not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes the `sender.governmentIssuedId` and `recipient.fullAccountNumber`. Such requests are auditable.
          in: query
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/creditRealTimePayment'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/creditRealTimePayment'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404CreditRealTimePayment'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - accessToken:
            - banking/read
      x-apiture-permission: getCreditRealTimePayment
    patch:
      summary: Update the credit real-time payment
      description: Perform a partial update of the credit real-time payment as per [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7396). Only fields in the request body are updated on the resource; fields which are omitted are not updated.
      operationId: patchCreditRealTimePayment
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePayments
      parameters:
        - name: unmasked
          description: When updating a credit real-time payment, `sender.governmentIssuedId` and `recipient.fullAccountNumber` are not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes the `sender.governmentIssuedId` and `recipient.fullAccountNumber`. Such requests are auditable.
          in: query
          schema:
            type: boolean
            default: false
      tags:
        - Credit Real-Time Payments
      requestBody:
        required: true
        description: The updated credit real-time payment.
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/creditRealTimePaymentPatch'
          application/json:
            schema:
              $ref: '#/components/schemas/creditRealTimePaymentPatch'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/creditRealTimePayment'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/creditRealTimePayment'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404CreditRealTimePayment'
        '409':
          $ref: '#/components/responses/409'
        '422':
          description: |
            Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

            This problem responsemay have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentSourceAccount/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentSourceAccount/v1.0.0)<br>
              The chosen source account does not exist, is not accessible, or is not entitled for real-time payments.
              Remediation: Choose an existing source account with the correct entitlement for real-time payments.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentAmount/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentAmount/v1.0.0)<br>
              The amount is $0.00, is more than 14 total digits, or the amount of the real-time payment exceeds the allowed limit within a certain period.
              Remediation: Change the amount to a value greater than $0.00 with no more than 14 total digits, that does not exceed the allowed limit and resubmit.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumber/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumber/v1.0.0)<br>
              The routing number for the recipient financial institution is invalid.
              Remediation: Use a valid routing number.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientAccount/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientAccount/v1.0.0)<br>
              The chosen recipient account does not exist, is not accessible, or is not entitled for real-time payments.
              Remediation: Choose an existing recipient account with the correct entitlement for real-time payments.

            * [`https://static.api.apiture.com/errors/emptyRealTimePaymentRecipientAddress/v1.0.0`](https://static.api.apiture.com/errors/emptyRealTimePaymentRecipientAddress/v1.0.0)<br>
              The address object was included for the recipient but no fields were included inside the address object.
              Remediation: Either do not include the address object for the recipient or include at least one field inside the address object.

            * [`https://static.api.apiture.com/errors/emptyRealTimePaymentSenderAddress/v1.0.0`](https://static.api.apiture.com/errors/emptyRealTimePaymentSenderAddress/v1.0.0)<br>
              The address object was included for the sender but no fields were included inside the address object.
              Remediation: Either do not include the address object for the sender or include at least one field inside the address object.

            * [`https://static.api.apiture.com/errors/remittanceAdviceEmailAddressTooLong/v1.0.0`](https://static.api.apiture.com/errors/remittanceAdviceEmailAddressTooLong/v1.0.0)<br>
              When the remittance advice `method` is `email`, the `address` can be no longer than 255 characters.
              Remediation: Shorten the `address` of the remittance advice to 255 characters or less if the `method` is `email`.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientUsPostalCode/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientUsPostalCode/v1.0.0)<br>
              The recipient's `countryCode` is `US` but the `postalCode` is not in the correct format.
              Remediation: If the recipient's `countryCode` is `US`, provide a value for `postalCode` that is either a five digit US ZIP code or a ten character ZIP+4.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentSenderUsPostalCode/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentSenderUsPostalCode/v1.0.0)<br>
              The sender's `countryCode` is `US` but the `postalCode` is not in the correct format.
              Remediation: If the sender's `countryCode` is `US`, provide a value for `postalCode` that is either a five digit US ZIP code or a ten character ZIP+4.

            * [`https://static.api.apiture.com/errors/institutionDoesNotSupportRealTimePayments/v1.0.0`](https://static.api.apiture.com/errors/institutionDoesNotSupportRealTimePayments/v1.0.0)<br>
              The routing number is valid but the financial institution does not support real-time payments.
              Remediation: Use a routing number for a financial institution that does support real-time payments.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentStateForEdit/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentStateForEdit/v1.0.0)<br>
              The edit operation is not allowed if the credit real-time payment `allows.edit` is `false`.
              Remediation: Do not attempt to update a real-time payment if `allows.edit` is `false`.
          x-apiture-errors:
            - invalidRealTimePaymentSourceAccount
            - invalidRealTimePaymentAmount
            - invalidRealTimePaymentRecipientRoutingNumber
            - invalidRealTimePaymentRecipientAccount
            - emptyRealTimePaymentRecipientAddress
            - emptyRealTimePaymentSenderAddress
            - remittanceAdviceEmailAddressTooLong
            - invalidRealTimePaymentRecipientUsPostalCode
            - invalidRealTimePaymentSenderUsPostalCode
            - institutionDoesNotSupportRealTimePayments
            - invalidRealTimePaymentStateForEdit
          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:
        - accessToken:
            - banking/write
      x-apiture-permission: patchCreditRealTimePayment
  /creditRealTimePayments/{creditRealTimePaymentId}/submitted:
    parameters:
      - $ref: '#/components/parameters/creditRealTimePaymentIdPathParam'
    post:
      operationId: submitCreditRealTimePayment
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePaymentActions
      summary: Submit a credit real-time payment
      description: |-
        Submit a credit real-time payment for approval or scheduling. If the customer has the approval entitlement, this action does not automatically add the customer to the `creditRealTimePayment.approvers` list. The customer should manually approve the payment through the [`approveCreditRealTimePayment`](#op-approveCreditRealTimePayment) operation. The `creditRealTimePayment.allows.submit` property must be `true` on the payment for the current customer to submit the payment. This operation is idempotent: no changes are made if the payment is already in the `pendingApproval` or `scheduled` state.

        For commercial customers: once submitted, the credit real-time payment transitions to the `pendingApproval` state. For retail customers: once submitted, the credit real-time payment transitions to the `scheduled` state.
      parameters:
        - name: unmasked
          description: When submitting a credit real-time payment, `sender.governmentIssuedId` and `recipient.fullAccountNumber` are not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes the `sender.governmentIssuedId` and `recipient.fullAccountNumber`. Such requests are auditable.
          in: query
          schema:
            type: boolean
            default: false
      tags:
        - Credit Real-Time Payment Actions
      responses:
        '200':
          description: OK. The operation succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/creditRealTimePayment'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/creditRealTimePayment'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404CreditRealTimePayment'
        '409':
          description: |
            Conflict. The request to submit the credit real-time payment is not allowed. Either the payment still has problems which prevent it from being submitted, or its state is `scheduled` or beyond.

            This problem responsemay have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentStateForSubmit/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentStateForSubmit/v1.0.0)<br>
              The submit operation is not allowed if the credit real-time payment `allows.submit` is `false`.
              Remediation: Resolve any problems in the credit real-time payment so that the payment `allows.submit` is `true`.
          x-apiture-errors:
            - invalidRealTimePaymentStateForSubmit
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - accessToken:
            - banking/write
      x-apiture-permission: submitCreditRealTimePayment
  /realTimePayments/{realTimePaymentId}/realTimePaymentHistoryRecords:
    parameters:
      - $ref: '#/components/parameters/realTimePaymentIdPathParam'
    get:
      summary: Return real-time payment history records
      description: Return a list of history records for this real-time payment. The result is ordered in reverse chronological order based on the `occurredAt` date of the history records.
      operationId: listRealTimePaymentHistoryRecords
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: realTimePaymentHistoryRecords
      tags:
        - Real-Time Payment History Records
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/realTimePaymentHistoryRecords'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/realTimePaymentHistoryRecords'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404RealTimePayment'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - accessToken:
            - banking/read
      x-apiture-permission: listRealTimePaymentHistoryRecords
  /creditRealTimePaymentEligibleApprovers:
    get:
      summary: List Eligible Approvers for Credit Real-Time Payments
      description: |-
        Return a list of customers eligible to approve a list of credit real-time payments.

        The response of this operation may be reused as the request for the [`addCreditRealTimePaymentApprovers`](#op-addCreditRealTimePaymentApprovers) operation, possibly after filtering the approvers list to reflect user selection.
      operationId: listEligibleCreditRealTimePaymentApprovers
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePayments
      tags:
        - Credit Real-Time Payments
      parameters:
        - name: creditRealTimePayments
          description: A list of credit real-time payment IDs for building the list of eligible approvers.
          required: true
          style: form
          explode: false
          in: query
          schema:
            $ref: '#/components/schemas/creditRealTimePaymentIds'
      security:
        - accessToken:
            - banking/read
      responses:
        '200':
          description: OK. The operation succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bulkEligibleCreditRealTimePaymentApprovers'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404CreditRealTimePayment'
        '409':
          description: Conflict. Listing eligible approvers failed for all credit real-time payments. This may be due to a configuration error or other problem that prevents listing approvers.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      x-apiture-permission: listEligibleCreditRealTimePaymentApprovers
  /creditRealTimePaymentApprovers:
    post:
      summary: Add approvers to credit real-time payments
      description: |-
        Add approvers to a set of credit real-time payments. This operation also notifies those approvers that they need to review then [approve](#op-approveCreditRealTimePayments) or [reject](#op-rejectCreditRealTimePayments) each of the payments. This operation is only allowed if the payment is in a `pendingApproval` state and has no errors. Approvers may only approve a payment if `creditRealTimePayment.allows.approve` is `true`.

        The request body for this operation may be derived from the response of the [`listEligibleCreditRealTimePaymentApprovers`](#op-listEligibleCreditRealTimePaymentApprovers) operation, possibly with a subset of approvers per payment based on user selection.

        The `204` response indicates the approvers were successfully added to all payments. The `200` response indicates a partial success and includes details on any failed additions, such as a payment has begun processing.
      operationId: addCreditRealTimePaymentApprovers
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePaymentsActions
      tags:
        - Credit Real-Time Payment Actions
      requestBody:
        required: true
        description: The data necessary to add the approvers of credit real-time payments.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulkCreditRealTimePaymentApproversRequest'
      responses:
        '200':
          description: |
            OK. The request was successfully processed. However, adding approvers to one or more credit real-time payments has failed; the response body indicates which succeeded and which failed.

            This response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0)<br>
              The specified real-time payment ID is invalid or does not refer to an existing real-time payment.
              Remediation: Specify the ID of an existing real-time payment for which the user has access.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentStateForAddApprovers/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentStateForAddApprovers/v1.0.0)<br>
              The credit real-time payment cannot have approvers added when in the current state.
              Remediation: The credit real-time payment state must be `pendingApproval`.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentApprover/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentApprover/v1.0.0)<br>
              The requested approver is not eligible for approving this credit real-time payment.
              Remediation: Pass only eligible approvers from the `listEligibleCreditRealTimePaymentApprovers` operation.
          x-apiture-errors:
            - invalidRealTimePaymentId
            - invalidRealTimePaymentStateForAddApprovers
            - invalidRealTimePaymentApprover
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/creditRealTimePaymentBulkApprovers'
        '204':
          description: No Content. All approvers were successfully added to the payments without any problems.
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          description: Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.
          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:
        - accessToken:
            - banking/write
      x-apiture-permission: addCreditRealTimePaymentApprovers
  /creditRealTimePaymentApprovals:
    post:
      summary: Approve Credit Real-Time Payments
      description: |-
        Approve one or more credit real-time payments for processing.

        The `creditRealTimePayment.allows.approve` property must be `true` on each payment for the current customer to approve the payment. This operation is only allowed if the payment is in a `pendingApproval` state and has no errors. This operation is idempotent: no changes are made to a payment if the customer has already approved it.

        This adds the approver to the `creditRealTimePayment.approvers` list of each payment unless already listed. If all the required approvals have been given, the payment changes to the `scheduled` state to be processed.

        This operation may successfully approve some payments and fail on others. This includes failures due to the customer's permissions (for example if a payment's `allows.approve` is `false`) or the state of one or more payments. Errors and problems are returned in the `problems` list in the corresponding payments in the response `items`. This operation may require an additional authentication challenge to verify the customer's identity.

        The `200` response indicates a partial success and includes details on any failed approvals. The `204` response indicates that all of the credit real-time payments were successfully approved. The `422` response indicates that none of the credit real-time payments were successfully approved.
      operationId: approveCreditRealTimePayments
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePaymentActions
      tags:
        - Credit Real-Time Payment Actions
      requestBody:
        required: true
        description: Request data accompanying the action to approve the credit real-time payment.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulkCreditRealTimePaymentApprovalRequest'
      responses:
        '200':
          description: |
            OK. The request was successfully processed. However, approving one or more credit real-time payments has failed; the response body indicates which succeeded and which failed.

            This response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0)<br>
              The specified real-time payment ID is invalid or does not refer to an existing real-time payment.
              Remediation: Specify the ID of an existing real-time payment for which the user has access.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentStateForApprove/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentStateForApprove/v1.0.0)<br>
              The approve operation is not allowed if the credit real-time payment `allows.approve` is `false`.
              Remediation: Resolve any problems in the credit real-time payment so that the payment `allows.approve` is `true`.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentSourceAccount/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentSourceAccount/v1.0.0)<br>
              The chosen source account does not exist, is not accessible, or is not entitled for real-time payments.
              Remediation: Choose an existing source account with the correct entitlement for real-time payments.

            * [`https://static.api.apiture.com/errors/realTimePaymentLimitExceeded/v1.0.0`](https://static.api.apiture.com/errors/realTimePaymentLimitExceeded/v1.0.0)<br>
              The credit real-time payment exceed a daily, transaction, or temporary limit.
              Remediation: Pass an amount for the credit real-time payment that does not exceed the  daily, transaction, or temporary limit.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumber/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumber/v1.0.0)<br>
              The routing number for the recipient financial institution is invalid.
              Remediation: Use a valid routing number.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientAccount/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientAccount/v1.0.0)<br>
              The chosen recipient account does not exist, is not accessible, or is not entitled for real-time payments.
              Remediation: Choose an existing recipient account with the correct entitlement for real-time payments.

            * [`https://static.api.apiture.com/errors/institutionDoesNotSupportRealTimePayments/v1.0.0`](https://static.api.apiture.com/errors/institutionDoesNotSupportRealTimePayments/v1.0.0)<br>
              The routing number is valid but the financial institution does not support real-time payments.
              Remediation: Use a routing number for a financial institution that does support real-time payments.
          x-apiture-errors:
            - invalidRealTimePaymentId
            - invalidRealTimePaymentStateForApprove
            - invalidRealTimePaymentSourceAccount
            - realTimePaymentLimitExceeded
            - invalidRealTimePaymentRecipientRoutingNumber
            - invalidRealTimePaymentRecipientAccount
            - institutionDoesNotSupportRealTimePayments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bulkCreditRealTimePaymentApprovalResponse'
        '204':
          description: No Content. All credit real-time payments were successfully approved.
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          description: |
            Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

            This problem responsemay have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentIds/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentIds/v1.0.0)<br>
              All of the real-time payment IDs are invalid or do not refer to an existing real-time payment.
              Remediation: Specify the IDs of existing real-time payments for which the user has access.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentsStateForApprove/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentsStateForApprove/v1.0.0)<br>
              The approve operation is not allowed if the credit real-time payments `allows.approve` are `false`.
              Remediation: Resolve any problems in the credit real-time payments so that each payment `allows.approve` is `true`.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentSourceAccounts/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentSourceAccounts/v1.0.0)<br>
              The chosen source accounts do not exist, are not accessible, or are not entitled for real-time payments.
              Remediation: Choose existing source accounts with the correct entitlement for real-time payments.

            * [`https://static.api.apiture.com/errors/realTimePaymentsLimitExceeded/v1.0.0`](https://static.api.apiture.com/errors/realTimePaymentsLimitExceeded/v1.0.0)<br>
              The credit real-time payments exceed a daily, transaction, or temporary limit.
              Remediation: Pass an amount for each credit real-time payment that does not exceed the  daily, transaction, or temporary limit.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumbers/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumbers/v1.0.0)<br>
              The routing number for the recipient financial institution for each credit real-time payment is invalid.
              Remediation: Use a valid routing number for each credit real-time payment.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientAccounts/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientAccounts/v1.0.0)<br>
              The chosen recipient accounts do not exist, are not accessible, or are not entitled for real-time payments.
              Remediation: Choose existing recipient accounts with the correct entitlement for real-time payments.

            * [`https://static.api.apiture.com/errors/institutionsDoNotSupportRealTimePayments/v1.0.0`](https://static.api.apiture.com/errors/institutionsDoNotSupportRealTimePayments/v1.0.0)<br>
              The routing numbers are valid but the financial institutions do not support real-time payments.
              Remediation: Use routing numbers for financial institutions that support real-time payments.
          x-apiture-errors:
            - invalidRealTimePaymentIds
            - invalidRealTimePaymentsStateForApprove
            - invalidRealTimePaymentSourceAccounts
            - realTimePaymentsLimitExceeded
            - invalidRealTimePaymentRecipientRoutingNumbers
            - invalidRealTimePaymentRecipientAccounts
            - institutionsDoNotSupportRealTimePayments
          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:
        - accessToken:
            - banking/write
      x-apiture-permission: approveCreditRealTimePayments
  /rejectedCreditRealTimePayments:
    post:
      summary: Reject Credit Real-Time Payments
      description: |-
        Reject one or more credit real-time payments.

        The `creditRealTimePayment.allows.reject` property must be `true` on each payment for the current customer to reject the payment. If the `creditRealTimePayment.allows.reject` property is `false` for some but not all of the individual payments in the list, rejection for the individual payment will fail. The failure will be indicated with the response `400` `invalidRealTimePaymentStateForReject` in the response body, and the other payments in the request will still be processed. If the `creditRealTimePayment.allows.reject` property is `false` for *all* of the individual payments in the list, rejection for all the payments will fail with the response `422` `invalidRealTimePaymentsStateForDelete`.

        Once rejected, each credit real-time payment transitions to the `rejected` state. This operation is idempotent: no changes are made if the payments are already in the `rejected` state.

        The `200` response indicates a partial success and includes details on any failed rejections. The `204` response indicates that all of the credit real-time payments were successfully rejected. The `422` response indicates that none of the credit real-time payments were successfully rejected.
      operationId: rejectCreditRealTimePayments
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePaymentActions
      tags:
        - Credit Real-Time Payment Actions
      requestBody:
        required: true
        description: Request containing the credit real-time payments to reject.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulkCreditRealTimePaymentRejectionRequest'
      responses:
        '200':
          description: |
            OK. The request was successfully processed. However, rejecting one or more credit real-time payments has failed; the response body indicates which succeeded and which failed.

            This response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0)<br>
              The specified real-time payment ID is invalid or does not refer to an existing real-time payment.
              Remediation: Specify the ID of an existing real-time payment for which the user has access.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentStateForReject/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentStateForReject/v1.0.0)<br>
              The reject operation is not allowed if the credit real-time payment `allows.reject` is `false`.
              Remediation: Resolve any problems in the credit real-time payment so that the payment `allows.reject` is `true`.
          x-apiture-errors:
            - invalidRealTimePaymentId
            - invalidRealTimePaymentStateForReject
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bulkCreditRealTimePaymentRejectionResponse'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/bulkCreditRealTimePaymentRejectionResponse'
        '204':
          description: No Content. All credit real-time payments were successfully rejected.
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          description: |
            Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

            This problem responsemay have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentIds/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentIds/v1.0.0)<br>
              All of the real-time payment IDs are invalid or do not refer to an existing real-time payment.
              Remediation: Specify the IDs of existing real-time payments for which the user has access.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentsStateForReject/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentsStateForReject/v1.0.0)<br>
              The reject operation is not allowed if the credit real-time payments `allows.reject` are `false`.
              Remediation: Resolve any problems in the credit real-time payments so that each payment `allows.reject` is `true`.
          x-apiture-errors:
            - invalidRealTimePaymentIds
            - invalidRealTimePaymentsStateForReject
          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:
        - accessToken:
            - banking/write
      x-apiture-permission: rejectCreditRealTimePayments
  /deletedCreditRealTimePayments:
    post:
      summary: Delete Credit Real-Time Payments
      description: |-
        Delete one or more credit real-time payments.

        Deletion of one or more credit real-time payments may fail if those payments were previously deleted. The `creditRealTimePayment.allows.delete` property must be `true` on each payment for the current customer to delete the payment. If the `creditRealTimePayment.allows.delete` property is `false` for some but not all of the individual payments in the list, deletion for the individual payment will fail. The failure will be indicated with the response `400` `invalidRealTimePaymentStateForDelete` in the response body, and the other payments in the request will still be processed. If the `creditRealTimePayment.allows.delete` property is `false` for *all* of the individual payments in the list, deletion for all the payments will fail with the response `422` `invalidRealTimePaymentsStateForDelete`.

        The `200` response indicates a partial success and includes details on any failed deletions. The `204` response indicates that all of the credit real-time payments were successfully deleted. The `422` response indicates that none of the credit real-time payments were successfully deleted.
      operationId: deleteCreditRealTimePayments
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePayments
      tags:
        - Credit Real-Time Payments
      requestBody:
        required: true
        description: Request containing the credit real-time payments to delete.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulkCreditRealTimePaymentDeletionRequest'
      responses:
        '200':
          description: |
            OK. The request was successfully processed. However, deleting one or more credit real-time payments has failed; the response body indicates which succeeded and which failed.

            This response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0)<br>
              The specified real-time payment ID is invalid or does not refer to an existing real-time payment.
              Remediation: Specify the ID of an existing real-time payment for which the user has access.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentStateForDelete/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentStateForDelete/v1.0.0)<br>
              The delete operation is not allowed if the credit real-time payment `allows.delete` is `false`.
              Remediation: Resolve any problems in the credit real-time payment so that the payment `allows.delete` is `true`.
          x-apiture-errors:
            - invalidRealTimePaymentId
            - invalidRealTimePaymentStateForDelete
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bulkCreditRealTimePaymentDeletionResponse'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/bulkCreditRealTimePaymentDeletionResponse'
        '204':
          description: No Content. All credit real-time payments were successfully deleted.
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          description: |
            Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

            This problem responsemay have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentIds/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentIds/v1.0.0)<br>
              All of the real-time payment IDs are invalid or do not refer to an existing real-time payment.
              Remediation: Specify the IDs of existing real-time payments for which the user has access.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentsStateForDelete/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentsStateForDelete/v1.0.0)<br>
              The delete operation is not allowed if the credit real-time payments `allows.delete` are `false`.
              Remediation: Resolve any problems in credit real-time payments so that each payment `allows.delete` is `true`.
          x-apiture-errors:
            - invalidRealTimePaymentIds
            - invalidRealTimePaymentsStateForDelete
          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:
        - accessToken:
            - banking/write
      x-apiture-permission: deleteCreditRealTimePayments
  /eligibleRecipientAccounts:
    post:
      summary: Check eligibility of the recipient account for receiving credit real-time payments
      description: Check whether the given recipient account is eligible to receive credit real-time payments. Factors that influence eligibility include the type of the account and whether the financial institution that holds the recipient account allows real-time payments.
      operationId: checkRecipientAccountEligibility
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePayments
      tags:
        - Credit Real-Time Payment Recipients
      requestBody:
        required: true
        description: Data necessary to identify a recipient account.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/realTimePaymentRecipientAccountEligibilityRequest'
      responses:
        '200':
          description: |
            OK. The eligibility check succeeded. If the recipient account is not eligible to receive credit real-time payments, the response body will indicate the reason if this information is available.

            This response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumber/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumber/v1.0.0)<br>
              The routing number for the recipient financial institution is invalid.
              Remediation: Use a valid routing number.

            * [`https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientAccount/v1.0.0`](https://static.api.apiture.com/errors/invalidRealTimePaymentRecipientAccount/v1.0.0)<br>
              The chosen recipient account does not exist, is not accessible, or is not entitled for real-time payments.
              Remediation: Choose an existing recipient account with the correct entitlement for real-time payments.

            * [`https://static.api.apiture.com/errors/institutionDoesNotSupportRealTimePayments/v1.0.0`](https://static.api.apiture.com/errors/institutionDoesNotSupportRealTimePayments/v1.0.0)<br>
              The routing number is valid but the financial institution does not support real-time payments.
              Remediation: Use a routing number for a financial institution that does support real-time payments.
          x-apiture-errors:
            - invalidRealTimePaymentRecipientRoutingNumber
            - invalidRealTimePaymentRecipientAccount
            - institutionDoesNotSupportRealTimePayments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/realTimePaymentRecipientAccountEligibility'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/realTimePaymentRecipientAccountEligibility'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          description: Unprocessable Entity.
          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:
        - accessToken:
            - banking/read
      x-apiture-permission: checkRecipientAccountEligibility
  /realTimePaymentRecipients:
    get:
      summary: Return a list of unique recipients
      description: Return a list of unique credit real-time payment recipients, limited to two hundred recipients. The payment's `createdAt` date-time descending is used to gather up to two hundred recipients by recency. The list is then sorted by the recipient's `name` ascending and then by the recipient's `accountNumber` ascending.
      operationId: listRealTimePaymentRecipients
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePayments
      tags:
        - Credit Real-Time Payment Recipients
      parameters:
        - name: unmasked
          description: When requesting credit real-time payment recipients, `fullAccountNumber` is not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes the `fullAccountNumber`. Such requests are auditable.
          in: query
          schema:
            type: boolean
            default: false
        - name: customerId
          description: Restrict recipient resources based on the customer ID. This is the ID of the customer that created the real-time payment.
          in: query
          schema:
            $ref: '#/components/schemas/resourceId'
      responses:
        '200':
          description: OK. A list of the most recent unique recipients.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/realTimePaymentRecipients'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/realTimePaymentRecipients'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - accessToken:
            - banking/read
      x-apiture-permission: listRealTimePaymentRecipients
  /recentRealTimePaymentRecipients:
    get:
      summary: Return a list of the most recent unique recipients
      description: Return a list of the most recent unique credit real-time payment recipients, limited to five recipients.
      operationId: listRecentRealTimePaymentRecipients
      x-apiture-api: bankingRealTimePayments
      x-apiture-group: creditRealTimePayments
      tags:
        - Credit Real-Time Payment Recipients
      parameters:
        - name: unmasked
          description: When requesting credit real-time payment recipients, `fullAccountNumber` is not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes the `fullAccountNumber`. Such requests are auditable.
          in: query
          schema:
            type: boolean
            default: false
        - name: customerId
          description: Restrict recipient resources based on the customer ID. This is the ID of the customer that created the real-time payment.
          in: query
          schema:
            $ref: '#/components/schemas/resourceId'
      responses:
        '200':
          description: OK. A list of the most recent unique recipients.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/recentRealTimePaymentRecipients'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/recentRealTimePaymentRecipients'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - accessToken:
            - banking/read
      x-apiture-permission: listRecentRealTimePaymentRecipients
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: API-Key
      in: header
      description: API Key based client identification. See details at [Secure Access](https://developer.apiture.com/docs/secure-access).
      x-resolved-from: ../../common/openapi.yaml#/components/securitySchemes/apiKey
    accessToken:
      type: openIdConnect
      description: OpenId Connect (OIDC) authentication/authorization. The client uses the `authorization_endpoint` and `token_endpoint` to obtain an access token to pass in the `Authorization` header. Those endpoints are available via the OIDC Configuration URL. The actual URL may vary with each financial institution. See details at [Secure Access](https://dx.apiture.com/docs/api/concepts/api-keys/).
      openIdConnectUrl: https://auth.apiture.com/oidc/.well-known/openid-configuration
      x-resolved-from: ../../common/openapi.yaml#/components/securitySchemes/accessToken
  parameters:
    realTimePaymentIdPathParam:
      name: realTimePaymentId
      description: The unique identifier of this real-time payment. This is an opaque string. This value corresponds to the `id` of a real-time payment resource.
      in: path
      schema:
        $ref: '#/components/schemas/externalResourceId'
      required: true
    debitRealTimePaymentIdPathParam:
      name: debitRealTimePaymentId
      description: The unique identifier of this debit real-time payment. This is an opaque string. This value corresponds to the `id` of a debit real-time payment resource.
      in: path
      schema:
        $ref: '#/components/schemas/externalResourceId'
      required: true
    creditRealTimePaymentIdPathParam:
      name: creditRealTimePaymentId
      description: The unique identifier of this credit real-time payment. This is an opaque string. This value corresponds to the `id` of a credit real-time payment resource.
      in: path
      schema:
        $ref: '#/components/schemas/externalResourceId'
      required: true
    startQueryParam:
      name: start
      in: query
      description: The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`.
      schema:
        type: string
        maxLength: 256
        pattern: ^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$
        default: ''
      x-resolved-from: ../../common/openapi.yaml#/components/parameters/startQueryParam
    limitQueryParam:
      name: limit
      in: query
      description: The maximum number of items to return in this paged response.
      schema:
        type: integer
        format: int32
        minimum: 0
        maximum: 1000
        default: 100
      x-resolved-from: ../../common/openapi.yaml#/components/parameters/limitQueryParam
  responses:
    '204':
      description: No Content. The operation succeeded but returned no response body.
      x-resolved-from: ../../common/openapi.yaml#/components/responses/204
    '400':
      description: |
        Bad Request. The request body, request headers, and/or query parameters are not well-formed.

        This problem responsemay 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 responsemay 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
    '403':
      description: |
        Forbidden. The authenticated caller is not authorized to perform the requested operation.

        This problem responsemay 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.

        * [`https://static.api.apiture.com/errors/customerDisabled/v1.0.0`](https://static.api.apiture.com/errors/customerDisabled/v1.0.0)<br>
          The customer is disabled.
          Remediation: Have the customer contact the financial institution for support.

        * [`https://static.api.apiture.com/errors/antiMalwareRequired/v1.0.0`](https://static.api.apiture.com/errors/antiMalwareRequired/v1.0.0)<br>
          The financial institution requires the customer to have anti-malware software installed.
          Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.

        * [`https://static.api.apiture.com/errors/modificationForbidden/v1.0.0`](https://static.api.apiture.com/errors/modificationForbidden/v1.0.0)<br>
          The customer is properly authenticated but not authorized to create, modify, or delete resources.
          Remediation: Avoid modification operation for customers with read-only authorization.

        * [`https://static.api.apiture.com/errors/challengeRequired/v1.0.0`](https://static.api.apiture.com/errors/challengeRequired/v1.0.0)<br>
          The operation requires the customer to complete an identity challenge.
          Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call.
        The `attributes` object in the error may have the properties defined by the [`requiredIdentityChallenge` schema](#schema-requiredIdentityChallenge).
        * [`https://static.api.apiture.com/errors/challengeBlocked/v1.0.0`](https://static.api.apiture.com/errors/challengeBlocked/v1.0.0)<br>
          The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication.
          Remediation: Have the user end their login session and login again.

        * [`https://static.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0`](https://static.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0)<br>
          This operation requires an identity challenge, but the user does not have the necessary registered authentication factors.
          Remediation: Have the user register one or more challenge security code delivery factors.

        * [`https://static.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0`](https://static.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0)<br>
          The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid.
          Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/forbidden'
        - $ref: '#/components/x-apiture-errors/customerDisabled'
        - $ref: '#/components/x-apiture-errors/antiMalwareRequired'
        - $ref: '#/components/x-apiture-errors/modificationForbidden'
        - $ref: '#/components/x-apiture-errors/challengeRequired'
        - $ref: '#/components/x-apiture-errors/challengeBlocked'
        - $ref: '#/components/x-apiture-errors/noIdentityChallengeFactors'
        - $ref: '#/components/x-apiture-errors/invalidIdentityChallengeHeader'
      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/403
    '404':
      description: |
        Not found. There is no such resource at the request URL.

        This problem responsemay 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
    '409':
      description: |
        Conflict. The request conflicts with the state of the application.

        This problem responsemay have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/conflict/v1.0.0`](https://static.api.apiture.com/errors/conflict/v1.0.0)<br>
          The request could not be completed due to a conflict with the current state of the target resource.
          Remediation: Try another operation that is allowed.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/conflict'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
      x-resolved-from: ../../common/openapi.yaml#/components/responses/409
    '422':
      description: |
        Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

        This problem responsemay have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/unprocessableEntity/v1.0.0`](https://static.api.apiture.com/errors/unprocessableEntity/v1.0.0)<br>
          The syntax of the request entity is correct but was unable to process the contained instructions.
          Remediation: Provide a semantically correct request.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/unprocessableEntity'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/unprocessableEntity/v1.0.0
              title: Unprocessable Entity
              status: 422
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request body and/or query parameters were well-formed but otherwise invalid.
              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/unprocessableEntity/v1.0.0
              title: Unprocessable Entity
              status: 422
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request body and/or query parameters were well-formed but otherwise invalid.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/422
    '429':
      description: |
        Too Many Requests. The client has sent too many requests in a given amount of time.

        This problem responsemay 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
    404RealTimePayment:
      description: Not Found. There is no such real-time payment resource at the specified `{realTimePaymentId}`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
    404DebitRealTimePayment:
      description: Not Found. There is no such debit real-time payment resource at the specified `{debitRealTimePaymentId}`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
    404CreditRealTimePayment:
      description: Not Found. There is no such credit real-time payment resource at the specified `{creditRealTimePaymentId}`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
    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
  schemas:
    immutableRealTimePaymentFields:
      x-apiture-version: 3.0.0
      title: Immutable Real-Time Payment Fields (v3.0.0)
      description: Immutable shared fields for the real-time payment resources.
      type: object
      x-apiture-fragment: true
      properties:
        id:
          description: The unique identifier for this real-time payment resource. This is an immutable opaque string.
          allOf:
            - $ref: '#/components/schemas/readOnlyResourceId'
        messageId:
          description: Unique id generated by the initiating system or institution, used to reference the payment for the purpose of sender/receiver communication.
          allOf:
            - $ref: '#/components/schemas/externalResourceId'
        createdAt:
          description: The date and time when the real-time payment was created, in `YYYY-MM-DDThh:mm:ss.sssZ` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date-time` UTC format.
          allOf:
            - $ref: '#/components/schemas/readOnlyTimestamp'
    debitRealTimePaymentFields:
      x-apiture-version: 3.0.1
      title: Debit Real-Time Payment Fields (v3.0.1)
      description: Fields related to debit real-time payments.
      type: object
      x-apiture-fragment: true
      properties:
        availableAt:
          description: The date and time when funds become available to the recipient, in `YYYY-MM-DDThh:mm:ss.sssZ` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date-time` UTC format.
          allOf:
            - $ref: '#/components/schemas/readOnlyTimestamp'
        state:
          description: The state of the debit real-time payment.
          allOf:
            - $ref: '#/components/schemas/debitRealTimePaymentState'
        targetAccount:
          $ref: '#/components/schemas/debitRealTimePaymentAccountReference'
        amount:
          $ref: '#/components/schemas/realTimePaymentAmount'
    debitRealTimePaymentItem:
      x-apiture-version: 4.0.1
      title: Debit Real-Time Payment Item (v4.0.1)
      description: Summary representation of a debit real-time payment resource in real-time payments collections. To fetch the full representation of this real-time payment, use the [`getDebitRealTimePayment`](#op-getDebitRealTimePayment) operation, passing this item's `id` field as the `debitRealTimePaymentId` path parameter.
      type: object
      required:
        - id
        - messageId
        - createdAt
        - availableAt
        - state
        - targetAccount
        - amount
        - sender
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/immutableRealTimePaymentFields'
        - $ref: '#/components/schemas/debitRealTimePaymentFields'
        - type: object
          properties:
            sender:
              $ref: '#/components/schemas/debitRealTimePaymentSenderSummary'
      example:
        id: 0399abed-fd3d
        messageId: M2015111202120020101BCPF00000000001
        createdAt: '2022-05-23T08:01:28.375Z'
        availableAt: '2022-05-23T08:01:28.375Z'
        state: received
        targetAccount:
          id: bf23bc970b78d27691e8
          nickname: Premiere Checking
          label: Premiere Checking *1008
          maskedNumber: '*1008'
          type: checking
        amount:
          value: '100.00'
          currency: USD
        sender:
          name: Exquisite Creations Interior Design & Renovation Services
    debitRealTimePayment:
      x-apiture-version: 4.0.2
      title: Debit Real-Time Payment (v4.0.2)
      description: Representation of a debit real-time payment resource.
      type: object
      required:
        - id
        - messageId
        - createdAt
        - availableAt
        - state
        - targetAccount
        - amount
        - sender
        - confirmationId
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/immutableRealTimePaymentFields'
        - $ref: '#/components/schemas/debitRealTimePaymentFields'
        - type: object
          properties:
            sender:
              $ref: '#/components/schemas/debitRealTimePaymentSender'
            confirmationId:
              $ref: '#/components/schemas/realTimePaymentConfirmationId'
            endToEndId:
              $ref: '#/components/schemas/realTimePaymentEndToEndId'
            remittanceAdvice:
              $ref: '#/components/schemas/remittanceAdvice'
      example:
        id: 0399abed-fd3d
        messageId: M2015111202120020101BCPF00000000001
        createdAt: '2022-05-23T08:01:28.375Z'
        availableAt: '2022-05-23T08:01:28.375Z'
        state: received
        targetAccount:
          id: bf23bc970b78d27691e8
          nickname: Premiere Checking
          label: Premiere Checking *1008
          maskedNumber: '*1008'
          type: checking
        amount:
          value: '100.00'
          currency: USD
        sender:
          name: Exquisite Creations Interior Design & Renovation Services
          address:
            address1: 1805 Tiburon Dr.
            address2: Building 14, Suite 1500
            locality: Wilmington
            regionCode: NC
            countryCode: US
            postalCode: '28403'
          contact:
            name: Janine Doe
            emailAddress: janine.doe@creations.com
            phoneNumber: '+19105550155'
        confirmationId: '12345'
        endToEndId: E2E-Ref001
        remittanceAdvice:
          method: email
          address: info@example.com
          message: Payment for invoice INV-123
    debitRealTimePayments:
      x-apiture-version: 4.1.0
      title: Debit Real-Time Payment Collection (v4.1.0)
      description: A page of zero or more debit real-time payments. The items in the collection are ordered in the `items` array.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractCountedPagedBody'
        - type: object
          required:
            - items
          properties:
            items:
              description: An array containing debit real-time payment items
              type: array
              maxItems: 10000
              items:
                $ref: '#/components/schemas/debitRealTimePaymentItem'
      example:
        nextPage_url: https://static.api.apiture.com/banking/debitRealTimePayments?start=641f62296ecbf1882c84?limit=100
        start: df8sk3hk4hf8sf
        limit: 100
        count: 5000
        pageNumber: 1
        items:
          - id: 0399abed-fd3d
            messageId: M2015111202120020101BCPF00000000001
            createdAt: '2022-05-23T08:01:28.375Z'
            availableAt: '2022-05-23T08:01:28.375Z'
            state: received
            targetAccount:
              id: bf23bc970b78d27691e8
              nickname: Premiere Checking
              label: Premiere Checking *1008
              maskedNumber: '*1008'
              type: checking
            amount:
              value: '100.00'
              currency: USD
            sender:
              name: Exquisite Creations Interior Design & Renovation Services
          - id: d62c0701-0d74-4836-83f9-ebf3709442ea
            messageId: M2015111202120020101BCPF00000000002
            createdAt: '2022-05-26T10:05:44.102Z'
            availableAt: '2022-05-26T10:05:44.102Z'
            state: received
            targetAccount:
              id: bf23bc970b78d27691e8
              nickname: Premiere Checking
              label: Premiere Checking *1008
              maskedNumber: '*1008'
              type: checking
            amount:
              value: '15.00'
              currency: USD
            sender:
              name: Billy Bob Jordan
    immutableCreditRealTimePaymentFields:
      x-apiture-version: 4.0.0
      title: Immutable Credit Real-Time Payment Fields (v4.0.0)
      description: Immutable shared fields for the credit real-time payment resources.
      type: object
      x-apiture-fragment: true
      properties:
        updatedAt:
          description: The date and time when the credit real-time payment was updated, in `YYYY-MM-DDThh:mm:ss.sssZ` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date-time` UTC format.
          allOf:
            - $ref: '#/components/schemas/readOnlyTimestamp'
        processedAt:
          description: |-
            The date and time when the credit real-time payment was processed, in `YYYY-MM-DDThh:mm:ss.sssZ` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date-time` UTC format.

            This is only populated when the credit real-time payment's `state` is `processed`, `completed`, or `failed`.
          allOf:
            - $ref: '#/components/schemas/readOnlyTimestamp'
        customerId:
          $ref: '#/components/schemas/realTimePaymentCustomerId'
        state:
          description: The state of the credit real-time payment.
          allOf:
            - $ref: '#/components/schemas/creditRealTimePaymentState'
        reasonCode:
          description: The reason that a credit real-time payment is in its current state. Normally, this explains why the state is still `pending` and not eligible to be approved or processed.
          allOf:
            - $ref: '#/components/schemas/creditRealTimePaymentReasonCode'
        information:
          description: A text string with additional information about the status of the credit real-time payment.
          type: string
          format: text
          maxLength: 100
        remainingApprovalsCount:
          description: The number of the remaining approvals that are required before the credit real-time payment can be scheduled. This property only applies if the `state` of the credit real-time payment is `pendingApproval`.
          type: integer
          format: int32
          minimum: 0
          maximum: 3
        approvalCount:
          description: The number of approvals given for the credit real-time payment.
          type: integer
          format: int32
          minimum: 0
          maximum: 3
        allows:
          $ref: '#/components/schemas/creditRealTimePaymentAllows'
    newCreditRealTimePayment:
      x-apiture-version: 5.0.0
      title: New Credit Real-Time Payment (v5.0.0)
      description: Representation used to create a new credit real-time payment.
      type: object
      required:
        - sourceAccount
        - amount
        - sender
        - recipient
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            customerId:
              $ref: '#/components/schemas/realTimePaymentCustomerId'
            sourceAccount:
              $ref: '#/components/schemas/creditRealTimePaymentAccountReference'
            amount:
              $ref: '#/components/schemas/realTimePaymentAmount'
            sender:
              $ref: '#/components/schemas/creditRealTimePaymentSender'
            recipient:
              $ref: '#/components/schemas/newRealTimePaymentRecipient'
            endToEndId:
              $ref: '#/components/schemas/realTimePaymentEndToEndId'
            remittanceAdvice:
              $ref: '#/components/schemas/remittanceAdvice'
      example:
        customerId: 4242923b-714e
        sourceAccount:
          id: bf23bc970b78d27691e8
          nickname: Premiere Checking
          label: Premiere Checking *1008
          maskedNumber: '*1008'
          type: checking
        amount:
          value: '100.00'
          currency: USD
        sender:
          governmentIssuedId: '112223333'
          name: Buffalo Mountain Sports
          address:
            address1: 123 Main Street
            address2: Building 14, Suite 1500
            locality: Miami
            regionCode: FL
            countryCode: US
            postalCode: '12345'
        recipient:
          name: Exquisite Creations Interior Design & Renovation Services
          address:
            address1: 123 Hierarchy Lane
            locality: Miami
            regionCode: FL
            countryCode: US
            postalCode: '12003'
          fullAccountNumber: '123456789'
          institution:
            name: Bank of America
            routingNumber: '123123123'
        endToEndId: E2E-Ref001
        remittanceAdvice:
          method: email
          address: info@example.com
          message: Payment for invoice INV-123
    creditRealTimePaymentItem:
      x-apiture-version: 5.0.0
      title: Credit Real-Time Payment Item (v5.0.0)
      description: Summary representation of a credit real-time payment resource in real-time payments collections. To fetch the full representation of this real-time payment, use the [`getCreditRealTimePayment`](#op-getCreditRealTimePayment) operation, passing this item's `id` field as the `creditRealTimePaymentId` path parameter.
      type: object
      required:
        - id
        - messageId
        - createdAt
        - updatedAt
        - state
        - remainingApprovalsCount
        - approvalCount
        - allows
        - sourceAccount
        - amount
        - sender
        - recipient
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/immutableRealTimePaymentFields'
        - $ref: '#/components/schemas/immutableCreditRealTimePaymentFields'
        - type: object
          properties:
            sourceAccount:
              $ref: '#/components/schemas/creditRealTimePaymentAccountReference'
            amount:
              $ref: '#/components/schemas/realTimePaymentAmount'
            sender:
              $ref: '#/components/schemas/creditRealTimePaymentSenderSummary'
            recipient:
              $ref: '#/components/schemas/realTimePaymentRecipientSummary'
      example:
        id: 0399abed-fd3d
        messageId: M2015111202120020101BCPF00000000001
        createdAt: '2022-05-23T08:01:28.375Z'
        updatedAt: '2022-05-23T08:02:12.660Z'
        processedAt: '2022-05-23T08:01:28.375Z'
        customerId: 4242923b-714e
        state: completed
        remainingApprovalsCount: 0
        approvalCount: 2
        allows:
          approve: false
          edit: false
          submit: true
          reject: false
          delete: false
        sourceAccount:
          id: bf23bc970b78d27691e8
          nickname: Premiere Checking
          label: Premiere Checking *1008
          maskedNumber: '*1008'
          type: checking
        amount:
          value: '100.00'
          currency: USD
        sender:
          name: Buffalo Mountain Sports
        recipient:
          name: Exquisite Creations Interior Design & Renovation Services
    creditRealTimePayment:
      x-apiture-version: 7.1.0
      title: Credit Real-Time Payment (v7.1.0)
      description: Representation of a credit real-time payment resource.
      type: object
      required:
        - id
        - messageId
        - createdAt
        - updatedAt
        - state
        - remainingApprovalsCount
        - approvalCount
        - allows
        - sourceAccount
        - amount
        - sender
        - recipient
        - confirmationId
        - trackingNumber
        - approvers
        - approvals
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/immutableRealTimePaymentFields'
        - $ref: '#/components/schemas/immutableCreditRealTimePaymentFields'
        - type: object
          properties:
            stateReason:
              description: The `reason` given when someone rejected the credit real-time payment during review. This string is only present if the `state` is `rejected`, a `reason` was given and the `state` has not changed since the reason was given.
              type: string
              format: text
              maxLength: 80
            rejectionReason:
              description: The external processor (such as The Clearing House) provided reason for rejecting the real-time payment. This is omitted when there is not a provided rejection reason.
              type: string
              format: text
              maxLength: 105
            sourceAccount:
              $ref: '#/components/schemas/creditRealTimePaymentAccountReference'
            amount:
              $ref: '#/components/schemas/realTimePaymentAmount'
            sender:
              $ref: '#/components/schemas/creditRealTimePaymentSender'
            recipient:
              $ref: '#/components/schemas/realTimePaymentRecipient'
            confirmationId:
              $ref: '#/components/schemas/realTimePaymentConfirmationId'
            endToEndId:
              $ref: '#/components/schemas/realTimePaymentEndToEndId'
            trackingNumber:
              $ref: '#/components/schemas/realTimePaymentTrackingNumber'
            remittanceAdvice:
              $ref: '#/components/schemas/remittanceAdvice'
            approvers:
              description: An array of customers that are entitled to approve this credit real-time payment.
              type: array
              readOnly: true
              minItems: 0
              maxItems: 8
              items:
                $ref: '#/components/schemas/creditRealTimePaymentApprover'
            approvals:
              description: An array of approvals. A `null` item indicates a required approval is still pending. The length of this array indicates how many approvals are needed before this credit real-time payment may be actively scheduled for processing.
              readOnly: true
              type: array
              minItems: 0
              maxItems: 3
              items:
                $ref: '#/components/schemas/creditRealTimePaymentApproval'
            problems:
              description: A list of problems that prevent approving the credit real-time payment.
              type: array
              maxItems: 1000
              items:
                $ref: '#/components/schemas/creditRealTimePaymentProblem'
      example:
        id: 0399abed-fd3d
        messageId: M2015111202120020101BCPF00000000001
        createdAt: '2022-05-23T08:01:28.375Z'
        updatedAt: '2022-05-23T08:02:12.660Z'
        processedAt: '2022-05-23T08:01:28.375Z'
        customerId: 4242923b-714e
        state: completed
        remainingApprovalsCount: 1
        approvalCount: 1
        allows:
          approve: false
          edit: false
          submit: true
          reject: false
          delete: false
        sourceAccount:
          id: bf23bc970b78d27691e8
          nickname: Premiere Checking
          label: Premiere Checking *1008
          maskedNumber: '*1008'
          type: checking
        amount:
          value: '100.00'
          currency: USD
        sender:
          governmentIssuedId: '112223333'
          name: Buffalo Mountain Sports
          address:
            address1: 123 Main Street
            address2: Building 14, Suite 1500
            locality: Miami
            regionCode: FL
            countryCode: US
            postalCode: '12345'
          contact:
            name: John Smith
            emailAddress: johnsmith.doe@business.com
            phoneNumber: '+19105550155'
        recipient:
          name: Exquisite Creations Interior Design & Renovation Services
          address:
            address1: 123 Hierarchy Lane
            locality: Miami
            regionCode: FL
            countryCode: US
            postalCode: '12003'
          maskedAccountNumber: '*6789'
          fullAccountNumber: '123456789'
          institution:
            name: Bank of America
            routingNumber: '123123123'
        confirmationId: '12345'
        endToEndId: E2E-Ref001
        trackingNumber: '12345678'
        remittanceAdvice:
          method: email
          address: info@example.com
          message: Payment for invoice INV-123
        approvers:
          - name: Tom Allison
            id: 327d8bea-2553
            identification: to...58@wellsroofing.com
          - name: Silvia Wilkenson
            id: 06cf8996-d093
            identification: si...42@wellsroofing.com
        approvals:
          - name: Tom Allison
            id: 327d8bea-2553
            identification: si...42@wellsroofing.com
            approvedAt: '2022-04-25T09:02:57.375Z'
          - null
        problems: []
    creditRealTimePaymentPatch:
      x-apiture-version: 5.0.0
      title: Credit Real-Time Payment Patch (v5.0.0)
      description: Representation of a patch to a credit real-time payment resource.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            customerId:
              $ref: '#/components/schemas/realTimePaymentCustomerId'
            sourceAccount:
              $ref: '#/components/schemas/creditRealTimePaymentAccountReferencePatch'
            amount:
              $ref: '#/components/schemas/realTimePaymentAmount'
            sender:
              $ref: '#/components/schemas/creditRealTimePaymentSenderPatch'
            recipient:
              $ref: '#/components/schemas/realTimePaymentRecipientPatch'
            endToEndId:
              $ref: '#/components/schemas/realTimePaymentEndToEndId'
            remittanceAdvice:
              $ref: '#/components/schemas/remittanceAdvice'
      example:
        customerId: 4242923b-714e
        sourceAccount:
          id: bf23bc970b78d27691e8
          nickname: Premiere Checking
          label: Premiere Checking *1008
          maskedNumber: '*1008'
          type: checking
        amount:
          value: '100.00'
          currency: USD
        sender:
          governmentIssuedId: '112223333'
          name: Buffalo Mountain Sports
          address:
            address1: 123 Main Street
            address2: Building 14, Suite 1500
            locality: Miami
            regionCode: FL
            countryCode: US
            postalCode: '12345'
        recipient:
          name: Exquisite Creations Interior Design & Renovation Services
          address:
            address1: 123 Hierarchy Lane
            locality: Miami
            regionCode: FL
            countryCode: US
            postalCode: '12003'
          fullAccountNumber: '123456789'
          institution:
            name: Bank of America
            routingNumber: '123123123'
        endToEndId: E2E-Ref001
        remittanceAdvice:
          method: email
          address: info@example.com
          message: Payment for invoice INV-123
    creditRealTimePayments:
      x-apiture-version: 5.1.0
      title: Credit Real-Time Payment Collection (v5.1.0)
      description: A page of zero or more credit real-time payments. The items in the collection are ordered in the `items` array.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractCountedPagedBody'
        - type: object
          required:
            - items
          properties:
            items:
              description: An array containing credit real-time payment items.
              type: array
              maxItems: 10000
              items:
                $ref: '#/components/schemas/creditRealTimePaymentItem'
      example:
        nextPage_url: https://static.api.apiture.com/banking/creditRealTimePayments?start=641f62296ecbf1882c84?limit=100
        start: df8sk3hk4hf8sf
        limit: 100
        count: 5000
        pageNumber: 1
        items:
          - id: 0399abed-fd3d
            messageId: M2015111202120020101BCPF00000000001
            createdAt: '2022-05-23T08:01:28.375Z'
            updatedAt: '2022-05-23T08:02:12.660Z'
            processedAt: '2022-05-23T08:01:28.375Z'
            customerId: 4242923b-714e
            state: completed
            remainingApprovalsCount: 0
            approvalCount: 2
            allows:
              approve: false
              edit: false
              submit: true
              reject: false
              delete: false
            sourceAccount:
              id: bf23bc970b78d27691e8
              nickname: Premiere Checking
              label: Premiere Checking *1008
              maskedNumber: '*1008'
              type: checking
            amount:
              value: '100.00'
              currency: USD
            sender:
              name: Buffalo Mountain Sports
            recipient:
              name: Exquisite Creations Interior Design & Renovation Services
          - id: d62c0701-0d74-4836-83f9-ebf3709442ea
            messageId: M2015111202120020101BCPF00000000002
            createdAt: '2022-05-26T10:05:44.102Z'
            updatedAt: '2022-05-26T10:06:32.091Z'
            processedAt: '2022-05-26T10:05:44.102Z'
            customerId: df90dfsds-v9dsf
            state: pending
            reasonCode: insufficientFunds
            information: There are insufficient funds in the account to make this payment.
            remainingApprovalsCount: 2
            approvalCount: 0
            allows:
              approve: false
              edit: false
              submit: true
              reject: false
              delete: false
            sourceAccount:
              id: bf23bc970b78d27691e8
              nickname: Premiere Checking
              label: Premiere Checking *1008
              maskedNumber: '*1008'
              type: checking
            amount:
              value: '15.00'
              currency: USD
            sender:
              name: Buffalo Mountain Sports
            recipient:
              name: Exquisite Creations Interior Design & Renovation Services
    realTimePaymentHistoryRecords:
      x-apiture-version: 1.1.0
      title: Real-Time Payment History Record Collection (v1.1.0)
      description: Collection of real-time payment history records.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          required:
            - items
          properties:
            items:
              description: An array containing real-time payment history record items.
              type: array
              maxItems: 10000
              items:
                $ref: '#/components/schemas/realTimePaymentHistoryRecord'
      example:
        items:
          - type: approved
            customerId: b9815cc6-85a7
            customerName: Alex Frank
            occurredAt: '2022-07-29T04:18:49.375Z'
          - type: requestedApproval
            customerId: 4242923b-714e
            customerName: Karl Knox
            occurredAt: '2022-07-28T12:54:30.000Z'
          - type: updated
            customerId: 4242923b-714e
            customerName: Karl Knox
            occurredAt: '2022-07-28T12:49:22.000Z'
            updateType: amountUpdated
          - type: created
            customerId: 4242923b-714e
            customerName: Karl Knox
            occurredAt: '2022-07-28T12:44:46.375Z'
    bulkEligibleCreditRealTimePaymentApprovers:
      title: Bulk Eligible Credit Real-Time Payment Approvers (v1.0.0)
      description: A list of customers eligible to approve one or more credit real-time payments. In the example, `items[0]` and `items[1]` both have the same `groupId` value, indicating that those two payments have the same list of approvers, while the approver list for the third payment (`items[2]`) differs.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/bulkCreditRealTimePaymentApprovers'
      example:
        items:
          - creditRealTimePaymentId: d366bc49-49a7
            groupId: group-00
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Silvia Wilkenson
                id: 06cf8996-d093
                identification: si...42@wellsroofing.com
          - creditRealTimePaymentId: 8ea05bfc-0e9c
            groupId: group-00
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Silvia Wilkenson
                id: 06cf8996-d093
                identification: si...42@wellsroofing.com
          - creditRealTimePaymentId: 071db898-b220
            groupId: group-01
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Carl Thompson
                id: d7da1cc5-8056
                identification: ca...39@wellsroofing.com
      x-apiture-version: 1.0.0
    bulkCreditRealTimePaymentApproversRequest:
      title: Bulk Credit Real-Time Payment Approvers Request (v1.0.0)
      description: A request to add approvers to a list of credit real-time payments.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/eligibleCreditRealTimePaymentApprovers'
        - type: object
          properties:
            approverLists:
              description: A list of credit real-time payments and corresponding approvers.
              type: array
              minItems: 1
              maxItems: 1000
              items:
                $ref: '#/components/schemas/creditRealTimePaymentApprovers'
      example:
        items:
          - creditRealTimePaymentId: d366bc49-49a7
            groupId: group-00
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Silvia Wilkenson
                id: 06cf8996-d093
                identification: si...42@wellsroofing.com
          - creditRealTimePaymentId: 8ea05bfc-0e9c
            groupId: group-00
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Silvia Wilkenson
                id: 06cf8996-d093
                identification: si...42@wellsroofing.com
          - creditRealTimePaymentId: 071db898-b220
            groupId: group-01
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Carl Thompson
                id: d7da1cc5-8056
                identification: ca...39@wellsroofing.com
      x-apiture-version: 1.0.0
    creditRealTimePaymentBulkApprovers:
      title: Credit Real-Time Payment Bulk Approvers (v1.0.0)
      description: Response from the request to add approvers to a set of credit real-time payments.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/bulkRealTimePaymentOperationResponseFields'
      example:
        - id: 0399abed-fd3d
          succeeded: false
          problems:
            - id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0
              title: Credit Real-Time Payment Not Found
              status: 422
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: No real-time payment exists for the requested real-time payment ID
              instance: https://static.api.apiture.com/banking/creditRealTimePayments/0399abed-fd3d
        - id: d62c0701-0d74-4836-83f9-ebf3709442ea
          succeeded: true
      x-apiture-version: 1.0.0
    bulkCreditRealTimePaymentApprovalRequest:
      title: Bulk Credit Real-Time Payment Approval Request (v1.0.0)
      description: A request to approve a set of credit real-time payments.
      type: object
      required:
        - realTimePaymentIds
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/bulkRealTimePaymentOperationRequestFields'
      example:
        realTimePaymentIds:
          - 0399abed-fd3d
          - d62c0701-0d74-4836-83f9-ebf3709442ea
      x-apiture-version: 1.0.0
    bulkCreditRealTimePaymentApprovalResponse:
      title: Bulk Credit Real-Time Payment Approval Response (v1.0.0)
      description: Response from the request to approve a set of credit real-time payments.
      type: object
      required:
        - items
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/bulkRealTimePaymentOperationResponseFields'
      example:
        - id: 0399abed-fd3d
          succeeded: false
          problems:
            - id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0
              title: Credit Real-Time Payment Not Found
              status: 422
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: No real-time payment exists for the requested real-time payment ID
              instance: https://static.api.apiture.com/banking/creditRealTimePayments/0399abed-fd3d
        - id: d62c0701-0d74-4836-83f9-ebf3709442ea
          succeeded: true
      x-apiture-version: 1.0.0
    bulkCreditRealTimePaymentRejectionRequest:
      x-apiture-version: 3.0.0
      title: Bulk Credit Real-Time Payment Rejection Request (v3.0.0)
      description: A request to reject a set of credit real-time payments.
      type: object
      required:
        - realTimePaymentIds
        - reason
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/bulkRealTimePaymentOperationRequestFields'
        - type: object
          properties:
            reason:
              description: The reason for rejecting the credit real-time payment during review.
              type: string
              format: text
              minLength: 1
              maxLength: 80
      example:
        realTimePaymentIds:
          - 0399abed-fd3d
          - d62c0701-0d74-4836-83f9-ebf3709442ea
        reason: Rejection reason
    bulkCreditRealTimePaymentRejectionResponse:
      title: Bulk Credit Real-Time Payment Rejection Response (v1.0.0)
      description: Response from the request to reject a set of credit real-time payments.
      type: object
      required:
        - items
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/bulkRealTimePaymentOperationResponseFields'
      example:
        - id: 0399abed-fd3d
          succeeded: false
          problems:
            - id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0
              title: Credit Real-Time Payment Not Found
              status: 422
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: No real-time payment exists for the requested real-time payment ID
              instance: https://static.api.apiture.com/banking/creditRealTimePayments/0399abed-fd3d
        - id: d62c0701-0d74-4836-83f9-ebf3709442ea
          succeeded: true
      x-apiture-version: 1.0.0
    bulkCreditRealTimePaymentDeletionRequest:
      x-apiture-version: 2.0.0
      title: Bulk Credit Real-Time Payment Deletion Request (v2.0.0)
      description: A request to delete a set of credit real-time payments.
      type: object
      required:
        - realTimePaymentIds
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/bulkRealTimePaymentOperationRequestFields'
      example:
        realTimePaymentIds:
          - 0399abed-fd3d
          - d62c0701-0d74-4836-83f9-ebf3709442ea
    bulkCreditRealTimePaymentDeletionResponse:
      x-apiture-version: 2.0.0
      title: Bulk Credit Real-Time Payment Deletion Response (v2.0.0)
      description: Response from the request to delete a set of credit real-time payments.
      type: object
      required:
        - items
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/bulkRealTimePaymentOperationResponseFields'
      example:
        - id: 0399abed-fd3d
          succeeded: false
          problems:
            - id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0
              title: Credit Real-Time Payment Not Found
              status: 422
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: No real-time payment exists for the requested real-time payment ID
              instance: https://static.api.apiture.com/banking/creditRealTimePayments/0399abed-fd3d
        - id: d62c0701-0d74-4836-83f9-ebf3709442ea
          succeeded: true
    realTimePaymentRecipients:
      x-apiture-version: 2.0.0
      title: Real-Time Payment Recipients List (v2.0.0)
      description: A list of the most recent unique credit real-time payment recipients, limited to two hundred recipients. The items in the list are ordered in the `items` array.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          required:
            - items
          properties:
            customerId:
              $ref: '#/components/schemas/realTimePaymentCustomerId'
            items:
              description: An array containing the most recent unique recipients
              type: array
              maxItems: 200
              items:
                $ref: '#/components/schemas/realTimePaymentRecipient'
      example:
        customerId: 4242923b-714e
        items:
          - name: Billy Bob Jordan
            address:
              address1: 123 Maple Lane
              locality: Jacksonville
              regionCode: FL
              countryCode: US
              postalCode: '33333'
            maskedAccountNumber: '*1111'
            fullAccountNumber: '111111111'
            institution:
              name: Wells Fargo
              routingNumber: '222222222'
          - name: Exquisite Creations Interior Design & Renovation Services
            address:
              address1: 123 Hierarchy Lane
              locality: Miami
              regionCode: FL
              countryCode: US
              postalCode: '12003'
            maskedAccountNumber: '*6789'
            fullAccountNumber: '123456789'
            institution:
              name: Bank of America
              routingNumber: '123123123'
    recentRealTimePaymentRecipients:
      x-apiture-version: 3.0.0
      title: Recent Real-Time Payment Recipients List (v3.0.0)
      description: A list of the most recent unique credit real-time payment recipients, limited to five recipients. The items in the list are ordered in the `items` array.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          required:
            - items
          properties:
            customerId:
              $ref: '#/components/schemas/realTimePaymentCustomerId'
            items:
              description: An array containing the most recent unique recipients
              type: array
              maxItems: 5
              items:
                $ref: '#/components/schemas/realTimePaymentRecipient'
      example:
        customerId: 4242923b-714e
        items:
          - name: Exquisite Creations Interior Design & Renovation Services
            address:
              address1: 123 Hierarchy Lane
              locality: Miami
              regionCode: FL
              countryCode: US
              postalCode: '12003'
            maskedAccountNumber: '*6789'
            fullAccountNumber: '123456789'
            institution:
              name: Bank of America
              routingNumber: '123123123'
          - name: Billy Bob Jordan
            address:
              address1: 123 Maple Lane
              locality: Jacksonville
              regionCode: FL
              countryCode: US
              postalCode: '33333'
            maskedAccountNumber: '*1111'
            fullAccountNumber: '111111111'
            institution:
              name: Wells Fargo
              routingNumber: '222222222'
    realTimePaymentHistoryRecord:
      title: Real-Time Payment History Record (v1.0.0)
      description: Representation of a real-time payment history record resource.
      required:
        - type
        - customerId
        - customerName
        - occurredAt
      properties:
        type:
          description: The type of real-time payment activity; this describes what the customer did with the real-time payment.
          allOf:
            - $ref: '#/components/schemas/realTimePaymentHistoryRecordType'
        customerId:
          description: The ID of the customer who performed the action.
          allOf:
            - $ref: '#/components/schemas/readOnlyResourceId'
        customerName:
          description: The name of the customer who performed the action. This is the customer's name at the time the action occurred.
          type: string
          maxLength: 50
          format: text
        occurredAt:
          description: The date and time when the customer performed the action.
          allOf:
            - $ref: '#/components/schemas/readOnlyTimestamp'
        approvers:
          description: A list of customers who were added as approvers for this real-time payment. This field is set only if `type` is `approvalRequested`.
          type: array
          maxItems: 8
          items:
            $ref: '#/components/schemas/realTimePaymentHistoryRecordApprover'
        reason:
          description: The reason given for rejecting a real-time payment. This field is set only if `type` is `rejected`.
          type: string
          maxLength: 80
          format: text
        updateTypes:
          description: For the `type` of `updated`, this indicates how the real-time payment was updated. Additional details for this changeset beyond the first 50 changes are excluded.
          type: array
          maxItems: 50
          items:
            $ref: '#/components/schemas/realTimePaymentHistoryUpdateTypeItem'
      example:
        type: created
        customerId: 4242923b-714e
        customerName: Karl Knox
        occurredAt: '2022-07-28T12:44:46.375Z'
      x-apiture-version: 1.0.0
    realTimePaymentHistoryRecordType:
      title: Real-Time Payment History Record Type (v1.0.0)
      description: |+
        The type of a real-time payment history record.

        <strong><code>realTimePaymentHistoryRecordType</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>created</code></strong></td><td>Created: <p>The customer created this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>approved</code></strong></td><td>Approved: <p>The customer approved this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>requestedApproval</code></strong></td><td>Requested Approval: <p>The customer requested approval of this real-time payment by adding approvers</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>rejected</code></strong></td><td>Rejected: <p>The customer rejected this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>updated</code></strong></td><td>Updated: <p>The customer updated this real-time payment</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: realTimePaymentHistoryRecordType
      enum:
        - created
        - approved
        - requestedApproval
        - rejected
        - updated
      x-apiture-version: 1.0.0
    realTimePaymentHistoryUpdateTypeItem:
      title: Real-Time Payment History Update Type Item (v1.0.0)
      description: The summary of what was updated on a real-time payment.
      type: object
      required:
        - type
      properties:
        type:
          description: The canonical type representing an update.
          $ref: '#/components/schemas/realTimePaymentHistoryUpdateType'
      x-apiture-version: 1.0.0
    realTimePaymentHistoryUpdateType:
      title: Real-Time Payment History Update Type (v1.0.0)
      description: |+
        Describes how a real-time payment was updated.

        <strong><code>realTimePaymentHistoryUpdateType</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>sourceAccountUpdated</code></strong></td><td>Source Account Updated: <p>The source account was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>amountUpdated</code></strong></td><td>Amount Updated: <p>The amount was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>senderIdUpdated</code></strong></td><td>Sender ID Updated: <p>The sender ID was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>senderNameUpdated</code></strong></td><td>Sender Name Updated: <p>The sender name was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>senderAddressUpdated</code></strong></td><td>Sender Address Updated: <p>The sender address was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>senderContactNameUpdated</code></strong></td><td>Sender Contact Name Updated: <p>The sender contact name was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>senderContactEmailAddressUpdated</code></strong></td><td>Sender Contact Email Address Updated: <p>The sender contact email address was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>senderContactPhoneNumberUpdated</code></strong></td><td>Sender Contact Phone Number Updated: <p>The sender contact phone number was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>recipientNameUpdated</code></strong></td><td>Recipient Name Updated: <p>The recipient name was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>recipientAddressUpdated</code></strong></td><td>Recipient Address Updated: <p>The recipient address was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>recipientAccountNumberUpdated</code></strong></td><td>Recipient Account Number Updated: <p>The recipient account number was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>recipientInstitutionNameUpdated</code></strong></td><td>Recipient Institution Name Updated: <p>The recipient institution name was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>recipientInstitutionRoutingNumberUpdated</code></strong></td><td>Recipient Institution Routing Number Updated: <p>The recipient institution routing number was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>endToEndIdUpdated</code></strong></td><td>End to End ID Updated: <p>The end to end ID was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>remittanceAdviceMethodUpdated</code></strong></td><td>Remittance Advice Method Updated: <p>The remittance advice method was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>remittanceAdviceAddressUpdated</code></strong></td><td>Remittance Advice Address Updated: <p>The remittance advice address was updated for this real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>remittanceAdviceMessageUpdated</code></strong></td><td>Remittance Advice Message Updated: <p>The remittance advice message was updated for this real-time payment</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: realTimePaymentHistoryUpdateType
      enum:
        - sourceAccountUpdated
        - amountUpdated
        - senderIdUpdated
        - senderNameUpdated
        - senderAddressUpdated
        - senderContactNameUpdated
        - senderContactEmailAddressUpdated
        - senderContactPhoneNumberUpdated
        - recipientNameUpdated
        - recipientAddressUpdated
        - recipientAccountNumberUpdated
        - recipientInstitutionNameUpdated
        - recipientInstitutionRoutingNumberUpdated
        - endToEndIdUpdated
        - remittanceAdviceMethodUpdated
        - remittanceAdviceAddressUpdated
        - remittanceAdviceMessageUpdated
      x-apiture-version: 1.0.0
    realTimePaymentHistoryRecordApprover:
      title: Real-Time Payment History Record Approver (v1.0.0)
      description: Representation of a real-time payment history record approver.
      type: object
      properties:
        id:
          description: The ID of the customer who was asked to approve this payment.
          $ref: '#/components/schemas/readOnlyResourceId'
        name:
          description: The name of the customer who was asked to approve this payment.
          type: string
          minLength: 2
          maxLength: 50
          format: text
      x-apiture-version: 1.0.0
    eligibleCreditRealTimePaymentApprovers:
      title: Eligible Credit Real-Time Payment Approvers (v1.0.0)
      description: A list of customers eligible to approve one or more credit real-time payments. In the example, `items[0]` and `items[1]` both have the same `groupId` value, indicating that those two payments have the same list of approvers, while the approver list for the third payment (`items[2]`) differs.
      allOf:
        - $ref: '#/components/schemas/creditRealTimePaymentApprovers'
      example:
        items:
          - creditRealTimePaymentId: d366bc49-49a7
            groupId: group-00
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Silvia Wilkenson
                id: 06cf8996-d093
                identification: si...42@wellsroofing.com
          - creditRealTimePaymentId: 8ea05bfc-0e9c
            groupId: group-00
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Silvia Wilkenson
                id: 06cf8996-d093
                identification: si...42@wellsroofing.com
          - creditRealTimePaymentId: 071db898-b220
            groupId: group-01
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Carl Thompson
                id: d7da1cc5-8056
                identification: ca...39@wellsroofing.com
      x-apiture-version: 1.0.0
    creditRealTimePaymentApprovers:
      title: Credit Real-Time Payment Approvers (v1.0.0)
      description: A list of credit real-time payments and the customers to assign to approve that payment.
      type: object
      required:
        - items
      properties:
        items:
          description: The list of credit real-time payments and list of customers eligible to approve the payment.
          type: array
          minItems: 1
          maxItems: 1000
          items:
            $ref: '#/components/schemas/creditRealTimePaymentApproverList'
      example:
        items:
          - creditRealTimePaymentId: 8ea05bfc-0e9c
            groupId: group-00
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Silvia Wilkenson
                id: 06cf8996-d093
                identification: si...42@wellsroofing.com
          - creditRealTimePaymentId: 071db898-b220
            groupId: group-01
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Carl Thompson
                id: d7da1cc5-8056
                identification: ca...39@wellsroofing.com
      x-apiture-version: 1.0.0
    bulkCreditRealTimePaymentApprovers:
      title: Bulk Credit Real-Time Payment Approvers (v1.0.0)
      description: A list of credit real-time payments and the customers who are eligible to approve each of those credit real-time payments.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          required:
            - items
          properties:
            items:
              description: The list of credit real-time payments and list of customers eligible to approve the payment.
              type: array
              minItems: 1
              maxItems: 100
              items:
                $ref: '#/components/schemas/bulkCreditRealTimePaymentApproverList'
      example:
        items:
          - creditRealTimePaymentId: 8ea05bfc-0e9c
            groupId: group-00
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Silvia Wilkenson
                id: 06cf8996-d093
                identification: si...42@wellsroofing.com
          - creditRealTimePaymentId: 071db898-b220
            groupId: group-01
            approvers:
              - name: Tom Allison
                id: 327d8bea-2553
                identification: to...58@wellsroofing.com
              - name: Carl Thompson
                id: d7da1cc5-8056
                identification: ca...39@wellsroofing.com
      x-apiture-version: 1.0.0
    bulkCreditRealTimePaymentApproverList:
      title: Bulk Credit Real-Time Payment and Approvers (v1.0.0)
      description: A credit real-time payment and a list of customers who are eligible to approve the payment. This may include problems encountered while building a list of eligible customers.
      type: object
      allOf:
        - $ref: '#/components/schemas/creditRealTimePaymentApproverList'
        - type: object
          properties:
            problems:
              description: If there was a problem building a list of eligible approvers for the credit real-time payment, this describes why. For example, this may happen if the payment is in the incorrect state for approval (i.e. not `pendingApproval`), or if there are no eligible approvers configured.
              type: array
              minItems: 0
              maxItems: 100
              items:
                $ref: '#/components/schemas/creditRealTimePaymentProblem'
      x-apiture-version: 1.0.0
    creditRealTimePaymentApproverList:
      title: Credit Real-Time Payment And Approvers (v1.0.0)
      description: A credit real-time payment and a list of customers who are eligible to approve the payment.
      type: object
      required:
        - creditRealTimePaymentId
        - approvers
      properties:
        creditRealTimePaymentId:
          description: The resource ID of the credit real-time payment.
          allOf:
            - $ref: '#/components/schemas/resourceId'
        groupId:
          description: An opaque string which identifies similar lists of approvers. All items with the same `groupId` have the same set of approvers.
          type: string
          minLength: 1
          maxLength: 16
          pattern: ^[-_:.~$a-zA-Z0-9]+$
        approvers:
          description: The list of eligible approvers. This can be empty if no eligible approvers were found, and the `problems` array will describe why.
          type: array
          minItems: 0
          maxItems: 1000
          items:
            $ref: '#/components/schemas/creditRealTimePaymentApprover'
      example:
        creditRealTimePaymentId: 071db898-b220
        groupId: group-01
        approvers:
          - name: Tom Allison
            id: 327d8bea-2553
            identification: to...58@wellsroofing.com
          - name: Carl Thompson
            id: d7da1cc5-8056
            identification: ca...39@wellsroofing.com
      x-apiture-version: 1.0.0
    creditRealTimePaymentApprover:
      title: Credit Real-Time Payment Approver (v1.0.0)
      description: A reference to a customer that is entitled to approve the containing credit real-time payment.
      type: object
      allOf:
        - $ref: '#/components/schemas/customerReference'
        - type: object
          properties:
            identification:
              description: Descriptive identifying text about the approver, such as a (masked) email address.
              type: string
              format: text
              maxLength: 64
      examples:
        - name: Tom Allison
          id: 327d8bea-2553
          identification: to...58@wellsroofing.com
      x-apiture-version: 1.0.0
    creditRealTimePaymentApproval:
      title: Credit Real-Time Payment Approval (v1.0.0)
      description: The customer who approved a credit real-time payment, and when it was approved.
      type:
        - object
        - 'null'
      required:
        - id
        - name
        - approvedAt
      properties:
        id:
          description: The unique `id` of the approver
          $ref: '#/components/schemas/resourceId'
        name:
          description: The approvers's full name.
          type: string
          format: text
          minLength: 2
          maxLength: 50
        identification:
          description: Descriptive identifying text about the approver, such as a (masked) email address.
          type: string
          format: text
          maxLength: 64
        approvedAt:
          description: The date-time when the approver last approved this credit real-time payment.
          $ref: '#/components/schemas/readOnlyTimestamp'
      examples:
        - name: Tom Allison
          id: 327d8bea-2553
          identification: to...58@wellsroofing.com
          approvedAt: '2022-05-23T08:01:28.375Z'
      x-apiture-version: 1.0.0
    creditRealTimePaymentProblem:
      title: Credit Real-Time Payment Problem (v1.0.0)
      description: Describes a problem with a credit real-time payment that prevents applying an operation change to the payment. Clients should get the most recent revision of the credit real-time payment to check for problems.
      type: object
      required:
        - type
        - title
        - detail
      properties:
        type:
          type: string
          format: uri-reference
          maxLength: 2048
          description: A [URI reference (RFC3986)](https://tools.ietf.org/html/rfc3986) that identifies the problem type. This is the URL of human-readable HTML documentation for the problem type.
          example: https://static.api.apiture.com/errors/pastCutoffTime/v1.0.0
        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: Past cutoff time
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          maxLength: 256
          format: text
          example: The current time is past the financial institution's cutoff time.
        attributes:
          type: object
          description: Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.
      example:
        type: https://static.api.apiture.com/errors/pastCutoffTime/v1.0.0
        title: Past cutoff time
        detail: The current time is past the financial institution's cutoff time.
        attributes:
          referencedAt: 2022-07-13T020:52:19.375Z
          cutoffAt: '2022-07-13T10:00:00.000Z'
      x-apiture-version: 1.0.0
    bulkRealTimePaymentOperationRequestFields:
      title: Bulk Real-Time Payment Operation Request Fields (v1.0.0)
      description: Bulk real-time payment operation request fields.
      type: object
      x-apiture-fragment: true
      properties:
        realTimePaymentIds:
          description: A list of real-time payment IDs to apply an operation to.
          type: array
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/resourceId'
      x-apiture-version: 1.0.0
    bulkRealTimePaymentOperationResponseFields:
      title: Bulk Real-Time Payment Operation Response Fields (v1.0.0)
      description: Bulk real-time payment operation response fields.
      type: object
      x-apiture-fragment: true
      properties:
        items:
          description: The result of attempting to perform an action on a set of real-time payments in the request. Items in the array correspond (in order) to each real-time payment in the request.
          type: array
          minItems: 1
          maxItems: 100
          items:
            description: The result of attempting to perform an action on one real-time payment from the list of real-time payments in the request.
            $ref: '#/components/schemas/bulkRealTimePaymentOperationResponseItem'
      x-apiture-version: 1.0.0
    bulkRealTimePaymentOperationResponseItem:
      title: Bulk Real-Time Payment Operation Response Item (v1.0.0)
      description: An item in a [bulk real-time payment operation response](#schema-bulkRealTimePaymentOperationResponse).
      type: object
      required:
        - id
        - succeeded
      properties:
        id:
          description: The real-time payment ID.
          allOf:
            - $ref: '#/components/schemas/readOnlyResourceId'
        succeeded:
          description: '`true` if the operation was successful for the real-time payment.'
          type: boolean
        problems:
          description: If the operation for this real-time payment failed (`succeeded` is `false`), this describes why. This may include forbidden, conflict, or other 4xx error or problem types that can occur with individual real-time payment operation calls.
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/apiProblem'
      example:
        id: 0399abed-fd3d
        succeeded: false
        problems:
          - id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
            type: https://static.api.apiture.com/errors/accountNotFound/v1.0.0
            title: Credit Real-Time Payment Not Found
            status: 422
            occurredAt: '2022-04-25T12:42:21.375Z'
            detail: No real-time payment exists for the requested real-time payment ID
            instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-apiture-version: 1.0.0
    realTimePaymentSenderSummaryFields:
      title: Real-Time Payment Sender Summary Fields (v1.0.0)
      description: Summary fields related to the real-time payment sender.
      type: object
      x-apiture-fragment: true
      properties:
        name:
          description: The name of the sender.
          type: string
          format: text
          maxLength: 140
      x-apiture-version: 1.0.0
    debitRealTimePaymentSenderSummary:
      x-apiture-version: 2.0.0
      title: Debit Real-Time Payment Sender Summary (v2.0.0)
      description: A summary version of the sender of the debit real-time payment.
      type: object
      required:
        - name
      allOf:
        - $ref: '#/components/schemas/realTimePaymentSenderSummaryFields'
      example:
        name: Buffalo Mountain Sports
    debitRealTimePaymentSender:
      x-apiture-version: 3.0.0
      title: Debit Real-Time Payment Sender (v3.0.0)
      description: The sender of the debit real-time payment.
      type: object
      required:
        - name
      allOf:
        - $ref: '#/components/schemas/realTimePaymentSenderSummaryFields'
        - type: object
          properties:
            address:
              description: The address of the sender.
              allOf:
                - $ref: '#/components/schemas/isoCompliantPartialAddress'
            contact:
              description: Sender contact information that can be used for communication about the payment.
              allOf:
                - $ref: '#/components/schemas/realTimePaymentContact'
      example:
        name: Buffalo Mountain Sports
        address:
          address1: 123 Main Street
          address2: Building 14, Suite 1500
          locality: Miami
          regionCode: FL
          countryCode: US
          postalCode: '12345'
        contact:
          name: John Smith
          emailAddress: johnsmith.doe@business.com
          phoneNumber: '+19105550155'
    creditRealTimePaymentSenderSummary:
      x-apiture-version: 2.0.0
      title: Credit Real-Time Payment Sender Summary (v2.0.0)
      description: A summary version of the sender of the credit real-time payment.
      type: object
      required:
        - name
      allOf:
        - $ref: '#/components/schemas/realTimePaymentSenderSummaryFields'
      example:
        name: Buffalo Mountain Sports
    creditRealTimePaymentSender:
      x-apiture-version: 4.0.0
      title: Credit Real-Time Payment Sender (v4.0.0)
      description: The sender of the credit real-time payment.
      type: object
      required:
        - name
        - address
      allOf:
        - $ref: '#/components/schemas/realTimePaymentSenderSummaryFields'
        - type: object
          properties:
            governmentIssuedId:
              $ref: '#/components/schemas/creditRealTimePaymentGovernmentIssuedId'
            address:
              description: |-
                The address of the sender.

                If any fields are provided, `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, and `postalCode` are required.
              allOf:
                - $ref: '#/components/schemas/isoCompliantPartialAddress'
            contact:
              description: Sender contact information that can be used for communication about the payment.
              allOf:
                - $ref: '#/components/schemas/realTimePaymentContact'
      example:
        governmentIssuedId: '112223333'
        name: Buffalo Mountain Sports
        address:
          address1: 123 Main Street
          address2: Building 14, Suite 1500
          locality: Miami
          regionCode: FL
          countryCode: US
          postalCode: '12345'
        contact:
          name: John Smith
          emailAddress: johnsmith.doe@business.com
          phoneNumber: '+19105550155'
    creditRealTimePaymentSenderPatch:
      x-apiture-version: 3.0.0
      title: Credit Real-Time Payment Sender Patch (v3.0.0)
      description: Representation of a patch to the sender of the credit real-time payment.
      type: object
      allOf:
        - $ref: '#/components/schemas/realTimePaymentSenderSummaryFields'
        - type: object
          properties:
            governmentIssuedId:
              $ref: '#/components/schemas/creditRealTimePaymentGovernmentIssuedId'
            address:
              description: The address of the sender.
              allOf:
                - $ref: '#/components/schemas/isoCompliantPartialAddress'
            contact:
              description: Sender contact information that can be used for communication about the payment.
              allOf:
                - $ref: '#/components/schemas/realTimePaymentContact'
      example:
        governmentIssuedId: '112223333'
        name: Buffalo Mountain Sports
        address:
          address1: 123 Main Street
          address2: Building 14, Suite 1500
          locality: Miami
          regionCode: FL
          countryCode: US
          postalCode: '12345'
        contact:
          name: John Smith
          emailAddress: johnsmith.doe@business.com
          phoneNumber: '+19105550155'
    realTimePaymentContact:
      title: Real-Time Payment Contact (v1.0.0)
      description: The contact information for the individual or business entity which sent the real-time payment.
      type: object
      properties:
        name:
          description: The name of the payment contact.
          type: string
          format: text
          maxLength: 140
        emailAddress:
          description: The email address of the payment contact.
          type: string
          format: email
          maxLength: 255
        phoneNumber:
          description: The phone number of the payment contact.
          allOf:
            - $ref: '#/components/schemas/simplePhoneNumber'
      example:
        name: John Smith
        emailAddress: johnsmith.doe@business.com
        phoneNumber: '+19105550155'
      x-apiture-version: 1.0.0
    realTimePaymentRecipientSummaryFields:
      x-apiture-version: 1.0.1
      title: Real-Time Payment Recipient Summary Fields (v1.0.1)
      description: Summary fields related to the real-time payment recipient.
      type: object
      x-apiture-fragment: true
      properties:
        name:
          $ref: '#/components/schemas/realTimePaymentRecipientName'
    realTimePaymentRecipientExtendedFields:
      x-apiture-version: 2.0.0
      title: Real-Time Payment Recipient Extended Fields (v2.0.0)
      description: Extended fields related to the real-time payment recipient.
      type: object
      x-apiture-fragment: true
      properties:
        address:
          description: |-
            The address of the recipient.

            If any fields are provided, `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, and `postalCode` are required.
          allOf:
            - $ref: '#/components/schemas/isoCompliantPartialAddress'
        fullAccountNumber:
          $ref: '#/components/schemas/realTimePaymentRecipientAccountNumber'
        institution:
          description: The financial institution of the recipient used for the real-time payment.
          allOf:
            - $ref: '#/components/schemas/recipientInstitution'
    realTimePaymentRecipientExtendedFieldsPatch:
      x-apiture-version: 2.0.0
      title: Real-Time Payment Recipient Extended Fields Patch (v2.0.0)
      description: Extended fields related to the real-time payment recipient patch.
      type: object
      x-apiture-fragment: true
      properties:
        address:
          description: The address of the recipient.
          allOf:
            - $ref: '#/components/schemas/isoCompliantPartialAddress'
        fullAccountNumber:
          $ref: '#/components/schemas/realTimePaymentRecipientAccountNumber'
        institution:
          description: The financial institution of the recipient used for the real-time payment.
          allOf:
            - $ref: '#/components/schemas/recipientInstitutionPatch'
    realTimePaymentRecipientSummary:
      x-apiture-version: 1.0.1
      title: Real-Time Payment Recipient Summary (v1.0.1)
      description: A summary version of the real-time payment recipient.
      type: object
      required:
        - name
      allOf:
        - $ref: '#/components/schemas/realTimePaymentRecipientSummaryFields'
      example:
        name: Exquisite Creations Interior Design & Renovation Services
    realTimePaymentRecipient:
      x-apiture-version: 3.0.0
      title: Real-Time Payment Recipient (v3.0.0)
      description: The recipient of the credit real-time payment.
      type: object
      required:
        - name
        - maskedAccountNumber
        - institution
      allOf:
        - $ref: '#/components/schemas/realTimePaymentRecipientSummaryFields'
        - $ref: '#/components/schemas/realTimePaymentRecipientExtendedFields'
        - type: object
          properties:
            maskedAccountNumber:
              $ref: '#/components/schemas/maskedAccountNumber'
      example:
        name: Exquisite Creations Interior Design & Renovation Services
        address:
          address1: 123 Hierarchy Lane
          locality: Miami
          regionCode: FL
          countryCode: US
          postalCode: '12003'
        maskedAccountNumber: '*6789'
        fullAccountNumber: '123456789'
        institution:
          name: Bank of America
          routingNumber: '123123123'
    newRealTimePaymentRecipient:
      x-apiture-version: 2.0.0
      title: New Real-Time Payment Recipient (v2.0.0)
      description: Representation of a new recipient of the credit real-time payment.
      type: object
      required:
        - name
        - fullAccountNumber
        - institution
      allOf:
        - $ref: '#/components/schemas/realTimePaymentRecipientSummaryFields'
        - $ref: '#/components/schemas/realTimePaymentRecipientExtendedFields'
      example:
        name: Exquisite Creations Interior Design & Renovation Services
        address:
          address1: 123 Hierarchy Lane
          locality: Miami
          regionCode: FL
          countryCode: US
          postalCode: '12003'
        fullAccountNumber: '123456789'
        institution:
          name: Bank of America
          routingNumber: '123123123'
    realTimePaymentRecipientPatch:
      x-apiture-version: 2.0.0
      title: Real-Time Payment Recipient Patch (v2.0.0)
      description: Representation of a patch to the recipient of the credit real-time payment.
      type: object
      allOf:
        - $ref: '#/components/schemas/realTimePaymentRecipientSummaryFields'
        - $ref: '#/components/schemas/realTimePaymentRecipientExtendedFieldsPatch'
      example:
        name: Exquisite Creations Interior Design & Renovation Services
        address:
          address1: 123 Hierarchy Lane
          locality: Miami
          regionCode: FL
          countryCode: US
          postalCode: '12003'
        fullAccountNumber: '123456789'
        institution:
          name: Bank of America
          routingNumber: '123123123'
    debitRealTimePaymentState:
      x-apiture-version: 2.0.0
      title: Debit Real-Time Payment State (v2.0.0)
      description: |+
        Indicates the status of the debit real-time payment.

        <strong><code>debitRealTimePaymentState</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>received</code></strong></td><td>Received: <p>A debit real-time payment that has been received</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: debitRealTimePaymentState
      enum:
        - received
    creditRealTimePaymentState:
      x-apiture-version: 2.0.0
      title: Credit Real-Time Payment State (v2.0.0)
      description: |+
        Indicates the status of the credit real-time payment.

        <strong><code>creditRealTimePaymentState</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 credit real-time payment that has incomplete or erroneous data, or has not yet been 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 credit real-time payment may be scheduled</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>rejected</code></strong></td><td>Rejected: <p>An approver rejected a credit real-time payment</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>scheduled</code></strong></td><td>Scheduled: <p>A credit real-time payment that is scheduled to be processed</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>processing</code></strong></td><td>Processing: <p>A credit real-time payment that has begun the payment process</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>processed</code></strong></td><td>Processed: <p>A credit real-time payment that has completed internal processing and has been sent to the external payment provider</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>completed</code></strong></td><td>Completed: <p>The third party processor has responded that the credit real-time payment has been successfully sent to the recipient</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>failed</code></strong></td><td>Failed: <p>The third party processor has responded that the credit real-time payment has failed and was not sent to the recipient</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: creditRealTimePaymentState
      enum:
        - pending
        - pendingApproval
        - rejected
        - scheduled
        - processing
        - processed
        - completed
        - failed
    creditRealTimePaymentReasonCode:
      x-apiture-version: 3.0.0
      title: Credit Real-Time Payment Reason Code (v3.0.0)
      description: |+
        The reason that a real-time payment is in its current [`state`](#realTimePaymentStateCredit). Normally, this explains why the state is still `pending` and not eligible to be approved or processed. Some `reasonCode` values may only be associated with specific `state` values.
        * `state: pending` may have these `reasonCode` values:
          * `insufficientFunds`
          * `accountNotFound`
          * `none`

        <strong><code>creditRealTimePaymentReasonCode</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>insufficientFunds</code></strong></td><td>Insufficient Funds: <p>The credit real-time payment was created but is not able to be approved or scheduled due to insufficient funding account balance</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>accountNotFound</code></strong></td><td>Account Not Found: <p>The credit real-time payment was created but is not able to be approved or scheduled since the source account has been deleted since the payment was created</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>none</code></strong></td><td>None: <p>The credit real-time payment has no problems and is eligible for submission and approval</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: creditRealTimePaymentReasonCode
      enum:
        - insufficientFunds
        - accountNotFound
        - none
    debitRealTimePaymentAccountReference:
      x-apiture-version: 3.0.0
      title: Debit Real-Time Payment Account Reference (v3.0.0)
      description: The banking account into which the debit real-time payment was deposited. This is always an internal banking account of the user.
      type: object
      required:
        - id
      properties:
        id:
          description: The unique ID of a banking account.
          allOf:
            - $ref: '#/components/schemas/resourceId'
        label:
          $ref: '#/components/schemas/accountLabel'
        nickname:
          $ref: '#/components/schemas/accountNickname'
        maskedNumber:
          $ref: '#/components/schemas/maskedAccountNumber'
        type:
          $ref: '#/components/schemas/productType'
      example:
        id: bf23bc970b78d27691e8
        nickname: Payroll Checking
        label: Payroll Checking *1008
        maskedNumber: '*1008'
        type: checking
    creditRealTimePaymentAccountReference:
      x-apiture-version: 2.0.0
      title: Credit Real-Time Payment Account Reference (v2.0.0)
      description: The banking account used to send the credit real-time payment. This is always an internal banking account of the user.
      type: object
      required:
        - id
      properties:
        id:
          description: The unique ID of a banking account.
          allOf:
            - $ref: '#/components/schemas/resourceId'
        label:
          $ref: '#/components/schemas/accountLabel'
        nickname:
          $ref: '#/components/schemas/accountNickname'
        maskedNumber:
          $ref: '#/components/schemas/maskedAccountNumber'
        type:
          $ref: '#/components/schemas/creditRealTimePaymentProductType'
      example:
        id: bf23bc970b78d27691e8
        nickname: Payroll Checking
        label: Payroll Checking *1008
        maskedNumber: '*1008'
        type: checking
    creditRealTimePaymentAccountReferencePatch:
      x-apiture-version: 2.0.0
      title: Credit Real-Time Payment Account Reference Patch (v2.0.0)
      description: A representation of a patch to the banking account used to send the credit real-time payment. This is always an internal banking account of the user.
      type: object
      properties:
        id:
          description: The unique ID of a banking account.
          allOf:
            - $ref: '#/components/schemas/resourceId'
        label:
          $ref: '#/components/schemas/accountLabel'
        nickname:
          $ref: '#/components/schemas/accountNickname'
        maskedNumber:
          $ref: '#/components/schemas/maskedAccountNumber'
        type:
          $ref: '#/components/schemas/creditRealTimePaymentProductType'
      example:
        id: bf23bc970b78d27691e8
        nickname: Payroll Checking
        label: Payroll Checking *1008
        maskedNumber: '*1008'
        type: checking
    creditRealTimePaymentProductType:
      x-apiture-version: 2.0.0
      title: Credit Real-Time Payment Product Type (v2.0.0)
      description: |+
        The type (or category) of banking product for the credit real-time payment.

        <strong><code>creditRealTimePaymentProductType</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>savings</code></strong></td><td>Savings: <p>Savings Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>checking</code></strong></td><td>Checking: <p>Checking Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>loan</code></strong></td><td>Loan: <p>Loan Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>moneyMarket</code></strong></td><td>Money Market: <p>Money Market Account</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: creditRealTimePaymentProductType
      enum:
        - savings
        - checking
        - loan
        - moneyMarket
    remittanceAdvice:
      x-apiture-version: 1.0.2
      title: Remittance Advice (v1.0.2)
      description: Information related to remittance advice of the real-time payment. Remittance advice is supplemental information sent from the payer to the payee that includes information about the payment such as amount and invoice number(s) in order to assist with account reconciliation and record-keeping.
      type: object
      properties:
        method:
          $ref: '#/components/schemas/remittanceAdviceMethod'
        address:
          description: Depending on the `remittanceAdviceMethod`, this is either an email address or a URI used to digitally deliver remittance advice information.
          type: string
          format: text
          maxLength: 2048
        message:
          description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle in an unstructured form.
          type: string
          format: text
          maxLength: 140
      example:
        method: email
        address: info@example.com
        message: Payment for invoice INV-123
    remittanceAdviceMethod:
      x-apiture-version: 1.0.1
      title: Remittance Advice Method (v1.0.1)
      description: |+
        Indicates the method used to electronically deliver the remittance advice information.

        <strong><code>remittanceAdviceMethod</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>email</code></strong></td><td>Email: <p>Indicates that the remittance advice information is delivered by email</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>uri</code></strong></td><td>URI: <p>Indicates that the remittance advice information is available on a web page at a URL</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: remittanceAdviceMethod
      enum:
        - email
        - uri
    recipientInstitution:
      x-apiture-version: 2.0.1
      title: Recipient Institution (v2.0.1)
      description: A representation of a financial institution used for real-time payments.
      type: object
      required:
        - routingNumber
      properties:
        name:
          $ref: '#/components/schemas/realTimePaymentRecipientInstitutionName'
        routingNumber:
          $ref: '#/components/schemas/accountRoutingNumber'
      example:
        name: Bank of America
        routingNumber: '123123123'
    recipientInstitutionPatch:
      x-apiture-version: 1.0.1
      title: Recipient Institution Patch (v1.0.1)
      description: A representation of a patch to the financial institution used for real-time payments.
      type: object
      properties:
        name:
          $ref: '#/components/schemas/realTimePaymentRecipientInstitutionName'
        routingNumber:
          $ref: '#/components/schemas/accountRoutingNumber'
      example:
        name: Bank of America
        routingNumber: '123123123'
    creditRealTimePaymentAllows:
      title: Credit Real-Time Payment Allows (v1.0.0)
      description: Indicates what credit real-time payment actions are allowed for the current customer, given the user's entitlements and the state of the credit real-time payment.
      type: object
      required:
        - approve
        - edit
        - submit
        - reject
        - delete
      properties:
        approve:
          type: boolean
          description: The customer is allowed to approve the credit real-time payment.
        edit:
          type: boolean
          description: The customer is allowed to edit the credit real-time payment.
        submit:
          type: boolean
          description: The customer is allowed to submit the credit real-time payments for approval.
        reject:
          type: boolean
          description: The customer is allowed to reject the credit real-time payment.
        delete:
          type: boolean
          description: The customer is allowed to delete the credit real-time payment.
      example:
        approve: false
        edit: false
        submit: true
        reject: false
        delete: false
      x-apiture-version: 1.0.0
    realTimePaymentRecipientAccountEligibilityRequest:
      x-apiture-version: 3.0.0
      title: Recipient Account Eligibility Request (v3.0.0)
      description: Request for a real-time payments eligibility check for a recipient account.
      type: object
      required:
        - fullAccountNumber
        - routingNumber
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            customerId:
              $ref: '#/components/schemas/realTimePaymentCustomerId'
            recipientName:
              $ref: '#/components/schemas/realTimePaymentRecipientName'
            fullAccountNumber:
              $ref: '#/components/schemas/realTimePaymentRecipientAccountNumber'
            routingNumber:
              $ref: '#/components/schemas/accountRoutingNumber'
      example:
        customerId: 4242923b-714e
        recipientName: Exquisite Creations Interior Design & Renovation Services
        fullAccountNumber: '123456789'
        routingNumber: '123123123'
    realTimePaymentRecipientAccountEligibility:
      title: Recipient Account Eligibility (v1.0.0)
      description: Response for a real-time payments eligibility check for a recipient account.
      type: object
      required:
        - eligible
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            eligible:
              description: '`true` if the recipient account is eligible to receive credit real-time payments.'
              type: boolean
            institutionName:
              $ref: '#/components/schemas/realTimePaymentRecipientInstitutionName'
            problems:
              description: If the recipient account is not eligible to receive credit real-time payments (`eligible` is `false`), this describes why, if this information is available.
              type: array
              maxItems: 4
              items:
                $ref: '#/components/schemas/apiProblem'
      example:
        eligible: true
        institutionName: Bank of America
        problems: []
      x-apiture-version: 1.0.0
    realTimePaymentRecipientName:
      description: The name of the recipient.
      type: string
      format: text
      minLength: 1
      maxLength: 140
      example: Exquisite Creations Interior Design & Renovation Services
      x-apiture-version: 1.0.0
      title: ' (v1.0.0)'
    realTimePaymentRecipientAccountNumber:
      description: The recipient's account number used for the real-time payment.
      type: string
      format: text
      minLength: 1
      maxLength: 34
      example: '123456789'
      x-apiture-version: 1.0.0
      title: ' (v1.0.0)'
    realTimePaymentRecipientInstitutionName:
      title: Recipient Institution Name (v1.0.0)
      description: The name of the institution.
      type: string
      format: text
      maxLength: 140
      example: Bank of America
      x-apiture-version: 1.0.0
    realTimePaymentAmount:
      title: Real-Time Payment Amount (v1.0.0)
      description: The [ISO 20022 settlement amount](https://en.wikipedia.org/wiki/ISO_20022) of the real-time payment. The maximum allowed total digits is 14, and the maximum allowed fractional digits is 2.
      allOf:
        - $ref: '#/components/schemas/money'
      example:
        amount:
          value: '100.00'
          currency: USD
      x-apiture-version: 1.0.0
    realTimePaymentConfirmationId:
      title: Real-Time Payment Confirmation ID (v1.0.0)
      description: Unique ID generated by the initiating system or institution for the purpose of tracking the payment.
      allOf:
        - $ref: '#/components/schemas/externalResourceId'
      example: '12345'
      x-apiture-version: 1.0.0
    realTimePaymentTrackingNumber:
      title: Real-Time Payment Tracking Number (v1.0.0)
      description: A unique tracking number for this payment. Unlike the `id`, this numeric value is visible to the customer, and can be used to lookup a payment by this ID.
      type: string
      pattern: ^[0-9]+$
      minLength: 6
      maxLength: 9
      example: '12345678'
      x-apiture-version: 1.0.0
    realTimePaymentEndToEndId:
      x-apiture-version: 1.0.1
      title: Real-Time Payment End-To-End ID (v1.0.1)
      description: Information supplied by the initiating party (user or business) to identify the payment. This not required to be unique and is immutable once submitted.
      type: string
      format: text
      maxLength: 35
      example: E2E-Ref001
    realTimePaymentCustomerId:
      title: Real-Time Payment Customer ID (v1.0.0)
      description: The ID of the customer who created the credit real-time payment.
      allOf:
        - $ref: '#/components/schemas/readOnlyResourceId'
      example: 4242923b-714e
      x-apiture-version: 1.0.0
    creditRealTimePaymentGovernmentIssuedId:
      title: Credit Real-Time Payment Government Issued Id (v1.0.0)
      description: |-
        The government issued ID of the sender.

        For Social Security Number (SSN), Employer Identification Number (EIN), Individual Taxpayer Identification Number (ITIN), or any other National Identification Number for non-USA countries, omit all delimiters.
      type: string
      format: text
      minLength: 1
      maxLength: 35
      example: '112223333'
      x-apiture-version: 1.0.0
    creditRealTimePaymentIds:
      x-apiture-version: 1.0.1
      title: Credit Real-Time Payment IDs (v1.0.1)
      description: A list of credit real-time payment IDs to apply an operation to.
      type: array
      minItems: 1
      maxItems: 100
      items:
        $ref: '#/components/schemas/resourceId'
    dateRange:
      title: Date Range (v1.0.0)
      description: 'A date range, supporting inclusive or exclusive endpoints. Dates ranges use dates expressed in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format. The value may have the following forms: <ul> <li>`YYYY-MM-DD` match the date exactly; equivalent to matching dates in the range `[YYYY-MM-DD,YYYY-MM-DD]`</li> <li>`[YYYY-MM-DD,YYYY-MM-DD]` between two dates, inclusive of the endpoints</li> <li>`(YYYY-MM-DD,YYYY-MM-DD)` between two dates, exclusive of the endpoints</li> <li>`[YYYY-MM-DD,]` on or after the date</li> <li>`(YYYY-MM-DD,)` after the date</li> <li>`[,YYYY-MM-DD]` before or on the date</li> <li>`(,YYYY-MM-DD)` before the date</li> </ul>'
      type: string
      maxLength: 24
      pattern: ^\d{4}-\d{2}-\d{2}|([[(](\d{4}-\d{2}-\d{2},(\d{4}-\d{2}-\d{2})?|,\d{4}-\d{2}-\d{2})[)\]])$
      examples:
        - '2022-05-19'
        - '[2022-05-01,2022-05-31]'
        - '[2022-05-01,2022-06-01)'
        - '[2022-05-19,]'
        - (2022-05-19,)
        - '[,2022-05-19]'
        - (,2022-05-19)
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/dateRange
      x-apiture-version: 1.0.0
    bankingAccountIdSelection:
      x-apiture-version: 1.1.0
      title: Account ID Selection (v1.1.0)
      description: A comma-separated list of unique opaque account IDs. Each value is the `id` of a resource in the Accounts API. The list is limited to 32 account IDs.
      type: array
      minItems: 1
      $comment: This maxItems must match bankingAccountList.items.maxItems and incompleteBankingAccountList.items.maxItems
      maxItems: 32
      uniqueItems: true
      items:
        $ref: '#/components/schemas/resourceId'
      example:
        - 6f2625952ad00ef4f701
        - f73e992e4230a6e8ef64
        - d1aa5570846beb619dfa
        - ed202975b84b7acd5161
        - b39069bdbc65c83c58ed
      x-resolved-from: ../../adminAccounts/openapi.yaml#/components/schemas/bankingAccountIdSelection
    amountRange:
      title: Amount Range (v1.2.2)
      x-apiture-version: 1.2.2
      description: 'A monetary amount range, supporting inclusive or exclusive endpoints. The value may have the following forms: <ul> <li>`1200.50` match the dollar amount 1,200.50 exactly</li> <li>`[1000.00,1200.00)` matches items where `1000.00 <= amount < 1200.00`</li> <li>`[1000.00,1199.99]` matches items where `1000.00 <= amount <= 1199.99`</li> <li>`(999.99,1200.00)` matches items where `999.99 < amount < 1200.00`</li> <li>`[1200.50,]` matches items where `amount >= 1200.50`</li> <li>`(1200.50,)` matches items where `amount > 1200.50`</li> <li>`[,1200.50]` matches items where `amount <= 1200.50`</li> <li>`(,1200.50)` matches items where `amount < 1200.50`</li> </ul>'
      type: string
      pattern: ^((\d+(\.\d{0,2})?)|([\[\(](((\d+(\.\d{0,2})?),((\d+(\.\d{0,2})?))?)|(,(\d+(\.\d{0,2})?)))[\]\)]))$
      minLength: 1
      maxLength: 30
      examples:
        - '[1000.00,1200.00)'
        - '[1000.00,1199.99]'
        - (999.99,1200.00)
        - '[1200.50,]'
        - (1200.50,)
        - '[,1200.50]'
        - (,1200.50)
        - '1200.50'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/amountRange
    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
    externalResourceId:
      x-apiture-version: 1.1.0
      title: External Resource Identifier (v1.1.0)
      description: The unique, opaque system identifier for an external resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference an external resource by ID rather than URL.
      type: string
      format: text
      readOnly: true
      minLength: 1
      maxLength: 256
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/externalResourceId
    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
    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
    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
    abstractCountedPagedBody:
      x-apiture-version: 1.0.1
      title: Abstract Counted Paged Body (v1.0.1)
      description: An abstract schema used to define paginated collections of resources. Collection classes which extend this schema define an array of `items` which represent a page of data.
      type: object
      x-apiture-fragment: true
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/abstractPagedBodyFields'
        - type: object
          properties:
            start:
              description: The opaque cursor that specifies the starting location of this page of items.
              type: string
              format: text
              maxLength: 256
            count:
              description: The total number of items that matched the request. This is only present if the API service can efficiently compute it.
              type: integer
              format: int64
              minimum: 0
              maximum: 4000000000
            pageNumber:
              description: The current page number.
              type: integer
              format: int32
              minimum: 0
              maximum: 4000000000
      example:
        nextPage_url: https://static.api.apiture.com/banking/resources?start=v80fjhd8f89sfdj&limit=100
        start: 1922a8531e8384cfa71b
        limit: 100
        count: 5000
        pageNumber: 1
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/abstractCountedPagedBody
    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
    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
    isoCompliantPartialAddress:
      x-apiture-version: 1.0.1
      title: ISO-Compliant Partial Address (v1.0.1)
      description: A partial [ISO 20022 postal address](https://en.wikipedia.org/wiki/ISO_20022) that can hold a US address or an international (non-US) postal addresses. Partial addresses do not require any property to have a value.
      type: object
      allOf:
        - $ref: '#/components/schemas/isoCompliantFullAddressFields'
      examples:
        - address1: 1805 Tiburon Dr.
        - locality: Wilmington
          regionCode: NC
        - countryCode: US
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/isoCompliantPartialAddress
    simplePhoneNumber:
      x-apiture-version: 1.1.0
      title: Simple Phone Number (v1.1.0)
      description: The phone number as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is `+1`. Phone numbers are returned in responses in [E.164](https://en.wikipedia.org/wiki/E.164) format with a leading `+`, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See [Phone Number Representations](https://developer.apiture.com/docs/concepts/phone-numbers/) for more information. If the number is masked to hide Personally Identifiable Information, all but the last four digits are replaced with one or more `*`, such as `*1234`.
      type: string
      example: '+19105550155'
      minLength: 5
      maxLength: 20
      format: phone-number
      x-apiture-since: 0.5.0
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/simplePhoneNumber
    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
    accountLabel:
      title: Account Label (v1.0.0)
      description: The human-readable label for this account. This is either the `nickname` (if assigned for the current customer), or the `product.label` concatenated with the `maskedNumber`.
      type: string
      minLength: 1
      maxLength: 80
      format: text
      example: Checking *1008
      x-resolved-from: ../../accounts/openapi.yaml#/components/schemas/accountLabel
      x-apiture-version: 1.0.0
    accountNickname:
      x-apiture-version: 1.2.0
      title: Account Nickname (v1.2.0)
      description: The nickname (friendly name) the customer has given this account. Each customer can define their own nickname for the same account. If omitted, the customer has not set a nickname.
      type: string
      maxLength: 50
      format: text
      example: Payroll Checking
      x-resolved-from: ../../accounts/openapi.yaml#/components/schemas/accountNickname
    productType:
      x-apiture-version: 2.2.0
      title: Product Type (v2.2.0)
      description: |+
        The type (or category) of banking product.

        <strong><code>productType</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>savings</code></strong></td><td>Savings: <p>Savings Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>checking</code></strong></td><td>Checking: <p>Checking Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>cd</code></strong></td><td>CD: <p>Certificate of Deposit Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>ira</code></strong></td><td>IRA: <p>Individual Retirement Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>loan</code></strong></td><td>Loan: <p>Loan Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>creditCard</code></strong></td><td>Credit Card: <p>Credit Card Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>moneyMarket</code></strong></td><td>Money Market: <p>Money Market Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>healthSavings</code></strong></td><td>Health Savings: <p>Health Savings Account</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: productType
      enum:
        - savings
        - checking
        - cd
        - ira
        - loan
        - creditCard
        - moneyMarket
        - healthSavings
      x-resolved-from: ../../products/openapi.yaml#/components/schemas/productType
    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
    money:
      x-apiture-version: 1.0.2
      title: Money (v1.0.2)
      description: An amount of money in a specific currency.
      type: object
      properties:
        value:
          description: The net monetary value. A negative amount denotes a debit; a positive amount denotes a credit. The numeric value is represented as a string so that it can be exact with no loss of precision.
          $ref: '#/components/schemas/monetaryValue'
        currency:
          description: The [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) for this monetary value.
          $ref: '#/components/schemas/currencyCode'
      example:
        value: '1000.00'
        currency: USD
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/money
    requiredIdentityChallenge:
      x-apiture-version: 1.2.3
      title: Required Challenge (v1.2.3)
      description: A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 [Unauthorized problem response](#schema-apiProblem) when the 401 problem type name is `challengeRequired`. See the "Challenge API" for details.
      type: object
      required:
        - operationId
        - challengeId
        - factors
      properties:
        operationId:
          $ref: '#/components/schemas/challengeOperationId'
        challengeId:
          description: The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses.
          $ref: '#/components/schemas/readOnlyResourceId'
        factors:
          description: 'A list of challenge factors. The user must complete one of these challenge factors. The `labels` in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. ***Note**: The same channel may be used by multiple factors in the array of factors. For example, the user''s primary mobile phone number may be used for both an `sms` factor and a `voice` factor.'
          type: array
          minItems: 1
          maxItems: 8
          items:
            $ref: '#/components/schemas/challengeFactor'
      example:
        operationId: createTransfer
        challengeId: 0504076c566a3cf7009c
        factors:
          - type: sms
            labels:
              - '9876'
            id: 85c0ee5753fcd0b0953f
          - type: voice
            labels:
              - '9876'
            id: d089e10a80a8627df37b
          - type: voice
            labels:
              - '6754'
            id: 10506ecf9d1c2ee00403
          - type: email
            labels:
              - an****nk@example.com
              - an****98@example.com
            id: e917d671cb2f030b56f1
          - type: authenticatorToken
            labels:
              - Acme fob
            id: fe6c452d7da0bbb4e407
          - type: securityQuestions
            securityQuestions:
              questions:
                - id: q1
                  prompt: What is your mother's maiden name?
                - id: q4
                  prompt: What is your high school's name?
                - id: q9
                  prompt: What is the name of your first pet?
            id: df33c6f88a37d6b3f0a6
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/requiredIdentityChallenge
    abstractPagedBodyFields:
      x-apiture-version: 1.1.1
      title: Abstract Paged Body Fields (v1.1.1)
      description: Common properties of collection page responses.
      x-apiture-fragment: true
      type: object
      required:
        - limit
      properties:
        limit:
          description: The number of items requested for this page response. The length of the `items` array may be less that `limit`.
          type: integer
          format: int32
          minimum: 0
          maximum: 10000
        nextPage_url:
          description: The URL of the next page of resources. If this URL is omitted, there are no more resources in the collection.
          readOnly: true
          maxLength: 8000
          type: string
          format: uri-reference
          example: https://static.api.apiture.com/banking/resources/8b76b4a97dccad88890e
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/abstractPagedBodyFields
    isoCompliantFullAddressFields:
      x-apiture-version: 1.0.1
      title: ISO-Compliant Full Address Fields (v1.0.1)
      description: A [ISO 20022 postal address](https://en.wikipedia.org/wiki/ISO_20022) that can hold a US address or an international (non-US) postal addresses.
      type: object
      x-apiture-fragment: true
      allOf:
        - $ref: '#/components/schemas/isoCompliantAddressFields'
        - type: object
          properties:
            regionName:
              type: string
              minLength: 1
              maxLength: 35
              format: text
              description: The state, district, or outlying area of the postal address. This is required if `countryCode` is not `US`. `regionCode` and `regionName` are mutually exclusive.
              examples:
                - Alessandria
                - Rio de Janeiro
                - British Columbia
            regionCode:
              type: string
              maxLength: 2
              minLength: 2
              pattern: ^[A-Za-z]{2}$
              description: The state, district, or outlying area of the postal address. This is required if `countryCode` is `US`. `regionCode` and `regionName` are mutually exclusive.
              examples:
                - NC
                - IL
                - VI
            postalCode:
              $ref: '#/components/schemas/isoCompliantPostalCode'
      examples:
        - address1: 1805 Tiburon Dr.
          address2: Building 14, Suite 1500
          locality: Wilmington
          regionCode: NC
          countryCode: US
          postalCode: '28403'
        - address1: 999 Canada Place
          locality: Vancouver
          regionName: British Columbia
          countryCode: CA
          postalCode: V6C 3T4
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/isoCompliantFullAddressFields
    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
    currencyCode:
      description: A [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) This is always upper case ASCII. Crypto currencies with codes longer that 3 characters are not supported.
      type: string
      format: text
      pattern: ^[A-Z]{3}$
      minLength: 3
      maxLength: 3
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/currencyCode
      x-apiture-version: 1.0.0
      title: ' (v1.0.0)'
    challengeOperationId:
      x-apiture-version: 1.0.1
      title: Challenge Operation ID (v1.0.1)
      description: The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.
      type: string
      pattern: ^[-a-zA-Z0-9$_]{6,48}$
      minLength: 6
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeOperationId
    challengeFactor:
      x-apiture-version: 1.2.1
      title: Challenge Factor (v1.2.1)
      description: A challenge factor. See [`requiredIdentityChallenge`](#schema-requiredIdentityChallenge) for multiple examples.
      type: object
      required:
        - type
      properties:
        id:
          description: |-
            The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this `id` value as the `factorId` when starting or verifying a challenge factor.

            *Note*: The `id` will become `required` in a future update to this schema.
          $ref: '#/components/schemas/challengeFactorId'
        type:
          $ref: '#/components/schemas/challengeFactorType'
        labels:
          description: A list of text label which identifies the channel(s) through which the user completes the challenge. For an `sms` or `voice` challenge, the only label item is the last four digits of the corresponding phone number. For an `email` challenge, each label is the masked email address.
          type: array
          minItems: 1
          maxItems: 4
          items:
            type: string
            maxLength: 300
            format: text
        securityQuestions:
          $ref: '#/components/schemas/challengeSecurityQuestions'
      example:
        type: sms
        labels:
          - '9876'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeFactor
    isoCompliantAddressFields:
      title: ISO-Compliant Address Fields (v1.0.0)
      description: Properties of a [ISO 20022 postal address](https://en.wikipedia.org/wiki/ISO_20022), used to compose other ISO-compliant addresses.
      x-apiture-fragment: true
      properties:
        address1:
          type: string
          description: The first line of the postal address. In the US, this typically includes the building number and street name.
          example: 1805 Tiburon Dr.
          maxLength: 70
          format: text
        address2:
          type: string
          description: The second line of the street address. This should only be used if it has a value. Typical values include building numbers, suite numbers, and other identifying information beyond the first line of the postal address.
          example: Building 14, Suite 1500
          maxLength: 70
          format: text
        locality:
          type: string
          description: The city/town/municipality of the address.
          examples:
            - Wilmington
            - Atlanta
          maxLength: 35
          format: text
        countryCode:
          $ref: '#/components/schemas/countryCode'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/isoCompliantAddressFields
      x-apiture-version: 1.0.0
    isoCompliantPostalCode:
      title: ISO-Compliant Postal code (v1.0.0)
      description: The [ISO 20022 postal code](https://en.wikipedia.org/wiki/ISO_20022), which varies in format by country. For postal codes in the US, this should be a five digit US ZIP code or ten character ZIP+4.
      type: string
      format: text
      minLength: 2
      maxLength: 16
      examples:
        - '20521'
        - 20521-1380
        - V6C 3T4
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/isoCompliantPostalCode
      x-apiture-version: 1.0.0
    challengeFactorId:
      title: Challenge Factor ID (v1.0.0)
      description: The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.
      type: string
      pattern: ^[-a-zA-Z0-9$_]{3,48}$
      minLength: 3
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeFactorId
      x-apiture-version: 1.0.0
    challengeFactorType:
      title: Challenge Factor Type (v1.0.0)
      description: |+
        The name of challenge factor.

        <strong><code>challengeFactorType</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>sms</code></strong></td><td>SMS: <p>One-time passcode sent to the primary mobile phone number</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>email</code></strong></td><td>Email: <p>One-time passcode sent to the primary email address</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>voice</code></strong></td><td>Voice: <p>One-time passcode communicated via automated voice phone call</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>authenticatorToken</code></strong></td><td>authenticator Token: <p>One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>securityQuestions</code></strong></td><td>Security Questions: <p>Prompt with the user&#39;s security questions registered with their security profile</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: challengeFactorType
      enum:
        - sms
        - email
        - voice
        - securityQuestions
        - authenticatorToken
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeFactorType
      x-apiture-version: 1.0.0
    challengeSecurityQuestions:
      x-apiture-version: 1.0.1
      title: Challenge Security Questions (v1.0.1)
      description: Describes a `securityQuestions` challenge. This is omitted if the challenge `type` is not `securityQuestions`.
      type: object
      required:
        - questions
      properties:
        questions:
          description: The array of security questions.
          type: array
          minItems: 1
          maxItems: 8
          items:
            $ref: '#/components/schemas/challengeSecurityQuestion'
      example:
        questions:
          - id: q1
            prompt: What is your mother's maiden name?
          - id: q4
            prompt: What is your high school's name?
          - id: q9
            prompt: What is the name of your first pet?
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeSecurityQuestions
    countryCode:
      title: Country Code (v1.0.0)
      description: The [ISO-3611 alpha-2](https://www.iso.org/glossary-for-iso-3166.html) value for a country.
      type: string
      minLength: 2
      maxLength: 2
      pattern: ^[A-Za-z]{2}$
      examples:
        - US
        - CA
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/countryCode
      x-apiture-version: 1.0.0
    challengeSecurityQuestion:
      x-apiture-version: 1.0.1
      title: Challenge Security Question (v1.0.1)
      description: A single security question within the `questions` array of the [`challengeSecurityQuestions`](#schema-challengeSecurityQuestions)
      type: object
      required:
        - id
        - prompt
      properties:
        id:
          description: The unique ID of security question prompt. This should be included in the [`challengeVerification`](#schema-challengeVerification) response as the `promptId`.
          $ref: '#/components/schemas/challengePromptId'
        prompt:
          description: The text prompt of this security question.
          type: string
          format: text
          maxLength: 80
      example:
        id: 74699fa628911e762ea5
        prompt: What is your mother's maiden name?
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeSecurityQuestion
    challengePromptId:
      title: Challenge Prompt ID (v1.0.0)
      description: The unique ID of a prompt (such as a security question) in a challenge factor.
      type: string
      pattern: ^[-_:.~$a-zA-Z0-9]+$
      minLength: 1
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengePromptId
      x-apiture-version: 1.0.0
  x-apiture-errors:
    invalidAccountIds:
      description: One or more account IDs are invalid and do not correspond to accounts.
      remediation: Remove the invalid account IDs from the request and try again.
      attributes:
        properties:
          accountIds:
            description: The list of invalid account IDs.
            type: array
            minItems: 1
            maxItems: 1000
            uniqueItems: true
            items:
              $ref: '#/components/schemas/readOnlyResourceId'
      x-resolved-from: ../../accounts/openapi.yaml#/components/x-apiture-errors/invalidAccountIds
    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
    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
    customerDisabled:
      description: The customer is disabled.
      remediation: Have the customer contact the financial institution for support.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/customerDisabled
    antiMalwareRequired:
      description: The financial institution requires the customer to have anti-malware software installed.
      remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/antiMalwareRequired
    modificationForbidden:
      description: The customer is properly authenticated but not authorized to create, modify, or delete resources.
      remediation: Avoid modification operation for customers with read-only authorization.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/modificationForbidden
    challengeRequired:
      description: The operation requires the customer to complete an identity challenge.
      remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call.
      attributes:
        $ref: '#/components/schemas/requiredIdentityChallenge'
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/challengeRequired
    challengeBlocked:
      description: The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication.
      remediation: Have the user end their login session and login again.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/challengeBlocked
    noIdentityChallengeFactors:
      description: This operation requires an identity challenge, but the user does not have the necessary registered authentication factors.
      remediation: Have the user register one or more challenge security code delivery factors.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/noIdentityChallengeFactors
    invalidIdentityChallengeHeader:
      description: The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid.
      remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/invalidIdentityChallengeHeader
    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
    conflict:
      description: The request could not be completed due to a conflict with the current state of the target resource.
      remediation: Try another operation that is allowed.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/conflict
    unprocessableEntity:
      description: The syntax of the request entity is correct but was unable to process the contained instructions.
      remediation: Provide a semantically correct request.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/unprocessableEntity
    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
x-apiture-errors:
  invalidRealTimePaymentAmount:
    description: The amount is $0.00, is more than 14 total digits, or the amount of the real-time payment exceeds the allowed limit within a certain period.
    remediation: Change the amount to a value greater than $0.00 with no more than 14 total digits, that does not exceed the allowed limit and resubmit.
  invalidRealTimePaymentSourceAccount:
    description: The chosen source account does not exist, is not accessible, or is not entitled for real-time payments.
    remediation: Choose an existing source account with the correct entitlement for real-time payments.
  invalidRealTimePaymentSourceAccounts:
    description: The chosen source accounts do not exist, are not accessible, or are not entitled for real-time payments.
    remediation: Choose existing source accounts with the correct entitlement for real-time payments.
  invalidRealTimePaymentRecipientAccount:
    description: The chosen recipient account does not exist, is not accessible, or is not entitled for real-time payments.
    remediation: Choose an existing recipient account with the correct entitlement for real-time payments.
  invalidRealTimePaymentRecipientAccounts:
    description: The chosen recipient accounts do not exist, are not accessible, or are not entitled for real-time payments.
    remediation: Choose existing recipient accounts with the correct entitlement for real-time payments.
  emptyRealTimePaymentRecipientAddress:
    description: The address object was included for the recipient but no fields were included inside the address object.
    remediation: Either do not include the address object for the recipient or include at least one field inside the address object.
  emptyRealTimePaymentSenderAddress:
    description: The address object was included for the sender but no fields were included inside the address object.
    remediation: Either do not include the address object for the sender or include at least one field inside the address object.
  missingRealTimePaymentRecipientAddressFields:
    description: At least one field has been provided for the recipient address but `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, or `postalCode` is missing.
    remediation: If any fields are provided for the recipient address, provide `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, and `postalCode`.
  missingRealTimePaymentSenderAddressFields:
    description: At least one field has been provided for the sender address but `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, or `postalCode` is missing.
    remediation: If any fields are provided for the recipient address, provide `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, and `postalCode`.
  invalidRealTimePaymentRecipientUsPostalCode:
    description: The recipient's `countryCode` is `US` but the `postalCode` is not in the correct format.
    remediation: If the recipient's `countryCode` is `US`, provide a value for `postalCode` that is either a five digit US ZIP code or a ten character ZIP+4.
  invalidRealTimePaymentSenderUsPostalCode:
    description: The sender's `countryCode` is `US` but the `postalCode` is not in the correct format.
    remediation: If the sender's `countryCode` is `US`, provide a value for `postalCode` that is either a five digit US ZIP code or a ten character ZIP+4.
  remittanceAdviceEmailAddressTooLong:
    description: When the remittance advice `method` is `email`, the `address` can be no longer than 255 characters.
    remediation: Shorten the `address` of the remittance advice to 255 characters or less if the `method` is `email`.
  invalidRealTimePaymentId:
    description: The specified real-time payment ID is invalid or does not refer to an existing real-time payment.
    remediation: Specify the ID of an existing real-time payment for which the user has access.
  invalidRealTimePaymentIds:
    description: All of the real-time payment IDs are invalid or do not refer to an existing real-time payment.
    remediation: Specify the IDs of existing real-time payments for which the user has access.
  invalidRealTimePaymentRecipientRoutingNumber:
    description: The routing number for the recipient financial institution is invalid.
    remediation: Use a valid routing number.
  invalidRealTimePaymentRecipientRoutingNumbers:
    description: The routing number for the recipient financial institution for each credit real-time payment is invalid.
    remediation: Use a valid routing number for each credit real-time payment.
  institutionDoesNotSupportRealTimePayments:
    description: The routing number is valid but the financial institution does not support real-time payments.
    remediation: Use a routing number for a financial institution that does support real-time payments.
  institutionsDoNotSupportRealTimePayments:
    description: The routing numbers are valid but the financial institutions do not support real-time payments.
    remediation: Use routing numbers for financial institutions that support real-time payments.
  invalidRealTimePaymentStateForEdit:
    description: The edit operation is not allowed if the credit real-time payment `allows.edit` is `false`.
    remediation: Do not attempt to update a real-time payment if `allows.edit` is `false`.
  invalidRealTimePaymentStateForSubmit:
    description: The submit operation is not allowed if the credit real-time payment `allows.submit` is `false`.
    remediation: Resolve any problems in the credit real-time payment so that the payment `allows.submit` is `true`.
  invalidRealTimePaymentStateForApprove:
    description: The approve operation is not allowed if the credit real-time payment `allows.approve` is `false`.
    remediation: Resolve any problems in the credit real-time payment so that the payment `allows.approve` is `true`.
  invalidRealTimePaymentsStateForApprove:
    description: The approve operation is not allowed if the credit real-time payments `allows.approve` are `false`.
    remediation: Resolve any problems in the credit real-time payments so that each payment `allows.approve` is `true`.
  invalidRealTimePaymentStateForReject:
    description: The reject operation is not allowed if the credit real-time payment `allows.reject` is `false`.
    remediation: Resolve any problems in the credit real-time payment so that the payment `allows.reject` is `true`.
  invalidRealTimePaymentsStateForReject:
    description: The reject operation is not allowed if the credit real-time payments `allows.reject` are `false`.
    remediation: Resolve any problems in the credit real-time payments so that each payment `allows.reject` is `true`.
  invalidRealTimePaymentStateForDelete:
    description: The delete operation is not allowed if the credit real-time payment `allows.delete` is `false`.
    remediation: Resolve any problems in the credit real-time payment so that the payment `allows.delete` is `true`.
  invalidRealTimePaymentsStateForDelete:
    description: The delete operation is not allowed if the credit real-time payments `allows.delete` are `false`.
    remediation: Resolve any problems in credit real-time payments so that each payment `allows.delete` is `true`.
  invalidRealTimePaymentStateForAddApprovers:
    description: The credit real-time payment cannot have approvers added when in the current state.
    remediation: The credit real-time payment state must be `pendingApproval`.
  invalidRealTimePaymentApprover:
    description: The requested approver is not eligible for approving this credit real-time payment.
    remediation: Pass only eligible approvers from the `listEligibleCreditRealTimePaymentApprovers` operation.
  realTimePaymentLimitExceeded:
    description: The credit real-time payment exceed a daily, transaction, or temporary limit.
    remediation: Pass an amount for the credit real-time payment that does not exceed the  daily, transaction, or temporary limit.
  realTimePaymentsLimitExceeded:
    description: The credit real-time payments exceed a daily, transaction, or temporary limit.
    remediation: Pass an amount for each credit real-time payment that does not exceed the  daily, transaction, or temporary limit.
x-apiture-traits:
  - resource:
      name: real-time payment
      excludeMethods:
        - post
        - put
        - patch
        - delete
      paginated: false
      applied: true
  - security:
      baseScope: banking
      applied: true
x-resolved-from: ../../realTimePayments/status-codes-openapi.yaml
x-resolved-at: '2024-12-03T17:24:50.226Z'
x-apiture-annotated-at: '2024-12-03T17:24:50.521Z'
