openapi: 3.2.0
info:
  title: OpenAPI definition Payment API
  version: v0
  description: "# About MonetizeNow\n\nMonetizeNow provides a Quoting, Billing, and Usage platform built for the B2B SaaS enterprise. Our platform simplifies monetization for SMBs by uniting these functions in a single application.\n\n<img src=\"https://i.ibb.co/VDN53ZF/MNArch.png\">\n\n## Core Platform Features\n\nMonetizeNow provides:\n\n- Product catalog specifically built to handle enterprise-grade selling complexity of subscriptions, one-time, and usage.\n- A single system that supports all your sales channels natively: self-serve, CRM, Partners, In-Product, and Marketplaces.\n- Complex enterprise quoting, flexible rules and approval engine, E-sign, Clean order forms\n- Broad API support for integrating with existing and future systems.\n    \n\n# Getting Started with MonetizeNow APIs\n\nThe MonetizeNow APIs are RESTful libraries that enable developers to integrate with the MonetizeNow platform for the complete revenue life cycle.\n\n## Authentication\n\nThe preferred authentication method is a generated API key.\n\n### Getting an API Key\n\nYou can request your API Key from your MonetizeNow tenant:\n\n1. Navigate to the **Settings -> API Keys** page to generate an API key for your tenant.\n    \n\n<img src=\"https://i.ibb.co/QMvvLtL/MNAPIKey.png\">\n\n1. Click **New Api Key**.\n2. Enter a name for the key as an identifier.\n3. Click **Ok**.\n    \n\n<img src=\"https://i.ibb.co/7WQM27b/MNKey-Sample.png\">\n\n1. Copy and store your key in a safe place.  \n    For security reasons, this is the only time we display it.\n2. Click **Ok**.\n    \n\nYou can now use this API key to interact with all MonetizeNow APIs.\n\n## Pagination\n\nThe MonetizeNow API provides pagination attributes for methods that return multiple records.\n\n**pageSize**\\=n  \npageSize indicates the number of elements in the page.\n\n**currentPage**\\=n  \ncurrentPage indicates the page to start with.\n\nUse currentPage and pageSize to return a sublist from a list of sorted resources where the sort criteria is defaulted or set via API:\n\n`GET /api/accounts?currentPage=3&pageSize=20`\n\n## Error Handling\n\nThe MonetizeNow API follows standard RESTful error handling. It returns the following error types:\n\n| Title | Code | Description |\n| --- | --- | --- |\n| Bad request | 400 | The request submitted was not acceptable. Missing parameters or a malformed request body will produce this error |\n| Resource not found by ID | 404 | The request submitted an identifier that does not match a record for the target entity. |\n| Resource is not in the required state | 409 | The identified resource is not an eligible target. For example, attempting to restore an offering that has not been archived returns a 409. |\n| Internal server error | 500 | An unexpected error occurred. Contact MonetizeNow Support. |\n\n## Webhooks\n\nUse webhooks to integrate MonetizeNow with external services. The following events are supported.\n\n| Entity | Event | Occurs When |\n| --- | --- | --- |\n| Account | account.created | an account is created |\n|  | account.updated | an account is updated |\n| Contact | contact.created | a contact is created |\n|  | contact.updated | a contact is updated |\n| Quote | quote.created | a quote is created |\n|  | quote.updated | a quote is updated |\n|  | quote.accepted | a quote is accepted |\n|  | quote.processed | a quote is processed |\n|  | quote.cancelled | a quote is cancelled |\n|  | quote.offering.created | an offering is added to a quote |\n|  | quote.offering.updated | an offering on a quote is updated |\n|  | quote.offering.deleted | an offering is deleted from a quote |\n| Opportunity | opportunity.created | an opportunity is created |\n|  | opportunity.updated | an opportunity is updated |\n| Offering | offering.created | an offering is created |\n|  | offering.updated | an offering is updated |\n| Contract | contract.created | a contract is created |\n|  | contract.updated | a contract is updated |\n| Rate | rate.created | a rate is created |\n|  | rate.updated | a rate is updated |\n|  | rate.deleted | a rate is deleted |\n|  | price.deleted | a rate's price is deleted |\n| Bill Group | dunning.step.tiggered | a dunning step is triggered |\n\n# Concepts\n\n## Product Catalog\n\nThe core of the MonetizeNow platform is the product catalog.\n\nThe entities that make up the Product Catalog are:\n\n- Product\n- Usage Type\n- Price\n- Offering\n- Rate\n    \n\nThe **Product** is the starting point for any quote, the simplest line item. If that line item has a usage component, then a **Usage Type** is assigned. A single Product has a **Price**. However, a Product can be one of several included in an **Offering**, or bundle. Offerings are available at one \\*_Rate \\*_or more. A Rate is a different way to price products and model an offering. You can create multiple Rates of different currencies and billing frequencies.\n\nFor example, the Products in a product catalog might include software access, services, setup fees, and API calls. Your organization may allow a customer to order a single set of 200 API calls, or you may provide a package of support hours and API calls as an Offering. Prices might be directly related to set of API calls or calculated by means of an \"Get Started\" Offering and Rate for API access.\n\n## Accounts\n\nAccounts represent your existing and potential customers.\n\nThe entities related to account records include:\n\n- Contacts\n- Bill Groups\n- Subscriptions\n- Quotes\n- Contracts\n- Invoices\n- Credits\n- Payments\n    \n\nEach **Account** represents a current or potential customer. **Contacts** are people your organization has interacted with. **Bill Groups** represent departments, divisions, or other separate destinations for billing within that business. A **Subscription** represents a renewable request for an **Offering**. A **Quote** is a formal statement of what is being ordered and how much the items will cost. A **Contract** stores information on the Subscriptions that have been quoted and captures the result of Quote acceptance. An **Invoice** results from the agreement to make a purchase. It includes items and costs, as well as payment conditions. An Invoice might include **Credits** as adjustments to the Invoice, reducing the final amount due.\n\nFor example, you might have an Account with Acme, Inc. During the sales process, your team has interacted with John, Paul, and Janis, who are now Contacts. John and Paul are in the Construction Bill Group, while Janis is in the Demolition Bill Group, reflecting their organization's structure and different payment policies. Once Janis requests a Quote for Offering A, your team adds that Offering to her Subscription. A Contract is included to specify the parameters of customer support limitations for onboarding. When Janis agrees to the purchase, your team generates an Invoice, including Credits for participation in a webinar.\n\n### Bill Day and Invoices\n\nEach **Bill Group** has a **Bill Day** field. Bill Day specifies the day of the month on which **Invoices** will be generated. Bill Day defaults to the day on which the Bill Group was created unless you specify an alternate number in the Bill Day field.\n\n### Quotes and Future Start Dates\n\nYou might set the **Start Date** of a **Quote** to a future date, maybe to align with your customer's budgeting process. That date automatically applies to the associated **Contract**. In this case, both the Contract and the quoted **Subscriptions** remain in a Pending state until the Start Date.\n\n### Payment Methods\n\nThe **Payment Methods** available to a **Bill Group** represent the payment service providers you have integrated with your MonetizeNow tenant. Payments made through integrated gateways are reflected in **Payment** records credited to the Bill Group.\n\n# Sample Workflows\n\n## Sending Usage/Consumption Data\n\nSending Usage Events to the MonetizeNow Usage Service requires calls to both the CPQ/Billing API and the Usage API. Here's a basic workflow:\n\n| Task | Call |\n| --- | --- |\n| Get Subscriptions for Account | GET /api/accounts/{accountId}/subscriptions |\n| Determine which Usage Types apply to each Subscription |  |\n| Post usage Events by Subscription | POST /events |\n\n# Object Life Cycles\n\n## Quotes\n\nThe Quote life cycle depends on whether the request for a new quote is actually a renewal or amendment of an existing quote. Event for a customer who has ordered before, any difference in the underlying contract makes a the new quote route necessary. The following diagram outlines the differences in the life cycles of new quotes and renewals.\n\n<img src=\"https://i.ibb.co/YyFztCC/Quote-Life-Cycle.png\">\n\n<!-- stackedit_data:<br>eyJoaXN0b3J5IjpbLTE0ODQxMzYzMzksLTExMDMyOTg1MzEsMT<br>M2MTI2MDY3MywtMTUwMTM1NjU1NywzODU3MzI2OTAsMjA1NTI2<br>NDUzMywtMjE0Mjk1NDY3NCwtMzYzNzk4NzAyLC0xNTEyNzQ4OD<br>Q2XX0=<br> -->"
servers:
- url: https://api.monetizeplatform.com
tags:
- name: Payment
  description: Payment is an object that represents an amount paid to an invoice.
paths:
  /api/accounts/{accountId}/billGroups/{billGroupId}/invoices/pay:
    post:
      tags:
      - Payment
      summary: Pay all invoices of a bill group
      description: Endpoint to pay all invoices of a bill group
      operationId: payAllInvoicesByBillGroup
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
      - name: billGroupId
        in: path
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      responses:
        '201':
          description: Create Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.payment.dto.payment.PaymentListDto'
        '400':
          description: Bad Request
        '500':
          description: Internal server error. Please contact the support team.
  /api/accounts/{accountId}/payments:
    get:
      tags:
      - Payment
      summary: Retrieve payments for an invoice
      description: Endpoint to retrieve payments for an invoice by account
      operationId: retrievePayments
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
          example: acct_m0CB9LflojZxytfC
        example: acct_m0CB9LflojZxytfC
      - name: id
        in: query
        schema:
          type: string
          example: paymt_4tNy5UtdAtnSD7Nd
      - name: collectionDate
        in: query
        schema:
          type: string
          example: '2022-04-13'
      - name: amount
        in: query
        schema:
          type: string
          example: 1000
      - name: paymentStatus
        in: query
        schema:
          type: string
          example: PENDING
      - name: paymentType
        in: query
        schema:
          type: string
          example: Monthly
      - name: paymentGatewayId
        in: query
        schema:
          type: string
          example: pmgw_MSCkYBrfDEFN1
      - name: gatewayCustomerId
        in: query
        schema:
          type: string
          example: cus_SPMgUFAFNNwMsw
      - name: sort
        in: query
        schema:
          type: string
          example: id
      - name: currentPage
        in: query
        schema:
          type: string
          example: 1
      - name: pageSize
        in: query
        schema:
          type: string
          example: 20
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      responses:
        '201':
          description: 'Object list retrieved '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.payment.dto.payment.PaymentListDto'
        '400':
          description: Bad Request
        '500':
          description: Internal server error. Please contact the support team.
  /api/accounts/{accountId}/payments/invoice/{invoiceId}/pay:
    post:
      tags:
      - Payment
      summary: Pay an invoice
      description: Endpoint to pay an invoice
      operationId: payInvoice
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
          example: acct_m0CB9LflojZxytfC
        example: acct_m0CB9LflojZxytfC
      - name: invoiceId
        in: path
        required: true
        schema:
          type: string
          example: invce_3oUtURRnJJ8Afdw0
        example: invce_3oUtURRnJJ8Afdw0
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.monytyz.billing.payment.dto.payment.ApplyPaymentToInvoiceDto'
        required: true
      responses:
        '201':
          description: Create Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.payment.dto.payment.PaymentDto'
        '400':
          description: Bad Request
        '500':
          description: Internal server error. Please contact the support team.
  /api/accounts/{accountId}/payments/invoice/{invoiceId}/pay/manual:
    post:
      tags:
      - Payment
      summary: Pay an invoice using manually payment
      description: Endpoint to pay an invoice using manually payment
      operationId: invoiceManualPayment
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
          example: acct_m0CB9LflojZxytfC
        example: acct_m0CB9LflojZxytfC
      - name: invoiceId
        in: path
        required: true
        schema:
          type: string
          example: invce_3oUtURRnJJ8Afdw0
        example: invce_3oUtURRnJJ8Afdw0
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.monytyz.billing.payment.dto.payment.ManualPaymentSaveDto'
        required: true
      responses:
        '201':
          description: Create Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.payment.dto.payment.PaymentDto'
        '400':
          description: Bad Request
        '500':
          description: Internal server error. Please contact the support team.
  /api/accounts/{accountId}/payments/manual/{paymentId}:
    put:
      tags:
      - Payment
      summary: Update Manual Payment
      description: Update reference number, description or payment date of a manual payment
      operationId: updateManualPayment
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
          example: acct_m0CB9LflojZxytfC
        example: acct_m0CB9LflojZxytfC
      - name: paymentId
        in: path
        required: true
        schema:
          type: string
          example: pymt_xgAOiEhQZWgY2
        example: pymt_xgAOiEhQZWgY2
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.monytyz.billing.payment.dto.payment.UpdateManualPaymentDto'
        required: true
      responses:
        '200':
          description: Update Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.payment.dto.payment.PaymentDetailDto'
        '404':
          description: Resource not found by Id
        '500':
          description: Internal server error. Please contact the support team.
  /api/accounts/{accountId}/payments/{paymentId}:
    get:
      tags:
      - Payment
      summary: Retrieve payment by id
      description: Endpoint to retrieve payment by id
      operationId: retrievePaymentById
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
          example: acct_m0CB9LflojZxytfC
        example: acct_m0CB9LflojZxytfC
      - name: paymentId
        in: path
        required: true
        schema:
          type: string
          example: pmt_EMfbqn56S9h9CweL
        example: pmt_EMfbqn56S9h9CweL
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      responses:
        '201':
          description: Get object by id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.payment.dto.payment.PaymentDto'
        '404':
          description: Resource not found by Id
        '500':
          description: Internal server error. Please contact the support team.
  /api/payments/{paymentId}/print:
    get:
      tags:
      - Payment
      operationId: printPayment_1
      parameters:
      - name: Accept
        in: header
        required: false
        schema:
          type: string
          default: application/pdf
      - name: paymentId
        in: path
        required: true
        schema:
          type: string
          example: pmt_EMfbqn56S9h9CweL
        example: pmt_EMfbqn56S9h9CweL
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      responses:
        '200':
          description: Payment PDF by ID
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '404':
          description: Resource not found by Id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.common.dto.ResponseDto'
        '500':
          description: Internal server error. Please contact the support team.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.common.dto.ResponseDto'
  /api/payments/{paymentId}/refund:
    post:
      tags:
      - Payment
      summary: Refund a payment
      description: Endpoint to refund a payment
      operationId: paymentRefund_1
      parameters:
      - name: paymentId
        in: path
        required: true
        schema:
          type: string
          example: pmt_m0CB9LflojZxytfC
        example: pmt_m0CB9LflojZxytfC
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.monytyz.billing.payment.dto.refund.RefundInitiateDto'
        required: true
      responses:
        '201':
          description: Create Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.payment.dto.refund.RefundDto'
        '400':
          description: Bad Request
        '404':
          description: Resource not found by Id
        '500':
          description: Internal server error. Please contact the support team.
      deprecated: true
components:
  schemas:
    com.monytyz.billing.payment.dto.payment.ManualPaymentSaveDto:
      required:
      - amount
      - paymentDate
      type: object
      properties:
        amount:
          minimum: 0
          type: number
          description: Amount of the payment
          example: 1000
        paymentDate:
          type: string
          description: Date of the payment
          format: date
          example: '2022-04-25'
        referenceNo:
          type: string
          description: Customer reference number for the payment
          example: '12345'
        description:
          type: string
          description: Description of the payment
          example: USW's Manual Payment
    com.monytyz.billing.payment.dto.refund.RefundInitiateDto:
      required:
      - amount
      - reason
      type: object
      properties:
        amount:
          type: number
          description: Amount to refund
          example: 100
          exclusiveMinimum: 0
        reason:
          type: string
          description: Reason for the refund. Value can be BILLING_ERROR, SERVICE_ISSUE, CANCELLATION, ADJUSTMENT or OTHER
          example: OTHER
          deprecated: true
          enum:
          - BILLING_ERROR
          - SERVICE_ISSUE
          - CANCELLATION
          - ADJUSTMENT
          - OTHER
        otherReason:
          type:
          - string
          - 'null'
          description: Description for the other reason. Only applicable when reason is OTHER
          example: Voiding Invoice
    com.monytyz.billing.transactable.dto.SourceApplicationSummary:
      required:
      - amount
      - applicationDate
      - targetId
      - targetType
      - type
      type: object
      properties:
        targetId:
          $ref: '#/components/schemas/com.monytyz.billing.transactable.TargetId'
        targetType:
          $ref: '#/components/schemas/com.monytyz.billing.transactable.model.enums.TargetType'
        amount:
          type: number
        type:
          type: string
          enum:
          - APPLICATION
          - UNAPPLICATION
        applicationDate:
          type: string
          format: date-time
      description: All application(s) of the credit note
    com.monytyz.billing.payment.dto.payment.ApplyPaymentToInvoiceDto:
      required:
      - amount
      type: object
      properties:
        paymentMethodId:
          type: string
          description: Unique identifier for the payment method
          example: pmtm_m0CB9LflojZxytfC
        amount:
          type: number
          description: Amount of the payment
          example: 5000
    com.monytyz.billing.payment.dto.payment.UpdateManualPaymentDto:
      type: object
      properties:
        referenceNo:
          type: string
          description: Customer reference number for the payment
          example: '12345'
        description:
          type: string
          description: Description of the payment
          example: USW's Manual Payment
        paymentDate:
          type: string
          description: Date of the payment
          format: date
          example: '2022-04-25'
    com.monytyz.billing.common.dto.ResponseDto:
      type: object
      properties:
        status:
          type: integer
          format: int32
        message:
          type: string
    com.monytyz.billing.payment.dto.payment.PaymentListDto:
      required:
      - content
      - totalElements
      - totalPages
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/com.monytyz.billing.payment.dto.payment.PaymentDto'
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int32
        pageable:
          $ref: '#/components/schemas/MNPageable'
    com.monytyz.billing.transactable.TargetId:
      required:
      - value
      type: object
      properties:
        value:
          type: string
    com.monytyz.billing.customer.dto.account.AccountSummary:
      required:
      - accountType
      - id
      - isTestAccount
      - status
      type: object
      properties:
        id:
          type: string
        customId:
          type: string
        isTestAccount:
          type: boolean
        locale:
          type: string
        accountName:
          type: string
        defaultCurrency:
          type: string
          enum:
          - AUD
          - BYN
          - CAD
          - CNY
          - DKK
          - EUR
          - GBP
          - INR
          - ISK
          - MYR
          - NOK
          - SEK
          - SGD
          - TWD
          - USD
        status:
          type: string
          enum:
          - ACTIVE
          - CANCELED
          - SUSPENDED
          - INACTIVE
        accountType:
          type: string
          enum:
          - CUSTOMER
          - PARTNER
        defaultLegalEntityId:
          type: string
    MNPageable:
      required:
      - pageNumber
      - pageSize
      type: object
      properties:
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
    com.monytyz.billing.payment.dto.refund.RefundDto:
      required:
      - amount
      - createDate
      - createdBy
      - currency
      - externalId
      - id
      - lastModifiedBy
      - modifyDate
      - paymentId
      - reason
      - status
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the refund
          example: rfnd_sf232ljhwlC232kB
        externalId:
          type: string
          description: Reference of the unique identifier for the refund on the payment gateway
          example: re_3MRkCmBXyD37Yf5R1cKHdKyp
        paymentId:
          type: string
          description: Unique identifier for the payment
          example: pmt_m0CB9LflojZxytfC
        amount:
          type: number
          description: Amount to refund
          example: 100
        status:
          type: string
          description: Status of the refund. Status can be SUCCEEDED, PENDING, FAILED or CANCELED
          example: SUCCEEDED
          enum:
          - SUCCEEDED
          - PENDING
          - FAILED
          - CANCELED
        reason:
          type: string
          description: Reason for the refund. Value can be BILLING_ERROR, SERVICE_ISSUE, CANCELLATION, ADJUSTMENT or OTHER
          example: OTHER
          deprecated: true
          enum:
          - BILLING_ERROR
          - SERVICE_ISSUE
          - CANCELLATION
          - ADJUSTMENT
          - OTHER
        otherReason:
          type: string
          description: Description for the other reason. Only applicable when reason is OTHER
          example: Voiding Invoice
        errorCode:
          type: string
          description: Error code for the refund failure
          example: resource_missing
        errorMessage:
          type: string
          description: Error message for the refund failure
          example: 'No such charge: ''ch_1IuuJABXyD37Yf5RC6bEdN3'''
        createdBy:
          type: string
          description: Identifier for the user who created the record
          example: usr_bPlPK7Xl4g36MCg4
        createDate:
          type: string
          description: Timestamp of when the record was created
          format: date-time
        lastModifiedBy:
          type: string
          description: Identifier for the user who last modified the record
          example: usr_bPlPK7Xl4g36MCg4
        modifyDate:
          type: string
          description: Timestamp of when the record was last modified
          format: date-time
        currency:
          type: string
          description: Currency for the refund
          example: USD
          enum:
          - AUD
          - BYN
          - CAD
          - CNY
          - DKK
          - EUR
          - GBP
          - INR
          - ISK
          - MYR
          - NOK
          - SEK
          - SGD
          - TWD
          - USD
    com.monytyz.billing.payment.dto.payment.PaymentDto:
      required:
      - currency
      - id
      type: object
      properties:
        createdBy:
          type: string
          description: Identifier for the user who created the record
          example: usr_X0XZ05bvkrB1RpLS
        createDate:
          type: string
          description: Timestamp of when the record was created
          format: date-time
        lastModifiedBy:
          type: string
          description: Identifier for the user who last modified the record
          example: usr_X0XZ05bvkrB1RpLS
        modifyDate:
          type: string
          description: Timestamp of when the record was last modified
          format: date-time
        id:
          type: string
          description: Unique identifier for the payment
          example: pmt_m0CB9LflojZxytfC
        paymentDate:
          type: string
          description: Date of the payment
          format: date
          example: '2022-04-13'
        currency:
          type: string
          description: Currency of the payment
          example: USD
          enum:
          - AUD
          - BYN
          - CAD
          - CNY
          - DKK
          - EUR
          - GBP
          - INR
          - ISK
          - MYR
          - NOK
          - SEK
          - SGD
          - TWD
          - USD
        account:
          $ref: '#/components/schemas/com.monytyz.billing.customer.dto.account.AccountSummary'
        collectionDate:
          type: string
          description: Date when the payment is settled
          format: date
          example: '2022-04-15'
          deprecated: true
        settledDate:
          type: string
          description: Date when the payment is settled
          format: date-time
        refundDate:
          type: string
          description: Date of the refund
          format: date
          example: '2022-04-25'
        voidDate:
          type: string
          description: Date when the payment is voided
          format: date
          example: '2022-04-25'
        description:
          type: string
          description: Description of the payment
          example: Monthly Payment
        paymentMethodId:
          type: string
          description: Unique identifier for the payment method
          example: pmtm_GDJKaum7vI9vf9tl
        gatewayId:
          type: string
          description: Unique identifier for the payment gateway
          example: pmtgw_EMfbqn56S9h9CweL
        gatewayReference:
          type: string
          description: Gateway reference for the payment. It can be charge id or payment intent id when the payment is successful and request id when the payment fails
          example: 4cd7-b4f4-a35ad60ad483
        gatewayCode:
          type: string
          description: Gateway error code when the payment fails
          example: a35ad60ad483
        gatewayMessage:
          type: string
          description: Gateway error message when the payment fails
          example: Gateway Connected Successfully
        amount:
          type: number
          description: Amount of the payment
          example: 100000000
        appliedAmount:
          type: number
          description: Applied amount for the payment
          example: 10000000
        unAppliedAmount:
          type: number
          description: Unapplied amount for the payment
          example: 100000
        fullyApplied:
          type: boolean
          description: A boolean field indicating that payment is fully applied or not
          example: true
        paymentStatus:
          type: string
          description: Status of the payment. Status can be SUCCESS, PROCESSING, FAILED, CANCELED, REFUNDED or PARTIAL_REFUND
          example: SUCCESS
          enum:
          - PROCESSING
          - SUCCESS
          - FAILED
          - CANCELED
          - REFUNDED
          - PARTIAL_REFUND
        paymentType:
          type: string
          description: Payment method type like CREDIT_CARD, DIRECT_DEBIT, ACH_CREDIT etc
          example: CREDIT_CARD
          enum:
          - CREDIT_CARD
          - DIRECT_DEBIT
          - ACH_CREDIT
          - US_BANK_TRANSFER
          - MANUAL
        referenceNo:
          type: string
          description: Customer reference number for the payment
          example: '12345'
        successfulOrProcessing:
          type: boolean
    com.monytyz.billing.payment.dto.payment.PaymentDetailDto:
      required:
      - account
      - currency
      - id
      type: object
      properties:
        createdBy:
          type: string
          description: Identifier for the user who created the record
          example: usr_X0XZ05bvkrB1RpLS
        createDate:
          type: string
          description: Timestamp of when the record was created
          format: date-time
        lastModifiedBy:
          type: string
          description: Identifier for the user who last modified the record
          example: usr_X0XZ05bvkrB1RpLS
        modifyDate:
          type: string
          description: Timestamp of when the record was last modified
          format: date-time
        id:
          type: string
          description: Unique identifier for the payment
          example: pmt_m0CB9LflojZxytfC
        paymentDate:
          type: string
          description: Date of the payment
          format: date
          example: '2022-04-13'
        currency:
          type: string
          description: Currency of the payment
          example: USD
          enum:
          - AUD
          - BYN
          - CAD
          - CNY
          - DKK
          - EUR
          - GBP
          - INR
          - ISK
          - MYR
          - NOK
          - SEK
          - SGD
          - TWD
          - USD
        account:
          $ref: '#/components/schemas/com.monytyz.billing.customer.dto.account.AccountSummary'
        settledDate:
          type: string
          description: Date when the payment is settled
          format: date-time
        refundDate:
          type: string
          description: Date of the refund
          format: date
          example: '2022-04-25'
        voidDate:
          type: string
          description: Date when the payment is voided
          format: date
          example: '2022-04-25'
        description:
          type: string
          description: Description of the payment
          example: Monthly Payment
        paymentMethodId:
          type: string
          description: Unique identifier for the payment method
          example: pmtm_GDJKaum7vI9vf9tl
        gatewayId:
          type: string
          description: Unique identifier for the payment gateway
          example: pmtgw_EMfbqn56S9h9CweL
        gatewayReference:
          type: string
          description: Gateway reference for the payment. It can be charge id or payment intent id when the payment is successful and request id when the payment fails
          example: 4cd7-b4f4-a35ad60ad483
        gatewayCode:
          type: string
          description: Gateway error code when the payment fails
          example: a35ad60ad483
        gatewayMessage:
          type: string
          description: Gateway error message when the payment fails
          example: Gateway Connected Successfully
        amount:
          type: number
          description: Amount of the payment
          example: 100000000
        appliedAmount:
          type: number
          description: Applied amount for the payment
          example: 10000000
        unAppliedAmount:
          type: number
          description: Unapplied amount for the payment
          example: 100000
        refundedAmount:
          type: number
          description: Amount of the payment that has been refunded
          example: 100000
        amountAppliedToInvoices:
          type: number
          description: Amount of the payment that has been applied to invoice(s)
          example: 100000
        fullyApplied:
          type: boolean
          description: A boolean field indicating that payment is fully applied or not
          example: true
        paymentStatus:
          type: string
          description: Status of the payment. Status can be SUCCESS, PROCESSING, FAILED, CANCELED, REFUNDED or PARTIAL_REFUND
          example: SUCCESS
          enum:
          - PROCESSING
          - SUCCESS
          - FAILED
          - CANCELED
          - REFUNDED
          - PARTIAL_REFUND
        paymentType:
          type: string
          description: Payment method type like CREDIT_CARD, DIRECT_DEBIT, ACH_CREDIT etc
          example: CREDIT_CARD
          enum:
          - CREDIT_CARD
          - DIRECT_DEBIT
          - ACH_CREDIT
          - US_BANK_TRANSFER
          - MANUAL
        referenceNo:
          type: string
          description: Customer reference number for the payment
          example: '12345'
        applications:
          type: array
          description: All application(s) of the payment
          items:
            $ref: '#/components/schemas/com.monytyz.billing.transactable.dto.SourceApplicationSummary'
    com.monytyz.billing.transactable.model.enums.TargetType:
      type: object