Goodlord Payment API

openapi: 3.2.0
info:
  title: Insurance App Payment API
  description: Resource 'Payment' operations.
  version: 0.1.0
servers:
- url: https://insurance-app.goodlord.co/
  description: Development
- url: https://insurance-app.staging.goodoverlord.com/
  description: Staging
- url: https://insurance-app.qa1.goodoverlord.com/
  description: QA1
- url: https://insurance-app.demo.goodlord.co/
  description: Demo
security:
- JWT: []
tags:
- name: Payment
  description: Resource 'Payment' operations.
paths:
  /api/v1/insurance_claims/{insuranceClaimId}/payments:
    get:
      operationId: api_insurance_claims_insuranceClaimIdpayments_get_collection
      tags:
      - Payment
      responses:
        '200':
          description: Payment collection
          content:
            application/vnd.api+json:
              schema:
                description: Payment.jsonapi collection.
                allOf:
                - $ref: '#/components/schemas/JsonApiCollectionBaseSchema'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          type:
                            type: string
                          attributes:
                            $ref: '#/components/schemas/Payment'
                          relationships:
                            type: object
                            properties:
                              insuranceClaim:
                                properties:
                                  data:
                                    oneOf:
                                    - type: 'null'
                                    - type: object
                                      properties:
                                        type:
                                          type: string
                                        id:
                                          type: string
                                          format: iri-reference
                        required:
                        - type
                        - id
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Payment-payment.read'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Payment.csv-payment.read'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Error.jsonapi'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
      summary: Retrieves the collection of Payment resources.
      description: Retrieves the collection of Payment resources.
      parameters:
      - name: insuranceClaimId
        in: path
        description: Payment identifier
        required: true
        deprecated: false
        schema:
          type: string
        style: simple
        explode: false
      - name: page
        in: query
        description: The collection page number
        required: false
        deprecated: false
        schema:
          type: integer
          default: 1
        style: form
        explode: false
      - name: itemsPerPage
        in: query
        description: The number of items per page
        required: false
        deprecated: false
        schema:
          type: integer
          default: 50
          minimum: 0
          maximum: 100
        style: form
        explode: false
  /api/v1/insurance_claims/{insuranceClaimId}/payments/{id}:
    get:
      operationId: api_insurance_claims_insuranceClaimIdpayments_id_get
      tags:
      - Payment
      responses:
        '200':
          description: Payment resource
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Payment.jsonapi'
            application/json:
              schema:
                $ref: '#/components/schemas/Payment-payment.read'
            text/csv:
              schema:
                $ref: '#/components/schemas/Payment.csv-payment.read'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Error.jsonapi'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
        '404':
          description: Not found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Error.jsonapi'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
      summary: Retrieves a Payment resource.
      description: Retrieves a Payment resource.
      parameters:
      - name: insuranceClaimId
        in: path
        description: Payment identifier
        required: true
        deprecated: false
        schema:
          type: string
        style: simple
        explode: false
      - name: id
        in: path
        description: Payment identifier
        required: true
        deprecated: false
        schema:
          type: string
        style: simple
        explode: false
components:
  schemas:
    JsonApiCollectionBaseSchema:
      allOf:
      - $ref: '#/components/schemas/JsonApiCollectionBaseSchemaNoPagination'
      - type: object
        properties:
          links:
            type: object
            properties:
              first:
                type: string
                format: iri-reference
              prev:
                type: string
                format: iri-reference
              next:
                type: string
                format: iri-reference
              last:
                type: string
                format: iri-reference
            example:
              first: string
              prev: string
              next: string
              last: string
          meta:
            type: object
            properties:
              itemsPerPage:
                type: integer
                minimum: 0
              currentPage:
                type: integer
                minimum: 0
    JsonApiCollectionBaseSchemaNoPagination:
      type: object
      properties:
        links:
          type: object
          properties:
            self:
              type: string
              format: iri-reference
          example:
            self: string
        meta:
          type: object
          properties:
            totalItems:
              type: integer
              minimum: 0
        data:
          type: array
      required:
      - data
    Payment:
      type: object
      properties:
        id:
          readOnly: true
          type: string
        referenceNumber:
          readOnly: true
          type: string
        paymentStatusIdentifier:
          readOnly: true
          type: string
        paymentStatusDescription:
          readOnly: true
          type: string
        insurer:
          readOnly: true
          type:
          - string
          - 'null'
        paymentDate:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        paymentCreatedAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        paymentSubmittedAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        paymentPaidAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        refundDueAmount:
          readOnly: true
          type:
          - object
          - 'null'
          additionalProperties:
            anyOf:
            - type: integer
            - type: string
        customerPaymentUpdate:
          readOnly: true
          type:
          - string
          - 'null'
        paymentAmount:
          readOnly: true
          type:
          - object
          - 'null'
          additionalProperties:
            anyOf:
            - type: integer
            - type: string
        createdAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        insuranceClaim:
          readOnly: true
          type: string
          format: iri-reference
          example: https://example.com/
    RentSchedule:
      type: object
      properties:
        id:
          readOnly: true
          type: string
        submittedAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        syncedAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        deletedAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        createdAt:
          readOnly: true
          type: string
          format: date-time
        updatedAt:
          readOnly: true
          type: string
          format: date-time
        insuranceClaim:
          readOnly: true
          type: string
          format: iri-reference
          example: https://example.com/
        rentScheduleRows:
          readOnly: true
          type: array
          items:
            type: string
            format: iri-reference
            example: https://example.com/
    Payment.csv-payment.read:
      type: object
      properties:
        id:
          readOnly: true
          type: string
        referenceNumber:
          readOnly: true
          type: string
        paymentStatusIdentifier:
          readOnly: true
          type: string
        paymentStatusDescription:
          readOnly: true
          type: string
        insurer:
          readOnly: true
          type:
          - string
          - 'null'
        paymentDate:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        paymentCreatedAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        paymentSubmittedAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        paymentPaidAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        refundDueAmount:
          readOnly: true
          type:
          - object
          - 'null'
          additionalProperties:
            anyOf:
            - type: integer
            - type: string
        customerPaymentUpdate:
          readOnly: true
          type:
          - string
          - 'null'
        paymentAmount:
          readOnly: true
          type:
          - object
          - 'null'
          additionalProperties:
            anyOf:
            - type: integer
            - type: string
        createdAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        insuranceClaim:
          readOnly: true
          type: string
          format: iri-reference
          example: https://example.com/
    Company:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        externalId:
          type: string
    RentScheduleRowAuditGetDto:
      type: object
      properties:
        type:
          type: string
        text:
          type: string
        changedBy:
          type:
          - string
          - 'null'
        changedAt:
          type: string
          format: date-time
        changes:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
    RentSchedule.jsonapi:
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
            attributes:
              $ref: '#/components/schemas/RentSchedule'
            relationships:
              type: object
              properties:
                insuranceClaim:
                  properties:
                    data:
                      oneOf:
                      - type: 'null'
                      - type: object
                        properties:
                          type:
                            type: string
                          id:
                            type: string
                            format: iri-reference
                rentScheduleRows:
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                          id:
                            type: string
                            format: iri-reference
          required:
          - type
          - id
        included:
          description: Related resources requested via the "include" query parameter.
          type: array
          items:
            anyOf:
            - $ref: '#/components/schemas/InsuranceClaim.jsonapi'
            - $ref: '#/components/schemas/RentScheduleRow.jsonapi'
          readOnly: true
          externalDocs:
            url: https://jsonapi.org/format/#fetching-includes
    Payment.jsonapi:
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
            attributes:
              $ref: '#/components/schemas/Payment'
            relationships:
              type: object
              properties:
                insuranceClaim:
                  properties:
                    data:
                      oneOf:
                      - type: 'null'
                      - type: object
                        properties:
                          type:
                            type: string
                          id:
                            type: string
                            format: iri-reference
          required:
          - type
          - id
        included:
          description: Related resources requested via the "include" query parameter.
          type: array
          items:
            anyOf:
            - $ref: '#/components/schemas/InsuranceClaim.jsonapi'
          readOnly: true
          externalDocs:
            url: https://jsonapi.org/format/#fetching-includes
    InsuranceClaim:
      type: object
      properties:
        id:
          type: string
        externalId:
          type: string
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        propertyAddress:
          type: object
          additionalProperties:
            type:
            - string
            - 'null'
        claimStatus:
          type: string
        totalPaymentAmount:
          type: object
          additionalProperties:
            anyOf:
            - type: integer
            - type: string
        claimReference:
          type: string
        firstArrearsDate:
          type:
          - string
          - 'null'
          format: date-time
        mediationResponse:
          type:
          - string
          - 'null'
        claimStatusDescription:
          type: string
        claimDate:
          type: string
          format: date-time
        policyId:
          type: integer
        company:
          type: string
          format: iri-reference
          example: https://example.com/
        tenancyId:
          type:
          - string
          - 'null'
        legalStatus:
          type:
          - string
          - 'null'
        latestPaymentDate:
          type:
          - string
          - 'null'
          format: date-time
        solicitorsClaimReference:
          type:
          - string
          - 'null'
        firmInstructed:
          type:
          - string
          - 'null'
        dateLegalInstructed:
          type:
          - string
          - 'null'
          format: date-time
        section8DateServed:
          type:
          - string
          - 'null'
          format: date-time
        section8DateExpired:
          type:
          - string
          - 'null'
          format: date-time
        section21DateServed:
          type:
          - string
          - 'null'
          format: date-time
        section21DateExpired:
          type:
          - string
          - 'null'
          format: date-time
        dateProceedingsIssued:
          type:
          - string
          - 'null'
          format: date-time
        dateOfHearing:
          type:
          - string
          - 'null'
          format: date-time
        court:
          type:
          - string
          - 'null'
        hearingOutcome:
          type:
          - string
          - 'null'
        possessionDate:
          type:
          - string
          - 'null'
          format: date-time
        warrantsAppliedFor:
          type:
          - string
          - 'null'
        dateOfEviction:
          type:
          - string
          - 'null'
          format: date-time
        typeOfClaim:
          type:
          - string
          - 'null'
        rentScheduleStatus:
          type:
          - string
          - 'null'
        rentSchedule:
          type:
          - string
          - 'null'
          format: iri-reference
          example: https://example.com/
        files:
          type:
          - array
          - 'null'
          items:
            type: string
            format: iri-reference
            example: https://example.com/
        payments:
          type: array
          items:
            type: string
            format: iri-reference
            example: https://example.com/
        rpiUniqueReferenceNumber:
          type:
          - string
          - 'null'
        agencyName:
          type:
          - string
          - 'null'
        agentName:
          type:
          - string
          - 'null'
        agencyEmail:
          type:
          - string
          - 'null'
        agencyPhone:
          type:
          - string
          - 'null'
        lettingAgentRegistrationNumber:
          type:
          - string
          - 'null'
        tenants:
          type:
          - array
          - 'null'
          items:
            type: object
            additionalProperties:
              type:
              - string
              - 'null'
        guarantors:
          type:
          - array
          - 'null'
          items:
            type: object
            additionalProperties:
              type:
              - string
              - 'null'
        landlords:
          type:
          - array
          - 'null'
          items:
            type: object
            additionalProperties:
              type:
              - string
              - 'null'
        landlordRegistrationNumber:
          type:
          - string
          - 'null'
        permittedOccupiersName:
          type:
          - string
          - 'null'
        isTenancyCreatedOnGoodlord:
          type:
          - string
          - 'null'
        isTenancyRemovedAndNowOnFixedTerm:
          type:
          - string
          - 'null'
        dateBecamePeriodic:
          type:
          - string
          - 'null'
          format: date-time
        referencingCompletedByGoodlord:
          type:
          - string
          - 'null'
        isGasAtProperty:
          type:
          - string
          - 'null'
        didUploadEpcToGoodlord:
          type:
          - string
          - 'null'
        dateEpcWasProvidedToTenant:
          type:
          - string
          - 'null'
          format: date-time
        howEpcWasGivenToTenant:
          type:
          - string
          - 'null'
        isEicrOnGoodlord:
          type:
          - string
          - 'null'
        depositType:
          type:
          - string
          - 'null'
        depositCollectedByGoodlord:
          type:
          - string
          - 'null'
        depositPaidBy:
          type:
          - string
          - 'null'
        dateDepositWasPaid:
          type:
          - string
          - 'null'
          format: date-time
        isDepositCertificateOnGoodlord:
          type:
          - string
          - 'null'
        dateDepositProtected:
          type:
          - string
          - 'null'
          format: date-time
        prescribedInformationGiven:
          type:
          - string
          - 'null'
        depositReplacementCoverLevel:
          type:
          - string
          - 'null'
        propertyRequiresLicense:
          type:
          - string
          - 'null'
        dateOfRentArrears:
          type:
          - string
          - 'null'
          format: date-time
        rentOutstanding:
          type:
          - object
          - 'null'
          additionalProperties:
            anyOf:
            - type: integer
            - type: string
        reasonForNonPayment:
          type:
          - string
          - 'null'
        tenantsInDebtRespiteScheme:
          type:
          - string
          - 'null'
        detailsOfBreach:
          type:
          - string
          - 'null'
        dateAwareOfBreach:
          type:
          - string
          - 'null'
          format: date-time
        worksBeingClaimedForDamage:
          type:
          - string
          - 'null'
        depositUsedFor:
          type:
          - string
          - 'null'
        datePropertyDamageIdentified:
          type:
          - string
          - 'null'
          format: date-time
        currentDisputeInfo:
          type:
          - string
          - 'null'
        dateAwareOfDispute:
          type:
          - string
          - 'null'
          format: date-time
        trespassOrNuisanceInfo:
          type:
          - string
          - 'null'
        dateAwareOfTrespassOrNuisance:
          type:
          - string
          - 'null'
          format: date-time
        isPropertyStillOccupied:
          type:
          - string
          - 'null'
        verificationTenantIsStillOccupyingProperty:
          type:
          - string
          - 'null'
        dateLastInspection:
          type:
          - string
          - 'null'
          format: date-time
        dateTenantVacated:
          type:
          - string
          - 'null'
          format: date-time
        isClaimAgainstDepositFinalisedByDepositScheme:
          type:
          - string
          - 'null'
        isClaimAgainstDepositReplacementFinalised:
          type:
          - string
          - 'null'
        amountAwardedForRentArrears:
          type:
          - object
          - 'null'
          additionalProperties:
            anyOf:
            - type: integer
            - type: string
        depositUseBreakdown:
          type:
          - string
          - 'null'
        howDepositClaimWasSettled:
          type:
          - string
          - 'null'
        depositReplacementUseBreakdown:
          type:
          - string
          - 'null'
        forwardingAddress:
          type:
          - string
          - 'null'
        agencyInstructedToReLet:
          type:
          - string
          - 'null'
        isPropertyAlreadyReLet:
          type:
          - string
          - 'null'
        dateNewTenancy:
          type:
          - string
          - 'null'
          format: date-time
        possessionNoticesServed:
          type:
          - string
          - 'null'
        otherNoticesServed:
          type:
          - string
          - 'null'
        disputesBetweenTenantAndLandlord:
          type:
          - string
          - 'null'
        detailsOfDisputesBetweenTenantAndLandlord:
          type:
          - string
          - 'null'
        otherRelevantClaimInfo:
          type:
          - string
          - 'null'
        noticesServedToLandlord:
          type:
          - string
          - 'null'
        agencyAccountName:
          type:
          - string
          - 'null'
        agencyAccountNumber:
          type:
          - string
          - 'null'
        agencySortCode:
          type:
          - string
          - 'null'
        remittanceEmail:
          type:
          - string
          - 'null'
        gasSafetyCertificates:
          type:
          - array
          - 'null'
          items:
            type: object
            additionalProperties:
              type:
              - string
              - 'null'
        howToRentGuides:
          type:
          - array
          - 'null'
          items:
            type: object
            additionalProperties:
              type:
              - string
              - 'null'
        tribunalNotificationDate:
          type:
          - string
          - 'null'
          format: date-time
        marketValueExplanation:
          type:
          - string
          - 'null'
        firstMonthRentRequestedViaGoodlord:
          type:
          - string
          - 'null'
        keysHandedOverDate:
          type:
          - string
          - 'null'
          format: date-time
        tenantOccupationDate:
          type:
          - string
          - 'null'
          format: date-time
        detailsOfAntiSocialBehaviour:
          type:
          - string
          - 'null'
        dateAwareOfAntiSocialBehaviour:
          type:
          - string
          - 'null'
          format: date-time
        rraInfoSheetIssueDate:
          type:
          - string
          - 'null'
          format: date-time
        rraInfoSheetIssueMethod:
          type:
          - string
          - 'null'
        statementOfTermsInTenancyAgreement:
          type:
          - string
          - 'null'
        statementOfTermsIssuedDate:
          type:
          - string
          - 'null'
          format: date-time
        statementOfTermsIssuedMethod:
          type:
          - string
          - 'null'
        firstMonthRentRequestedBeforeSigning:
          type:
          - string
          - 'null'
        firstMonthRentRequestedDate:
          type:
          - string
          - 'null'
          format: date-time
        originalTenancyStartDate:
          type:
          - string
          - 'null'
          format: date-time
    RentScheduleRow:
      type: object
      properties:
        audits:
          type: array
          items:
            $ref: '#/components/schemas/RentScheduleRowAuditGetDto'
        balance:
          readOnly: true
          description: API serialization - returns an array to avoid JSON:API wrapping of Money objects.
          type: object
          additionalProperties:
            anyOf:
            - type: integer
            - type: string
        id:
          readOnly: true
          type: string
        rowType:
          readOnly: true
          description: API serialization - returns the string value to avoid JSON:API wrapping of enums.
          type: string
        date:
          readOnly: true
          type: string
          format: date-time
        amount:
          type: object
          properties:
            amount:
              type: integer
              example: 123
            currency:
              type: string
              example: GBP
        note:
          readOnly: true
          type:
          - string
          - 'null'
        submittedAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        createdAt:
          readOnly: true
          type: string
          format: date-time
        updatedAt:
          readOnly: true
          type: string
          format: date-time
        deletedAt:
          readOnly: true
          type:
          - string
          - 'null'
          format: date-time
        rentSchedule:
          readOnly: true
          type:
          - string
          - 'null'
          format: iri-reference
          example: https://example.com/
        insuranceClaim:
          readOnly: true
          type:
          - string
          - 'null'
          format: iri-reference
          example: https://example.com/
        insuranceClaimId:
          readOnly: true
          type: string
        companyExternalId:
          readOnly: true
          description: 'Helper method for voter - gets company external ID directly from entity

            without creating a DTO (which can fail in certain test contexts).'
          type:
          - string
          - 'null'
    File.jsonapi:
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
            attributes:
              $ref: '#/components/schemas/File'
            relationships:
              type: object
              properties:
                insuranceClaim:
                  properties:
                    data:
                      oneOf:
                      - type: 'null'
                      - type: object
                        properties:
                          type:
                            type: string
                          id:
                            type: string
                            format: iri-reference
          required:
          - type
          - id
        included:
          description: Related resources requested via the "include" query parameter.
          type: array
          items:
            anyOf:
            - $ref: '#/components/schemas/InsuranceClaim.jsonapi'
          readOnly: true
          externalDocs:
            url: https://jsonapi.org/format/#fetching-includes
    InsuranceClaim.jsonapi:
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
            attributes:
              $ref: '#/components/schemas/InsuranceClaim'
            relationships:
              type: object
              properties:
                company:
                  properties:
                    data:
                      oneOf:
                      - type: 'null'
                      - type: object
                        properties:
                          type:
                            type: string
                          id:
                            type: string
                            format: iri-reference
                rentSchedule:
                  properties:
                    data:
                      oneOf:
                      - type: 'null'
                      - type: object
                        properties:
                          type:
                            type: string
                          id:
                            type: string
                            format: iri-reference
                files:
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                          id:
                            type: string
                            format: iri-reference
                payments:
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            typ

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/goodlord/refs/heads/main/openapi/goodlord-payment-api-openapi.yml