openapi: 3.1.0
info:
  title: Workday Financials Workday Cash Management Account Reconciliations Payments API
  description: API for managing cash positions, bank accounts, transactions, and cash forecasting within Workday Cash Management.
  version: v38.2
  contact:
    name: Workday Support
    url: https://www.workday.com/en-us/company/latest/support.html
  termsOfService: https://www.workday.com/en-us/legal.html
servers:
- url: https://{tenant}.workday.com/api/cashManagement/v38.2
  description: Workday Cash Management Production
  variables:
    tenant:
      description: Workday tenant identifier
      default: your-tenant
security:
- bearerAuth: []
tags:
- name: Payments
  description: Manage payment processing
paths:
  /payments:
    get:
      operationId: listPayments
      summary: Workday Financials List payments
      description: Retrieve a collection of payments.
      tags:
      - Payments
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: status
        in: query
        description: Filter by payment status
        schema:
          type: string
          enum:
          - Pending
          - Approved
          - Processed
          - Canceled
      responses:
        '200':
          description: Payments retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Payment'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /payments/{id}:
    get:
      operationId: getPayment
      summary: Workday Financials Get a payment
      description: Retrieve details of a specific payment.
      tags:
      - Payments
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Payment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    BankAccountRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the bank account
        descriptor:
          type: string
          description: Display name of the bank account
    CurrencyRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the currency
        descriptor:
          type: string
          description: Currency code (e.g., USD, EUR)
    Payment:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the payment
        paymentNumber:
          type: string
          description: Payment reference number
        payee:
          type: string
          description: Payment recipient
        paymentDate:
          type: string
          format: date
          description: Date of the payment
        amount:
          type: number
          format: double
          description: Payment amount
        currency:
          $ref: '#/components/schemas/CurrencyRef'
        paymentMethod:
          type: string
          enum:
          - Check
          - ACH
          - Wire
          - EFT
          description: Method of payment
        status:
          type: string
          enum:
          - Pending
          - Approved
          - Processed
          - Canceled
          description: Payment status
        bankAccount:
          $ref: '#/components/schemas/BankAccountRef'
  parameters:
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
    resourceId:
      name: id
      in: path
      required: true
      description: Unique identifier of the resource (WID)
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        default: 20
        maximum: 100
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid
    NotFound:
      description: The requested resource was not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token obtained from Workday authentication
externalDocs:
  description: Workday Cash Management API Documentation
  url: https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html