Guidewire Payments API

openapi: 3.1.0
info:
  title: Guidewire ClaimCenter Accounts Payments API
  description: Guidewire ClaimCenter REST API for P&C insurance claims management. Provides endpoints for first notice of loss (FNOL), claims assignment, investigation, coverage verification, reserving, payment processing, and claims closure.
  version: 1.0.0
  contact:
    name: Guidewire Developer Support
    url: https://community.guidewire.com/
  license:
    name: Guidewire License
    url: https://www.guidewire.com/
servers:
- url: https://{tenant}.guidewire.com/cc/rest/v1
  variables:
    tenant:
      default: yourcompany
      description: Your Guidewire Cloud tenant identifier
security:
- OAuth2: []
tags:
- name: Payments
  description: Claim payment and reserves
paths:
  /claims/{claimId}/payments:
    get:
      operationId: listClaimPayments
      summary: List claim payments
      description: Returns all payments (checks, EFTs) associated with a claim including status and payment details.
      tags:
      - Payments
      parameters:
      - name: claimId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Payments returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimPaymentList'
    post:
      operationId: createClaimPayment
      summary: Create claim payment
      description: Creates a new claim payment (check or EFT) for a specified payee and exposure.
      tags:
      - Payments
      parameters:
      - name: claimId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimPaymentRequest'
      responses:
        '201':
          description: Payment created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimPayment'
        '400':
          description: Invalid payment request
        '422':
          description: Reserve insufficient
components:
  schemas:
    ClaimPayment:
      type: object
      properties:
        id:
          type: string
        claimId:
          type: string
        paymentNumber:
          type: string
        status:
          type: string
          enum:
          - Requested
          - Approved
          - Issued
          - Voided
          - Stopped
        amount:
          type: number
          format: double
        currency:
          type: string
          default: USD
        paymentType:
          type: string
          enum:
          - Check
          - EFT
          - Wire
        payee:
          type: object
          properties:
            id:
              type: string
            displayName:
              type: string
        memo:
          type: string
        issueDate:
          type: string
          format: date
        createdDate:
          type: string
          format: date-time
    ClaimPaymentRequest:
      type: object
      required:
      - exposureId
      - amount
      - payeeId
      - paymentType
      properties:
        exposureId:
          type: string
        amount:
          type: number
          format: double
          minimum: 0.01
        payeeId:
          type: string
        paymentType:
          type: string
          enum:
          - Check
          - EFT
        memo:
          type: string
          maxLength: 255
    ClaimPaymentList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ClaimPayment'
        total:
          type: integer
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.guidewire.com/oauth/authorize
          tokenUrl: https://login.guidewire.com/oauth/token
          scopes:
            cc.claims.read: Read claim data
            cc.claims.write: Create and update claims
            cc.payments.write: Create claim payments
externalDocs:
  description: Guidewire ClaimCenter Documentation
  url: https://docs.guidewire.com/