openapi: 3.2.0
info:
  title: Partner Swap Service Status API
  version: '2.0'
tags:
- name: Status
paths:
  /status:
    get:
      operationId: getStatus
      description: Returns the status of a quote / trade being executed.
      parameters:
      - name: swapId
        in: query
        required: true
        schema:
          type: string
        example: 1234
      responses:
        '200':
          description: Status of an executed swap transaction.
          x-summary: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
              example:
                status: PENDING
                amount: '1.337'
                payinTransactionId: '0xfffffffffffff'
                payoutTransactionId: '0xfffffffffffff'
                providerFees: '0.0001'
                referralFees: '0.0001'
                payoutNetworkFees: '0.0002'
        '404':
          description: Transaction not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorPayload'
              examples:
                TRANSACTION_NOT_FOUND:
                  summary: Transaction not found
                  value:
                    message: 'Provider error: Transaction with id 1234 does not exist.'
      tags:
      - Status
components:
  schemas:
    ErrorPayload:
      type: object
      properties:
        messageKey:
          type: string
          description: Error code.
        message:
          type: string
          description: Error message description.
        additionalFields:
          type: object
          description: Provides further details on the error, including specific amounts involved in the request. All amounts are presented in their respective currency units.
    Status:
      required:
      - status
      - amount
      - payinTransactionId
      - payoutTransactionId
      - providerFees
      - referralFees
      - payoutNetworkFees
      type: object
      properties:
        quoteId:
          type: string
        status:
          type: string
          enum:
          - FINISHED
          - EXPIRED
          - ON_HOLD
          - PENDING
          - REFUNDED
          - UNKNOWN
        amount:
          type: string
          description: as soon as this information is known, this should contain the final amount transferred to the user in output currency.
        payinTransactionId:
          type: string
          description: as soon as this information is known, this should contain the payin transaction hash.
        payoutTransactionId:
          type: string
          description: As soon as the transaction is submitted to the blockchain and the hash is generated, this field should contain the payout transaction hash.
        providerFees:
          type: string
          description: Fees paid to the provider.
        referralFees:
          type: string
          description: Fees paid to Ledger, as a referral fee.
        payoutNetworkFees:
          type: string
          description: Gas fees used for the payout transaction, converted to currencyTo.
  securitySchemes:
    defaultApiKey:
      type: apiKey
      name: x-api-key
      in: header