Customers Bank Event Types API

openapi: 3.2.0
info:
  title: Webhooks Event Types API
  version: v1
servers:
- url: https://cubi-sandbox-api.customersbank.com/webhooks/v1
tags:
- name: EventTypes
paths:
  /EventTypes:
    get:
      tags:
      - EventTypes
      summary: /EventTypes - GET
      operationId: get-eventtypes
      parameters:
      - name: paginateResults
        in: query
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: perPage
        in: query
        schema:
          type: integer
          format: int32
      - name: sortOn
        in: query
        schema:
          type: string
      - name: sortAscending
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Cubi.Common.Abstractions.Paginated_System.String'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/Cubi.Common.Abstractions.Paginated_System.String'
              example:
                pageSize: 0
                pageOffset: 0
                totalPages: 0
                totalItemCount: 0
                items:
                - string
            text/json:
              schema:
                $ref: '#/components/schemas/Cubi.Common.Abstractions.Paginated_System.String'
              example:
                pageSize: 0
                pageOffset: 0
                totalPages: 0
                totalItemCount: 0
                items:
                - string
        '400':
          description: BadRequest
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails'
              example:
                type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                title: One or more validation errors occurred.
                status: 400
                traceId: string
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
              example:
                type: https://tools.ietf.org/html/rfc9110#section-15.5.2
                title: Unauthorized
                status: 401
                traceId: string
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
              example:
                type: https://tools.ietf.org/html/rfc9110#section-15.5.4
                title: Forbidden
                status: 403
                traceId: string
        '404':
          description: NotFound
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
              example:
                type: https://tools.ietf.org/html/rfc9110#section-15.5.5
                title: Not Found
                status: 404
                traceId: string
        '422':
          description: UnprocessableEntity
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails'
              example:
                type: https://tools.ietf.org/html/rfc4918#section-11.2
                title: Unprocessable Entity
                status: 422
                traceId: string
        '500':
          description: InternalServerError
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
              example:
                type: https://tools.ietf.org/html/rfc9110#section-15.6.1
                title: An error occurred while processing your request.
                status: 500
                traceId: string
      callbacks:
        ach.incoming-received:
          /:
            post:
              summary: This indicates that an incoming ach payment was received
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/ach.incoming-received'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        ach.outgoing-accepted:
          /:
            post:
              summary: This indicates that an outgoing ach payment was accepted by the payment processor
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/ach.outgoing-accepted'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        ach.outgoing-approval-denied:
          /:
            post:
              summary: This indicates that an outgoing ach payment was denied by the dual approver
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/ach.outgoing-approval-denied'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        ach.outgoing-approval-required:
          /:
            post:
              summary: This indicates that an outgoing ach payment requires a dual approver
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/ach.outgoing-approval-required'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        ach.outgoing-cancelled:
          /:
            post:
              summary: This indicates that an outgoing ach payment has been cancelled
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/ach.outgoing-cancelled'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        ach.outgoing-completed:
          /:
            post:
              summary: This indicates that an outgoing ach payment has been completed
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/ach.outgoing-completed'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        ach.outgoing-initiated:
          /:
            post:
              summary: This indicates that an outgoing ach payment has been initiated
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/ach.outgoing-initiated'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        ach.outgoing-pending:
          /:
            post:
              summary: This indicates that an outgoing ach payment has been sent to the payment processor and is no longer cancellable
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/ach.outgoing-pending'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        ach.outgoing-returned:
          /:
            post:
              summary: This indicates that an outgoing ach payment has been returned
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/ach.outgoing-returned'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loan-cancellationfailed:
          /:
            post:
              summary: This indicates that a loan cancellation request failed
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loan-cancellationfailed'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loan-cancelled:
          /:
            post:
              summary: This indicates that a loan has been cancelled
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loan-cancelled'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loan-completed:
          /:
            post:
              summary: This indicates that a loan has been completed
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loan-completed'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loan-created:
          /:
            post:
              summary: This indicates that a loan was created from a successful application
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loan-created'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loan-disbursementdateset:
          /:
            post:
              summary: This indicates that the disbursement date of a loan has been set. This webhook will only be raised one time for each loan. The webhook is raised when the first funding instruction for a loan is sent to a payment rail since this is when the funding of a loan is considered irrevocable.
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loan-disbursementdateset'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loan-maturitydateset:
          /:
            post:
              summary: This indicates that the maturity date of a loan has been set. This webhook will only be raised one time for each loan. The webhook is raised when the first funding instruction for a loan is sent to a payment rail since this is when the funding of a loan is considered irrevocable.
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loan-maturitydateset'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loan-pendingcompletion:
          /:
            post:
              summary: This indicates that a request to complete a loan has been made, and that it is being processed. The change to a completed status will occur once all open funding requests have been successfully processed.
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loan-pendingcompletion'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loan-reopened:
          /:
            post:
              summary: This indicates that a loan's status has been changed to Open
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loan-reopened'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loanapplication-approved:
          /:
            post:
              summary: This indicates that a loan application has been processed by the API and that it has passed all of the credit policy approval rules.
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loanapplication-approved'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loanapplication-created:
          /:
            post:
              summary: This indicates that a loan application has been successfully saved to the system
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loanapplication-created'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loanapplication-creditpolicycheckfailed:
          /:
            post:
              summary: This indicates that a loan application has been processed by the API and that it failed one or more of the credit policy checks.
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loanapplication-creditpolicycheckfailed'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loanapplication-partnercanceledcreated:
          /:
            post:
              summary: This indicates that a partner canceled loan application has been successfully saved to the system
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loanapplication-partnercanceledcreated'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loanapplication-partnerdeclinedcreated:
          /:
            post:
              summary: This indicates that a partner declined loan application has been successfully saved to the system
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loanapplication-partnerdeclinedcreated'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loanapplication-partnerrejectedcreated:
          /:
            post:
              summary: This indicates that a partner rejected loan application has been successfully saved to the system
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loanapplication-partnerrejectedcreated'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loanapplication-received:
          /:
            post:
              summary: This indicates that a loan application was received by the api with a HttpCode 202 (Accepted) returned
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loanapplication-received'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loanapplication-rejected:
          /:
            post:
              summary: This indicates that a loan application has been rejected at some point after the API accepted it, but before the credit policy approval rules were checked.
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loanapplication-rejected'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loanfunding-failed:
          /:
            post:
              summary: This indicates that a funding request failed while being processed
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loanfunding-failed'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loanfunding-fundingsenttorail:
          /:
            post:
              summary: This indicates that a funding request was sent to the payment rail for processing
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/consumerlending.loanfunding-fundingsenttorail'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
                '400':
                  description: (4xx) If your server returns any HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
                '500':
                  description: (5xx) If your server returns any HTTP status code indicating a server-side error the delivery will be treated as a failure. Delivery will be attempted up to 5 times.
        consumerlending.loanfunding-railcancelled:
          /:
            post:
            

# --- truncated at 32 KB (122 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/customers-bank/refs/heads/main/openapi/customers-bank-eventtypes-api-openapi.yml