openapi: 3.2.0
info:
  title: Hostfully Transactions API
  license:
    name: Apache 2.0
    url: https://www.hostfully.com/
  version: v3.0.1
servers:
- url: https://sandbox-api.hostfully.com
security:
- JWT-Authentication: []
- Agency-API-key: []
tags:
- name: Transactions
paths:
  /api/v3.3/transactions:
    get:
      tags:
      - Transactions
      summary: Get transactions for an order
      operationId: findAll_1
      parameters:
      - name: orderUid
        in: query
        description: The unique ID of the order related to transactions you want to retrieve
        required: true
        schema:
          type: string
      - name: createdSince
        in: query
        required: false
        schema:
          type: string
          example: '2023-09-28T10:31:01'
        example: '2023-09-28T10:31:01'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TransactionsApiResponseWrapper'
    post:
      tags:
      - Transactions
      summary: Create transaction for an order
      operationId: create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionAddingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TransactionApiResponseWrapper'
  /api/v3.3/transactions/{uid}:
    get:
      tags:
      - Transactions
      summary: Get transaction by unique ID
      operationId: findByUid
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TransactionApiResponseWrapper'
components:
  schemas:
    TransactionApiResponseWrapper:
      type: object
      properties:
        transaction:
          $ref: '#/components/schemas/TransactionApi3Dto'
    TransactionApi3Dto:
      type: object
      properties:
        uid:
          type: string
        transactionId:
          type: string
        createdZonedDateTime:
          type: string
          format: date-time
        type:
          type: string
          enum:
          - SALE
          - PAYMENT_METHOD_VERIFICATION
          - REFUND
          - SECURITY_DEPOSIT_CHARGE
          - SALE_MARKETPLACE
        amount:
          type: number
        manual:
          type: boolean
        referenceTransactionId:
          type: string
        notes:
          type: string
        errorMessage:
          type: string
        status:
          type: string
          enum:
          - SUCCESS
          - FAILURE
          - UNCAPTURED
        transactionFees:
          type: array
          items:
            $ref: '#/components/schemas/TransactionFeeApi3Dto'
        orderUid:
          type: string
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    TransactionsApiResponseWrapper:
      type: object
      properties:
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/TransactionApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    TransactionFeeApi3Dto:
      type: object
      properties:
        label:
          type: string
        amount:
          type: number
    TransactionAddingApi3Dto:
      required:
      - orderUid
      - status
      - type
      type: object
      properties:
        manual:
          type: boolean
          description: Determines whether the payment went through a payment processor or not. If 'manual' is false, then payment must've gone through a payment processor, so fields {type, status, transactionId} are required.
          default: true
        type:
          type: string
          enum:
          - SALE
          - PAYMENT_METHOD_VERIFICATION
          - REFUND
          - SECURITY_DEPOSIT_CHARGE
          - SALE_MARKETPLACE
        status:
          type: string
          enum:
          - SUCCESS
          - FAILURE
          - UNCAPTURED
        amount:
          type: number
          description: Amount of the transaction. Required when 'fullPayment' is not given or false.
        fullPayment:
          type: boolean
          description: If true, then the created transaction will have amount of remaining order balance.
        transactionId:
          type: string
          description: Required when 'manual' is false. Id of the transaction from payment processor.
        referenceTransactionId:
          type: string
          description: Can be specified only for transactions of type 'REFUND'. 'transactionId' of transaction that is refunded
        notes:
          type: string
        errorMessage:
          type: string
        orderUid:
          type: string
  securitySchemes:
    JWT-Authentication:
      type: apiKey
      description: OAuth Access Token
      name: Authorization
      in: header
    Agency-API-key:
      type: apiKey
      description: API Key
      name: X-HOSTFULLY-APIKEY
      in: header
externalDocs:
  description: Hostfully Documentation
  url: https://dev.hostfully.com/v3.0/reference
x-readme:
  explorer-enabled: true
  proxy-enabled: true