Oracle Fusion Cloud Applications Payments API

openapi: 3.2.0
info:
  title: Oracle Fusion Cloud Applications Oracle Fusion Common Features REST Absences Payments API
  description: REST APIs for Oracle Fusion Cloud Applications Common features, providing access to shared services such as attachments, flexfields, lookup types, roles, users, security, scheduled processes, announcements, and approval workflows used across all Fusion Cloud application pillars.
  version: 11.13.18.05
  contact:
    name: Oracle Support
    url: https://support.oracle.com
    email: support@oracle.com
  license:
    name: Oracle Cloud Services Agreement
    url: https://www.oracle.com/corporate/contracts/cloud-services/
  termsOfService: https://www.oracle.com/corporate/contracts/cloud-services/
servers:
- url: https://{instance}.oraclecloud.com
  description: Oracle Fusion Cloud Instance
  variables:
    instance:
      default: servername
      description: Your Oracle Cloud instance identifier
security:
- bearerAuth: []
tags:
- name: Payments
  description: Manage payment processing
paths:
  /fscmRestApi/resources/11.13.18.05/payablesPayments:
    get:
      operationId: listPayments
      summary: Oracle Fusion Cloud Applications List payments
      description: Retrieve a collection of accounts payable payments including check, electronic, and wire transfer payments.
      tags:
      - Payments
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/q'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/finder'
      responses:
        '200':
          description: Successful retrieval of payments
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Payment'
                  count:
                    type: integer
                  hasMore:
                    type: boolean
                  totalResults:
                    type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
  /fscmRestApi/resources/11.13.18.05/payablesPayments/{PaymentId}:
    get:
      operationId: getPayment
      summary: Oracle Fusion Cloud Applications Get a payment
      description: Retrieve a specific payment by its unique identifier.
      tags:
      - Payments
      parameters:
      - name: PaymentId
        in: path
        required: true
        description: Unique identifier for the payment
        schema:
          type: integer
      responses:
        '200':
          description: Payment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    limit:
      name: limit
      in: query
      required: false
      description: Maximum number of items to return (default 25, max 500)
      schema:
        type: integer
        default: 25
        maximum: 500
    fields:
      name: fields
      in: query
      required: false
      description: Comma-separated list of fields to include in the response. Use to limit returned attributes for performance.
      schema:
        type: string
    orderBy:
      name: orderBy
      in: query
      required: false
      description: Comma-separated list of fields to sort by. Append :asc or :desc for sort direction.
      schema:
        type: string
    offset:
      name: offset
      in: query
      required: false
      description: Number of items to skip before returning results
      schema:
        type: integer
        default: 0
    finder:
      name: finder
      in: query
      required: false
      description: Named finder to execute. Format is FinderName;param1=value1,param2=value2
      schema:
        type: string
    q:
      name: q
      in: query
      required: false
      description: 'Filter expression using Oracle REST query syntax. Example: InvoiceNumber=''INV-001'' or InvoiceAmount>1000'
      schema:
        type: string
  schemas:
    Payment:
      type: object
      properties:
        PaymentId:
          type: integer
          description: Unique payment identifier
        PaymentNumber:
          type: string
          description: Payment number
        PaymentAmount:
          type: number
          format: double
          description: Payment amount
        PaymentCurrencyCode:
          type: string
          description: Payment currency
        PaymentDate:
          type: string
          format: date
          description: Date of payment
        PaymentMethod:
          type: string
          description: Payment method (Check, Electronic, Wire)
        VendorName:
          type: string
          description: Payee name
        BusinessUnit:
          type: string
          description: Business unit
        BankAccountName:
          type: string
          description: Disbursement bank account
        Status:
          type: string
          description: Payment status
          enum:
          - Created
          - Set Up
          - Formatted
          - Transmitted
          - Confirmed
          - Voided
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: Error type URI
        title:
          type: string
          description: Short error description
        detail:
          type: string
          description: Detailed error message
        o:errorCode:
          type: string
          description: Oracle-specific error code
        o:errorDetails:
          type: array
          items:
            type: object
            properties:
              detail:
                type: string
              o:errorCode:
                type: string
  responses:
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication credentials are missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Oracle Fusion Cloud Applications Common Features REST API Documentation
  url: https://docs.oracle.com/en/cloud/saas/applications-common/26a/farca/index.html