openapi: 3.1.0
x-stoplight:
  id: 2ebfdf5i46rfs
info:
  title: Coinsflow
  version: '1.0'
  contact:
    name: admin
  description: API documentation
servers:
  - url: https://api.coinsflow.ge
    description: Production
  - description: Sandbox
    url: https://api.sandbox.coinsflow.ge
paths:
  /deposits:
    post:
      summary: Deposit create
      operationId: post-payment.deposits
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    anyOf:
                      - $ref: '#/components/schemas/DirectDeposit'
                      - $ref: '#/components/schemas/DirectDepositQR'
        '500':
          $ref: '#/components/responses/BadRequest'
      requestBody:
        $ref: '#/components/requestBodies/DirectDeposit'
      description: >-
        This call allows you to create a deposit with the desired amount and the
        desired cryptocurrency (asset).
      tags:
        - deposit
      parameters: []
      x-stoplight:
        id: k5cc245cmg9xl
  /deposits/{id}:
    parameters:
      - schema:
          type: string
          format: uuid
        name: id
        in: path
        required: true
        description: >-
          This parameter allows you to insert the unique code and identifies the
          deposit you want to get the information.
    get:
      summary: Deposit details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DirectDeposit'
        '404':
          $ref: '#/components/responses/BadRequest'
      operationId: get-payment.deposit-by-id
      description: This call allows you to get the information on a specific deposit.
      tags:
        - deposit
      x-stoplight:
        id: z2ancmzbnj3jz
    post:
      summary: Update Deposit
      operationId: post-deposits-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDeposit'
      requestBody:
        $ref: '#/components/requestBodies/DirectDepositUpdate'
      description: >-
        This call allows you to add an external id to a deposit. Keep in mind
        that this is a one time operation and is only possible if it was null
        during deposit creation. After adding an externalID you can't change it
        again.
      tags:
        - deposit
      x-stoplight:
        id: bet2gmp0mo8z3
  /deposits/tx/{hash}:
    parameters:
      - schema:
          type: string
        name: hash
        in: path
        required: true
        description: >-
          This parameter allows you to insert the unique Tx Hash and identifies
          the deposit you want to get the information.
    get:
      summary: Deposit details by Tx Hash
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DirectDeposit'
        '404':
          $ref: '#/components/responses/BadRequest'
      operationId: get-payment.deposit-by-txHash
      description: >-
        This call allows you to get the information on a specific deposit based
        off of it’s Tx Hash.
      tags:
        - deposit
      x-stoplight:
        id: tct3mwf2vjz4g
  /payouts:
    post:
      summary: Payout create
      operationId: post-crypto.payouts
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Payout-create'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/BadRequest'
      description: >-
        This call allows you to create a payout with the desired cryptocurrency
        (asset), and, optionally, to auto exchange an asset you have on your
        balance for the one you want to pay out.
      tags:
        - payout
      requestBody:
        $ref: '#/components/requestBodies/PayoutCreate'
      x-stoplight:
        id: auhor72yoak9i
    parameters: []
    get:
      summary: Payout list
      operationId: get-crypto.payouts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Payout'
      tags:
        - payout
      description: This Call allows you to get a list of all Payouts
      x-stoplight:
        id: fwk1z62s6nykx
  /payouts/estimate:
    get:
      summary: Payout estimate
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      totalFee:
                        type: string
                      totalAmount:
                        type: string
                      withdrawFee:
                        type: string
                      networkFee:
                        type: string
                      netAmount:
                        type: string
                        x-stoplight:
                          id: ae9it0h88q0ot
                      asset:
                        $ref: '#/components/schemas/AssetEntity'
                        x-stoplight:
                          id: ofxo7rhtbvxco
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/BadRequest'
      operationId: get-crypto.payouts-estimate
      parameters:
        - schema:
            type: string
            format: uuid
          in: query
          name: asset
          required: true
          description: >-
            This parameter allows you to indicate the  crypto currency in which
            the payout is to be made. The asset is provided by the unique code
            that identifies it (if you don't have the asset's code, contact our
            support).
        - schema:
            type: string
          in: query
          name: destination
          required: true
          description: >-
            This parameter allows you to indicate the address to where the
            payout is to be made.
        - schema:
            type: string
          in: query
          name: amount
          description: This parameter specifies amount to be payed out.
        - schema:
            type: boolean
          in: query
          name: exchange
          description: >-
            This parameter determines if the payout requires an asset exchange
            before being processed.
        - schema:
            type: string
          in: query
          name: requestedAsset
          description: >-
            This parameter specifies the target asset that the `asset` should be
            exchanged to.
      description: >-
        This call allows you to get an estimate on the fees applicable to a
        specific address to a specific location.
      tags:
        - payout
      x-stoplight:
        id: q56jbzhx3u3d2
    parameters: []
  /payouts/{id}:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Payout'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/BadRequest'
      parameters: []
      summary: Payout details
      description: This call provides information on the indicated payout.
      operationId: get-crypto.payouts-by-id
      tags:
        - payout
      x-stoplight:
        id: 1iifvuukjw79q
    parameters:
      - schema:
          type: string
          format: uuid
        name: id
        in: path
        required: true
        description: >-
          This parameter, added as part of the URL, allows you to single out the
          desired payout you want information on.
  /payouts/batch/csv:
    post:
      summary: Mass payout create
      operationId: post-payouts-batch-csv
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  Example 1:
                    data:
                      id: 8d05ea22-87c6-4730-80c3-407d1c81b688
                      title: test title
                      createdAt: 03-08-2023 11:24:00
                      itemsCount: '1'
                      status: PENDING
                properties:
                  data:
                    $ref: '#/components/schemas/Batch'
      tags:
        - payout
      description: >-
        This call allows you to create several payouts at the same time with the
        desired cryptocurrency (asset).


        **Important:** This endpoint only accepts
        `application/x-www-form-urlencoded` content type. 

        The `data` parameter must contain CSV data with actual line breaks (not
        `\n` escape sequences).
      requestBody:
        $ref: '#/components/requestBodies/MassPayoutCreate'
      x-stoplight:
        id: k2qiro86md5z6
  /payouts/batch:
    get:
      summary: Payout batch list
      tags:
        - payout
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: string
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Batch'
      operationId: get-payouts-batch
      description: >-
        This call allows you to get a list of batches (it can be customized by
        title and\or period).
      parameters:
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - schema:
            type: string
            format: date
          in: query
          name: from
          description: >-
            This parameter indicates the start date and time for the list to be
            filtered.
        - schema:
            type: string
            format: date
          in: query
          name: to
          description: >-
            This parameter indicates the end date and time for the list to be
            filtered.
        - schema:
            type: string
          in: query
          name: search
          description: This parameter indicates the keyword to search on the title field.
        - schema:
            type: string
            enum:
              - id
              - itemsCount
              - status
              - createdAt
              - title
            default: createdAt
          in: query
          name: orderField
          description: >-
            This parameter indicates the field used to order the entries on the
            list.
        - schema:
            type: string
            enum:
              - ASC
              - DESC
            default: DESC
          in: query
          name: order
          description: >-
            This parameter indicates the orientation (ascending or descending)
            of the entries on the list (based on the selected orderField.)
      x-stoplight:
        id: 48qkg90qbg8v9
  /payouts/batch/{batchId}/items:
    parameters:
      - schema:
          type: string
          format: uuid
        name: batchId
        in: path
        required: true
    get:
      summary: Payout batch item list
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  Example 1:
                    total: 1
                    data:
                      - id: 456e9eda-25c7-4723-be9f-901d8d31acd7
                        status: SUCCESS
                        asset:
                          id: 3d11bb60-d8d4-4198-b966-6d8eb6dbf4e8
                          name: Ethereum Test
                          symbol: ETH_TEST
                          displayName: Ethereum Test
                          displaySymbol: ETH_TEST
                          exchangeSymbol: ETH
                          type: CRYPTO
                          subType: BASE_ASSET
                          contract: null
                          decimals: 18
                          network: ETH_TEST3
                        destination: '0x92009d7A79d3813DD3309e663d3a77844EF675C4'
                        amount: '0.001000000000000000'
                        createdAt: 03-08-2023 11:24:00
                        treatAsGrossAmount: false
                        operationLog:
                          operationId: 150bc049-1afa-430d-a759-400858a050b1
                          refId: 4CEA64CB8E7ED39D
                          asset: ETH_TEST
                          amount: '0.001'
                          status: FAILED
                          subStatus: null
                          createdAt: 03-08-2023 11:24:46
                          clientEmail: null
                          assetFrom: null
                          amountFrom: null
                          children: []
                          type: PAYOUT
                        batch:
                          id: fa41e4d7-f6cb-42b6-a18a-320567978c18
                          title: test h
                          createdAt: 03-08-2023 11:24:00
                          itemsCount: '1'
                          status: SUCCESS
                    batch:
                      id: fa41e4d7-f6cb-42b6-a18a-320567978c18
                      title: test title
                      createdAt: 03-08-2023 11:24:00
                      itemsCount: '1'
                      status: SUCCESS
                properties:
                  total:
                    type: integer
                    description: This parameter displays the amount of payouts listed.
                  data:
                    type: array
                    description: Payout object
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: >-
                            This parameter displays the unique code that
                            identifies the payout operation.
                          format: uuid
                        status:
                          type: string
                          description: >-
                            This parameter displays the status of the payout
                            operation.
                          enum:
                            - APPROVAL
                            - APPROVED
                            - PROGRESS
                            - REJECTED
                            - SUCCESS
                            - FAILED
                        asset:
                          $ref: '#/components/schemas/AssetEntity'
                          description: >-
                            This parameter displays the crypto currency
                            associated with the balance.
                        destination:
                          type: string
                          description: >-
                            This parameter displays the address for the payout
                            operation.
                        amount:
                          type: string
                          description: >-
                            This parameter displays the amount of the crypto
                            currency that will be used on the payout operation.
                        createdAt:
                          type: string
                          format: date-time
                          description: >-
                            This parameter displays the time and date the payout
                            operation was created.
                        treatAsGrossAmount:
                          type: boolean
                          description: >-
                            This parameter indicates if the network fee is
                            deducted from the requested amount (set as True) or
                            from your account (set as False, by default). This
                            allows you to define who is charged with the network
                            fee (the payout receiver or you).
                        operationLog:
                          $ref: '#/components/schemas/OperationLog'
                        batch:
                          $ref: '#/components/schemas/Batch'
                  batch:
                    $ref: '#/components/schemas/Batch'
      operationId: get-payouts-batch-batchId-items
      tags:
        - payout
      description: This call allows you to get a list of entries of the inserted batch.
      parameters:
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - schema:
            type: string
            format: date
          in: query
          name: from
          description: >-
            This parameter indicates the start date and time for the list to be
            filtered.
        - schema:
            type: string
            format: date
          in: query
          name: to
          description: >-
            This parameter indicates the end date and time for the list to be
            filtered.
        - schema:
            type: string
          in: query
          name: search
          description: >-
            This parameter indicates the keyword to search on the destination
            address field.
        - schema:
            type: string
            enum:
              - createdAt
              - id
              - amount
              - asset
              - destination
              - status
              - treatAsGrossAmount
            default: createdAt
          in: query
          name: orderField
          description: >-
            This parameter indicates the field used to order the entries on the
            list.
        - schema:
            type: string
            enum:
              - ASC
              - DESC
            default: DESC
          in: query
          name: order
          description: >-
            This parameter indicates the orientation (ascending or descending)
            of the entries on the list (based on the selected orderField.)
      x-stoplight:
        id: vv785dqz0jpm9
    post:
      summary: Add Mass Payout Item
      operationId: post-payouts-batch-batchId-items
      responses:
        '200':
          description: OK
      description: Adds a new entry within a MassPayout Batch that is pending approval
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: string
                  x-stoplight:
                    id: 6ebwsk680cmn9
                  description: >-
                    This parameter displays the amount of the crypto currency
                    that will be used on the payout operation.
                destination:
                  type: string
                  x-stoplight:
                    id: 9skx9wjcunuta
                  description: >-
                    This parameter displays the address for the payout
                    operation.
                treatAsGrossAmount:
                  type: string
                  x-stoplight:
                    id: bsuwr3waoc4aq
                  description: >-
                    This parameter indicates if the network fee is deducted from
                    the requested amount (set as True) or from your account (set
                    as False, by default). This allows you to define who is
                    charged with the network fee (the payout receiver or you).
                externalId:
                  type: string
                  x-stoplight:
                    id: 69z1h9dtm2ipm
                  description: >-
                    This parameter allows you to insert an Internal ID (from
                    your own system) to better keep track of these operations.
                asset:
                  type: string
                  x-stoplight:
                    id: soqenm9g39bxb
                  description: >-
                    This parameter displays the crypto currency associated with
                    the balance.
        description: ''
      tags:
        - payout
      x-stoplight:
        id: y87rbba3wt7xn
  /payouts/batch/{batchId}/items/{payoutBatchItemId}:
    parameters:
      - schema:
          type: string
          format: uuid
        name: batchId
        in: path
        required: true
      - schema:
          type: string
        name: payoutBatchItemId
        in: path
        required: true
    delete:
      summary: Delete Mass Payout Item
      operationId: delete-payouts-batch-batchId-items-itemId
      responses:
        '200':
          description: OK
      tags:
        - payout
      description: Deletes a single entry from a MassPayout Batch that is pending approval
      x-stoplight:
        id: zohgzqkmejnxh
    post:
      summary: Edit Mass Payout Item
      operationId: post-payouts-batch-batchId-items-payoutBatchItemId
      responses:
        '200':
          description: OK
      description: >-
        Changes the parameters of an Item within a MassPayout Batch that is
        pending approval. Parameters with “Inhereted” next to them must remain
        the same as the original Item within the Batch.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: string
                  x-stoplight:
                    id: 1i81egcj41r4d
                  description: >-
                    This parameter displays the amount of the crypto currency
                    that will be used on the payout operation.
                asset:
                  type: string
                  x-stoplight:
                    id: wa54qfskby4ae
                  description: >-
                    (Inherited) This parameter displays the crypto currency
                    associated with the balance.
                destination:
                  type: string
                  x-stoplight:
                    id: udvf8poxqodzp
                  description: >-
                    This parameter displays the address for the payout
                    operation.
                treasAsGrossAmount:
                  type: string
                  x-stoplight:
                    id: utws272bu6uc7
                  description: >-
                    This parameter indicates if the network fee is deducted from
                    the requested amount (set as True) or from your account (set
                    as False, by default). This allows you to define who is
                    charged with the network fee (the payout receiver or you).
                rowNumber:
                  type: string
                  x-stoplight:
                    id: gxgd85tbqlgvh
                  description: >-
                    (Inherited) This parameter displays the exact row within the
                    Mass Payout for this Item
                externalId:
                  type: string
                  x-stoplight:
                    id: y9irvn1one4yp
                  description: >-
                    This parameter allows you to insert an Internal ID (from
                    your own system) to better keep track of these operations.
        description: ''
      tags:
        - payout
      x-stoplight:
        id: podw3tzhkgyz8
  /exchange:
    post:
      summary: Exchange create
      operationId: exchange.exchange-create
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Exchange'
        '400':
          $ref: '#/components/responses/BadRequest'
      requestBody:
        $ref: '#/components/requestBodies/Exchange'
      tags:
        - exchange
      description: >-
        This call allows you to create an exchange operation between a specific
        crypto currency (with a determined amount) to another crypto currency.
      x-stoplight:
        id: lzt3dsgdn1pr0
    get:
      summary: Exchange list
      operationId: exchange.exchange-list
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Exchange'
      description: This Call allows you to get a list of all Exchanges
      tags:
        - exchange
      x-stoplight:
        id: kngkyxg5n1s1x
  /exchange/estimate:
    get:
      summary: Exchange estimate
      tags:
        - exchange
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ExchangeEstimate'
        '400':
          $ref: '#/components/responses/BadRequest'
      operationId: exchange.exchange-estimate
      description: >-
        This call allows you to estimate the cost of an exchange with an amount
        of a crypto currency into another cryptocurrency and freeze the rate for
        2 minutes.
      parameters:
        - in: query
          name: fromAsset
          description: >-
            This parameter allows you to determine the crypto currency from what
            the determined amount will be converted from.
          required: true
          schema:
            type: string
            format: uuid
        - in: query
          name: toAsset
          description: >-
            This parameter allows you to determine the crypto currency to what
            the amount of the from crypto currency will be converted to.
          required: true
          schema:
            type: string
            format: uuid
        - in: query
          name: amount
          description: >-
            This parameter allows you to determine the amount of the crypto
            currency that will be converted into another crypto currency.
          required: true
          schema:
            type: string
            format: uuid
        - schema:
            type: boolean
          in: query
          name: freezeRate
          description: >-
            This parameter allows you to freeze the exchange rate you receive
            and use it in exchanges for the next 2 minutes.
        - schema:
            type: string
          in: query
          name: freezeRateId
          description: >-
            This parameter allows you to check if a frozen exchange rate you
            estimated previously is still applicable.
      x-stoplight:
        id: m4h8f1kz19y1r
  /exchange/pairs:
    get:
      summary: Exchange pairs list
      tags:
        - exchange
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExchangePair'
        '400':
          $ref: '#/components/responses/BadRequest'
      operationId: exchange.exchange-pair
      description: >-
        This call allows you to get a list of all pairs of crypto currencies
        available for conversion.
      requestBody:
        $ref: '#/components/requestBodies/ExchangePairList'
      parameters:
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
      x-stoplight:
        id: k68zuwd5auzbv
  /exchange/rate:
    get:
      summary: Exchange rate
      tags:
        - exchange
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ExchangeRate'
        '400':
          $ref: '#/components/responses/BadRequest'
      operationId: exchange.exchange-rate
      description: >-
        This call allows you to get the rate of conversion between a pair of
        crypto currencies.
      parameters:
        - schema:
            type: string
          in: query
          name: amount
          description: >-
            This parameter allows you to determine the amount of the crypto
            currency that will be converted into another crypto currency.
          required: true
        - schema:
            type: string
            format: uuid
          in: query
          name: fromAsset
          description: >-
            This parameter allows you to determine the crypto currency from what
            the determined amount will be converted from.
          required: true
        - schema:
            type: string
            format: uuid
          in: query
          name: toAsset
          required: true
          description: >-
            This parameter allows you to determine the crypto currency to what
            the amount of the from crypto currency will be converted to.
        - schema:
            type: string
          in: query
          name: externalId
          description: >-
            This parameter allows you to insert an Internal ID (from your own
            system) to better keep track of these operations.
        - schema:
            type: string
            format: uuid
          in: query
          name: accountId
          description: >-
            This parameter allows you to insert an Account ID if this operation
            is related to an Account.
        - schema:
            type: string
            format: uuid
          in: query
          name: freezeRateId
          description: >-
            This parameter allows you to insert a freeze id provided by the
            /estimate endpoint. If a frozen exchange rate with such id exists,
            this exchange rate will be used instead of the current exchange
            rate.
      x-stoplight:
        id: ucs3tkpct9xmw
  /exchange/rates:
    get:
      summary: Exchange rates
      tags:
        - exchange
      parameters:
        - name: assets
          in: query
          style: form
          explode: true
          useBrackets: true
          description: >-
            This parameter allows you to indicate the several assets for which
            you want to get the rates.
          schema:
            type: array
            items:
              type: string
              format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ExchangeRates'
                    x-stoplight:
                      id: okv9jita1mboq
              examples:
                Multiple Currencies Example:
                  value:
                    data:
                      BNB:
                        source: FineryMarkets
                        date: '2024-11-20 09:23:08'
                        value: '615.32'
                        liquidity: '0.00'
                      ETH:
                        source: FineryMarkets
                        date: '2024-11-20 09:23:08'
                        value: '3133.33'
                        liquidity: '0.00'
                      TON:
                        source: FineryMarkets
                        date: '2024-11-20 09:23:08'
                        value: '5.4556'
                        liquidity: '0.00'
                      TRY:
                        source: FineryMarkets
                        date: '2024-11-20 09:23:08'
                        value: '0.03'
                        liquidity: '0.00'
                      USDT:
                        source: FineryMarkets
                        date: '2024-11-20 09:23:08'
                        value: '1.002'
                        liquidity: '0.00'
        '400':
          $ref: '#/components/responses/BadRequest'
      operationId: exchange.exchange-rates
      description: >-
        This call allows you to get the rates for available assets. You can add
        several assets, inside an array, to get the rate for all at once.
      x-stoplight:
        id: 0ht4yus2bvxy5
  /checkouts:
    get:
      summary: Payment link list
      operationId: get-payment.checkouts
      description: This call allows you to get a list of payment links created.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    description: >-
                      This parameter displays the amount of payment links
                      listed.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Checkout'
              examples:
                Example 1:
                  value:
                    total: 0
                    data:
                      - id: c5f077df-9294-4ec7-b0b0-ff814a5960ad
                        name: test name
                        description: some description
                        amount: '10.12'
                        currency: USD
                        assets: []
                        createdAt: '2000-01-01T00:00:00+00:00'
      parameters:
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
      tags:
        - payment link
      x-stoplight:
        id: jsvluj31o89oa
    parameters: []
    post:
      summary: Payment link create
      operationId: post-payment_link
      responses:
        '201':
          description: Created
        '400':
          $ref: '#/components/responses/BadRequest'
      tags:
        - payment link
      description: This call allows you to create a payment link.
      requestBody:
        $ref: '#/components/requestBodies/PaymentLinkCreate'
      x-stoplight:
        id: kaclticda37kg
  /balances:
    get:
      parameters:
        - schema:
            type: string
            format: uuid
          name: asset
          in: query
          required: false
          description: >-
            To be used alongside "wallet" parameter. This parameter takes an
            asset’s ID and isolates the results shown only to that asset
        - schema:
            type: string
          name: wallet
          in: query
          required: false
          description: >-
            This parameter takes a "dedicated wallet’s" address to return back
            the available balance only within that particular wallet. If
            utilized alongside "asset" will limit the results further to show
            only that particular asset’s balance within the dedicated wallet
        - schema:
            type: integer
            default: 20
          name: limit
          in: query
          required: false
          description: This parameter limits the number of results returned.
        - schema:
            type: integer
            default: 0
          name: offset
          in: query
          required: false
          description: This parameter sets the starting position of the results returned.
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          name: order
          in: query
          required: false
          description: >-
            This parameter sets the sort order of the results by available
            balance.
      summary: Balance list
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    description: >-
                      This parameter displays the amount of balances (1 per
                      crypto currency) listed.
                    example: 1
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Balance'
      operationId: get-crypto.balances
      description: >-
        This call allows you to get a list of crypto currencies balances.
        Further filtering for dedicated wallet specific balances is possible via
        the "Query" parameters section.
      tags:
        - balance
      x-stoplight:
        id: aipdprcyp3uhp
  /balances/{id}:
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: >-
          This parameter, added as part of the URL, allows you to single out the
          desired balance you want information on.
    get:
      summary: Balance details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BalanceDetails'
        '400':
          $ref: '#/components/responses/BadRequest'
      operationId: get-crypto.balances.id
      parameters:
        - schema:
            type: string
          in: query
          name: network
          required: true
          description: >-
            This parameter, added as part of the query, allows you to indicate
            the desired network in which the balance is available.
      description: This call allows you to get the balance of a crypto currency.
      tags:
        - balance
      x-stoplight:
        id: g0f3sz7zz3beo
  /balances/logs:
    get:
      summary: Balance log list
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BalanceLogDetails'
      operationId: get-crypto.balances.logs
      description: >-
        This call allows you to get a list of logs of crypto currencies
        balances.
      tags:
        - balance
      x-stoplight:
        id: vmumr3f0bj6ou
  /balances/logs/{id}:
    parameters:
      - schema:
          type: string
          format: uuid
        name: id
        in: path
        required: true
        description: >-
          This parameter, added as part of the URL, allows you to single out the
          desired log's balance you want information on.
    get:
      summary: Balance log details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BalanceLogDetails'
      operationId: get-crypto.balances.log.id
      description: This call allows you to get the logs of a crypto currencies balance.
      parameters:
        - schema:
            type: string
          in: query
          name: network
          required: true
          description: >-
            This parameter, added as part of the query, allows you to indicate
            the desired network where the log's balance is available.
      tags:
        - balance
      x-stoplight:
        id: yhqm06q5w2i3m
  /operations:
    get:
      summary: Operation log
      tags:
        - merchant
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    description: |
                      This parameter displays the amount of operations listed.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OperationLog'
      operationId: get-operations
      description: |
        This call allows you to get the logs of operations.
      requestBody:
        $ref: '#/components/requestBodies/OperationList'
      parameters:
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - schema:
            type: string
          in: cookie
      x-stoplight:
        id: snkplzcjzet3x
  /operations/{id}:
    get:
      summary: Operation Details
      tags:
        - merchant
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OperationLog'
        '404':
          $ref: '#/components/responses/BadRequest'
      operationId: get-operation
      description: >
        This call returns the current state of an Operation, based on the given
        Reference ID.
      parameters: []
      x-stoplight:
        id: sc95dobtdzrj5
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
  /assets:
    get:
      summary: Asset list
      tags:
        - merchant
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Asset'
              examples:
                Example 1:
                  value:
                    data:
                      - id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
                        network: ETH_TEST3
                        name: USD Coin Test (Goerli)
                        symbol: USDC_TEST3
                        contract: '0x07865c6E87B9F70255377e024ace6630C1Eaa37F'
                        decimals: 6
                        active: true
      operationId: get-assets
      parameters:
        - schema:
            type: boolean
          in: query
          name: active
          description: >-
            This parameter allows you to filter the list by active, inactive or
            all crypto currencies.
        - schema:
            type: string
            enum:
              - CRYPTO
              - FIAT
          in: query
          name: type
          description: >-
            Determines which type of assets should be displayed in the response,
            if no value is given, the default is all asset types.
      description: >-
        This call allows you to get the list of available assets based on the
        list of assets configured on your account.
      x-stoplight:
        id: jh265fqg5bb12
    parameters: []
  /assets/{id}:
    parameters:
      - schema:
          type: string
          format: uuid
        name: id
        in: path
        required: true
        description: >-
          This parameter, added as part of the URL, allows you to single out the
          desired crypto currency you want information on.
    get:
      summary: Asset details
      tags:
        - merchant
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Asset'
              examples:
                Example 1:
                  value:
                    data:
                      id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
                      network: ETH_TEST3
                      name: USD Coin Test (Goerli)
                      symbol: USDC_TEST3
                      contract: '0x07865c6E87B9F70255377e024ace6630C1Eaa37F'
                      decimals: 6
                      active: true
        '404':
          $ref: '#/components/responses/BadRequest'
      operationId: get-assets-id
      description: This call allows you to get information on a specific asset.
      x-stoplight:
        id: qnf0bpe5q8t1b
    post:
      summary: Asset enable
      operationId: post-assets-id
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Asset'
        '400':
          $ref: '#/components/responses/BadRequest'
      description: >-
        This call allows you to enable a disabled crypto currency on your
        account.
      tags:
        - merchant
      x-stoplight:
        id: rji804zwezdjt
    delete:
      summary: Asset disable
      operationId: delete-assets-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      asset:
                        type: string
                        format: uuid
        '400':
          $ref: '#/components/responses/BadRequest'
      description: >-
        This call allows you to disable an active crypto currency on your
        account.
      tags:
        - merchant
      x-stoplight:
        id: l6rbieeoyxc0n
  /exchange/auto:
    get:
      summary: Auto exchange list
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExchangeAuto'
      operationId: exchange.auto-exchange-list
      description: This call allows you to get the list of auto exchange pairs
      tags:
        - merchant
      x-stoplight:
        id: 4vx2cefe8s1np
    post:
      summary: Enable auto exchange
      operationId: exchange.auto-exchange-enable
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ExchangeAuto'
        '400':
          $ref: '#/components/responses/BadRequest'
      requestBody:
        $ref: '#/components/requestBodies/ExchangeAuto'
      description: >-
        This call allows you to enable a disabled crypto currencies pair auto
        exchange on your account.
      tags:
        - merchant
      x-stoplight:
        id: dpqi4w73a6zvn
    delete:
      summary: Disable auto exchange
      operationId: exchange.auto-exchange-disable
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ExchangeAuto'
        '400':
          $ref: '#/components/responses/BadRequest'
      description: >-
        This call allows you to disable an active crypto currencies pair auto
        exchange on your account.
      tags:
        - merchant
      x-stoplight:
        id: of9nd124wspw5
  /reports/operations:
    post:
      summary: Reporting create
      description: >-
        This call allows you to generate reports. The generated report link is
        sent to the current user's email address.
      operationId: post-reporting.reports.operations
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/BadRequest'
      requestBody:
        $ref: '#/components/requestBodies/OperationReport'
      tags:
        - merchant
      x-stoplight:
        id: cdzii44wgmefi
  /callbacks/url:
    get:
      summary: Get callbacks url list
      operationId: get-callbacks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Callback'
      description: >-
        This call allows you to get the list of all callback urls (the
        configured urls where callbacks are received).
      tags:
        - callbacks
      x-stoplight:
        id: tnnqkzuhzdelq
    post:
      summary: Create callback url
      operationId: post-callbacks
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Callback'
      description: >
        This call allows you to create a callback url (configure an url where
        callbacks are received).
      requestBody:
        $ref: '#/components/requestBodies/Callback'
      tags:
        - callbacks
      x-stoplight:
        id: tkfkfef1qnzo9
    parameters: []
  /callbacks/url/{id}:
    parameters:
      - schema:
          type: string
          format: uuid
        name: id
        in: path
        required: true
        description: >-
          This parameter allows you to indicate the unique code that identifies
          the callback url.
    post:
      summary: Update specific callback url
      operationId: post-callbacks-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Callback'
      requestBody:
        $ref: '#/components/requestBodies/Callback'
      description: >
        This call allows you to edit and change a callback url (configure a url
        to receive callbacks).
      tags:
        - callbacks
      x-stoplight:
        id: m1xef5fxa1uvx
    delete:
      summary: Delete specific callback url
      operationId: delete-callbacks-id
      responses:
        '204':
          description: No Content
      description: >-
        This call allows you to delete a callback url (a configured url where
        callbacks are received).



        `Note: callbacks are soft deleted to preserve log integrity`
      tags:
        - callbacks
      x-stoplight:
        id: q9l15g36dtuto
  /callbacks:
    get:
      summary: List callbacks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CallbackQueue'
              examples:
                Example 1:
                  value:
                    count: 3
                    data:
                      - id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
                        project: 9ec8a81a-31b2-4a83-bcd8-cef9150932d2
                        scope: DEPOSIT
                        event: CREATED
                        payload: >-
                          {"scope":"DEPOSIT","event":"STATUS_UPDATED","project":"1d6e80e6-6016-4736-90c4-9e047e00423a","data":{"id":"b69f68a3-9e97-42b6-a728-1977f6841909","asset":{"id":"c21f664c-d2a1-4b41-9564-25e3dcde497c","name":"Litecoin
                          Test","symbol":"LTC_TEST","displayName":"Litecoin
                          Test","displaySymbol":"LTC_TEST","exchangeSymbol":"LTC","type":"CRYPTO","subType":"BASE_ASSET","token":false,"contract":null,"nativeAsset":"LTC_TEST","decimals":8,"network":"LTC_TEST"},"amount":"0.003424501459681069","targetAmount":null,"wallet":"tltc1qar05t4myq978esl36mv7ca3c6czmzq57azymkz","status":"PAID","network":"LTC_TEST","expireAt":"2023-06-20T08:58:50+00:00","createdAt":"2023-06-20T08:28:50+00:00","updatedAt":[],"operationLog":{"operationId":"b69f68a3-9e97-42b6-a728-1977f6841909","refId":"4CEA649163424E46","asset":"USDC_TEST3","amount":"0.26424735458973054","status":"SUCCESS","subStatus":null,"createdAt":"20-06-2023
                          08:28:50","clientEmail":null,"assetFrom":"LTC_TEST","amountFrom":"0.003424501459681069","children":[]},"toAsset":{"id":"585c16ca-d438-4ef6-bcd2-a6d5ff685af4","name":"USD
                          Coin Test
                          (Goerli)","symbol":"USDC_TEST3","displayName":"USD
                          Coin Test
                          (Goerli)","displaySymbol":"USDC_TEST3","exchangeSymbol":"USDC","type":"CRYPTO","subType":"ERC20","token":true,"contract":"0x07865c6E87B9F70255377e024ace6630C1Eaa37F","nativeAsset":"ETH_TEST3","decimals":6,"network":"ETH_TEST3"}}}
                        status: QUEUED
                        retries: 0
                        createdAt: '2019-08-24T14:15:22Z'
                        url:
                          id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
                          project: 9ec8a81a-31b2-4a83-bcd8-cef9150932d2
                          url: string
                          active: true
                          createdAt: '2019-08-24T14:15:22Z'
                          updatedAt: '2019-08-24T14:15:22Z'
                      - id: da94a6cc-ce61-46a5-a202-a1513ea53059
                        project: eb64e8ab-1b77-46f1-8832-656390775df5
                        scope: PAYOUT
                        event: STATUS_UPDATED
                        payload: >-
                          {"scope":"PAYOUT","event":"STATUS_UPDATED","project":"e4093193-fded-446a-81f7-5622e8f18d27","data":{"amount":"1.000000000000000000","id":"60347da7-5f1e-4df5-96fa-709d2a3f46b2","createdAt":"2023-06-22T14:13:20+00:00","updatedAt":"2023-06-22T14:13:26+00:00"}}
                        status: QUEUED
                        retries: 2
                        createdAt: '2023-06-22T14:13:27+00:00'
                        url:
                          id: d67cfc97-a2a4-4ab0-95f8-8d51ea5782f0
                          project: e346d697-7df3-4d6e-802a-6ef0e75320d6
                          url: https://example.com/webhook
                          active: true
                          createdAt: '2023-06-12T20:00:41+00:00'
                          updatedAt: '2023-06-16T16:33:09+00:00'
                      - id: e18e991b-a61d-4b22-bf17-e38efb98bb7e
                        project: 449329be-1e53-4f9d-bc78-5c905dcfb5ba
                        scope: EXCHANGE
                        event: STATUS_UPDATED
                        payload: >-
                          {"scope":"EXCHANGE","event":"STATUS_UPDATED","project":"b27c56f5-faec-4dfc-b052-aba10e49ec22","data":{"id":"b56316ee-0ffc-444a-a42b-0090cae8620e","initiator":"MANUAL","fromAsset":{"id":"0b47a85e-a66a-461c-bb1a-e818def2ff82","name":"Ethereum
                          Test
                          (Goerli)","symbol":"ETH_TEST3","displayName":"Ethereum
                          Test","displaySymbol":"ETH_TEST","exchangeSymbol":"ETH","type":"CRYPTO","subType":"BASE_ASSET","token":false,"contract":null,"nativeAsset":"ETH_TEST3","decimals":18,"network":"ETH_TEST3"},"toAsset":{"id":"585c16ca-d438-4ef6-bcd2-a6d5ff685af4","name":"USD
                          Coin Test
                          (Goerli)","symbol":"USDC_TEST3","displayName":"USD
                          Coin
                          Test","displaySymbol":"USDC_TEST","exchangeSymbol":"USDC","type":"CRYPTO","subType":"ERC20","token":true,"contract":"0x07865c6E87B9F70255377e024ace6630C1Eaa37F","nativeAsset":"ETH_TEST3","decimals":6,"network":"ETH_TEST3"},"fromAmount":"0.001000000000000000","toAmount":"1.853773621693822884","status":"SUCCESS","createdAt":"2023-06-22T14:16:09+00:00","updatedAt":null}}
                        status: SUCCESS
                        retries: 0
                        createdAt: '2023-06-22T14:16:13+00:00'
                        url:
                          id: d67cfc97-a2a4-4ab0-95f8-8d51ea5782f0
                          project: 75d4eb3f-b491-4763-acc3-054a5895e27b
                          url: https://example.com/webhook
                          active: true
                          createdAt: '2023-06-12T20:00:41+00:00'
                          updatedAt: '2023-06-16T16:33:09+00:00'
      operationId: get-callbacks-queue
      parameters:
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - schema:
            type: string
            enum:
              - QUEUED
              - FAILED
              - SUCCESS
          in: query
          name: status
          description: >-
            This parameter allows you to filter the list by items status
            (queued, failed or success).
      description: |
        This call allows you to get the list of all callbacks.
      tags:
        - callbacks
      x-stoplight:
        id: kk0dsr9h4q0lx
    parameters: []
  /callbacks/resend/failed:
    post:
      summary: Schedule to resend all failed callbacks
      operationId: post-callbacks-queue-resend-failed
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: >
                      This parameters displays the amount of affected queues
                      (with callbacks rescheduled).
      description: |
        This call allows you to try to resend all callbacks with failed status.
      tags:
        - callbacks
      x-stoplight:
        id: baugrx97f8yt2
    parameters: []
  /callbacks/resend/{id}:
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: >-
          This parameter displays the unique code that identifies the callback
          to resend.
    post:
      summary: Schedule to resend callbacks by id
      operationId: post-callbacks-queue-resend-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CallbackQueue'
              examples:
                Example 1:
                  value:
                    data:
                      id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
                      project: 9ec8a81a-31b2-4a83-bcd8-cef9150932d2
                      scope: DEPOSIT
                      event: CREATED
                      status: QUEUED
                      retries: 0
                      createdAt: '2019-08-24T14:15:22Z'
                      callback:
                        id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
                        project: 9ec8a81a-31b2-4a83-bcd8-cef9150932d2
                        url: string
                        active: true
                        createdAt: '2019-08-24T14:15:22Z'
                        updatedAt: '2019-08-24T14:15:22Z'
      description: This call allows you to try to resend a specific callback (by id).
      tags:
        - callbacks
      x-stoplight:
        id: 5f4qa6jj7aow4
  /callbacks/log:
    get:
      summary: List callback logs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: |
                      This parameters displays the amount callbacks on the list.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CallbackLog'
      operationId: get-callbacks-log
      parameters:
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
      description: |
        This call allows you to list all callbacks.
      tags:
        - callbacks
      x-stoplight:
        id: 8p6ke6edpn7li
  /topups/{id}:
    get:
      parameters:
        - schema:
            type: string
            format: uuid
          name: id
          in: path
          required: true
          description: >-
            This parameter, added as part of the URL, allows you to single out
            the desired topup you want information on.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/TopUp'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/BadRequest'
      summary: Top Up details
      description: This call provides information on the indicated topup.
      operationId: topup-by-id
      x-stoplight:
        id: 3k824zvnt5swq
      tags:
        - top up
  /settlements/{id}:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Settlement'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/BadRequest'
      summary: Settlement details
      parameters:
        - schema:
            type: string
            format: uuid
          name: id
          in: path
          required: true
          description: >-
            This parameter, added as part of the URL, allows you to single out
            the desired settlement you want information on.
      description: This call provides information on the indicated settlement.
      operationId: settlement-by-id
      x-stoplight:
        id: dueglz2sk2gnm
      tags:
        - top up
  /orders/deposit:
    post:
      summary: Create an order with a deposit
      operationId: post-payment.order-deposits
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DirectDeposit'
        '500':
          $ref: '#/components/responses/BadRequest'
      requestBody:
        $ref: '#/components/requestBodies/OrderDeposit'
      description: This call allows you to create an order with a deposit.
      parameters: []
      x-stoplight:
        id: 918hzbr29etp3
      tags:
        - deposit
  /orders:
    post:
      summary: Create an Order
      operationId: post-orders
      tags:
        - order
      requestBody:
        $ref: '#/components/requestBodies/CreateOrder'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Order'
      x-stoplight:
        id: m2iqs12kxczlr
    get:
      summary: List of orders
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    description: |
                      This parameter displays the amount of orders listed.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Order'
      operationId: get-orders
      description: |
        This call allows you to get the list of orders.
      parameters:
        - in: query
          name: search
          description: Search by refId
          required: false
          schema:
            type: string
        - in: query
          name: orderField
          type: string
          description: >-
            This parameter allows you to indicate the order field to filter the
            list. Default createdAt.
          schema:
            type: string
            enum:
              - amount
              - paidAmount
              - asset
              - createdAt
              - clientEmail
              - status
              - createdAt
          required: false
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - $ref: '#/components/parameters/order'
      x-stoplight:
        id: j0g0olvhxmhsj
      tags:
        - order
  /orders/{id}:
    parameters:
      - schema:
          type: string
          format: uuid
        name: id
        in: path
        required: true
        description: >-
          This parameter allows you to insert the unique code and identifies the
          order.
    get:
      summary: Order details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Order'
        '404':
          $ref: '#/components/responses/BadRequest'
      operationId: get-orders.order-by-id
      description: This call allows you to get the information on a specific order.
      x-stoplight:
        id: dqo2j6r510o1w
      tags:
        - order
  /orders/{id}/complete:
    parameters:
      - schema:
          type: string
          format: uuid
        name: id
        in: path
        required: true
        description: >-
          This parameter allows you to insert the unique code and identifies the
          order.
    post:
      summary: Mark Order as paid
      operationId: post-order-by-id.complete
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '500':
          $ref: '#/components/responses/BadRequest'
      description: This call allows you to mark an UNDERPAID order as paid.
      x-stoplight:
        id: 5prx0662ok0d9
      tags:
        - order
  /orders/{id}/deposit:
    parameters:
      - schema:
          type: string
          format: uuid
        name: id
        in: path
        required: true
        description: >-
          This parameter allows you to insert the unique code and identifies the
          order.
    post:
      summary: Create a deposit for the given order
      operationId: post-order-by-id.deposit
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                asset:
                  type: string
                  format: uuid
                  description: >
                    This parameter displays the unique code that identifies the
                    asset.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DirectDeposit'
        '500':
          $ref: '#/components/responses/BadRequest'
      description: >-
        This call allows you to create one more deposit address for the given
        order. Useful in case you have order in status UNDERPAID.
      tags:
        - deposit
      x-stoplight:
        id: a048soz3dopoh
components:
  schemas:
    Order:
      title: Order
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: >-
            This parameter displays the unique code that identifies the
            resource.
        amount:
          type: string
          description: This parameter displays the amount of the Order.
        asset:
          $ref: '#/components/schemas/Asset'
        description:
          type: string
          description: This parameter displays the description given to the Order.
        paidAmount:
          type: string
          description: This parameter displays the paid amount of the Order.
        clientEmail:
          type:
            - string
            - 'null'
          description: >
            This parameter displays the email address of the client involved on
            the transaction.
        externalId:
          type:
            - string
            - 'null'
          description: >-
            This parameter allows you to insert an Internal ID (from your own
            system) to better keep track of these operations.
        status:
          type: string
          enum:
            - CREATED
            - PENDING
            - PROCESSING
            - PAID
            - UNDERPAID
            - EXPIRED
            - FAILED
            - DEACTIVATED
          description: This parameter displays the status of the Order.
        operationLog:
          $ref: '#/components/schemas/OperationLog'
      x-stoplight:
        id: gmy2ymhpujady
    Checkout:
      title: Checkout
      x-stoplight:
        id: rfnpsxnx3x07d
      type: object
      examples:
        - id: c5f077df-9294-4ec7-b0b0-ff814a5960ad
          name: test name
          description: some description
          amount: '10.12'
          currency: USD
          assets: []
          createdAt: '2000-01-01T00:00:00+00:00'
      description: Checkout object
      properties:
        id:
          type: string
          format: uuid
          description: >-
            This parameter displays the unique code that identifies the payment
            link.
        name:
          type: string
          description: This parameter displays the name given to the payment link.
        description:
          type: string
          description: This parameter displays the description given to the payment link.
        amount:
          type: string
          description: This parameter displays the amount inserted on the payment link.
        currency:
          enum:
            - USD
            - EUR
          type: string
          description: >-
            This parameter displays the crypto currency of the amount inserted
            on the payment link.
        assets:
          type: array
          description: >-
            This parameter displays the selected crypto currency assigned to the
            amount.
          items: {}
        createdAt:
          type: string
          format: date-time
          description: >-
            This parameter displays the date and time the payment link was
            created.
    DirectDeposit:
      title: DirectDeposit
      x-stoplight:
        id: aw4jx4ypccgrc
      type: object
      description: DirectDeposit object
      examples:
        - id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
          asset:
            id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
            name: string
            symbol: string
          amount: '10.10'
          targetAmount: string
          wallet: string
          status: PENDING
          network: string
          expireAt: '2019-08-24T14:15:22Z'
          createdAt: '2019-08-24T14:15:22Z'
          updatedAt: '2019-08-24T14:15:22Z'
          toAsset:
            id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
            name: string
            symbol: string
      properties:
        id:
          type: string
          format: uuid
          description: >-
            This parameter displays the unique code that identifies the deposit
            operation.
        asset:
          type: object
          description: This parameter displays the crypto currency that will be deposited.
          properties:
            id:
              type: string
              format: uuid
              description: >-
                This parameter displays the unique code that identifies the
                crypto currency.
            name:
              type: string
              description: This parameter displays the name given to the crypto currency.
            symbol:
              type: string
              description: >-
                This parameter displays the symbol associated to the crypto
                currency.
        amount:
          type: string
          description: >-
            This parameter displays the amount of the crypto currency that will
            be deposited.
        targetAmount:
          type: string
          description: >-
            This parameter displays the specific amount of the crypto currency
            that will be deposited.
        wallet:
          type: string
          description: >-
            This parameter displays the wallet address where the crypto currency
            will be deposited.
        walletTag:
          type:
            - string
            - 'null'
          description: >-
            This parameter allows you to insert the unique numerical code,
            required by some blockchains, to pair with the deposit address, as
            an additional Security measure.
        status:
          type: string
          enum:
            - PENDING
            - PROGRESS
            - PAID
            - UNDERPAID
            - EXPIRED
            - FAILED
            - EXCHANGING
            - READY_TO_EXCHANGE
          description: This parameter displays the status of the deposit operation.
        network:
          type: string
          description: >-
            This parameter displays the network where the deposit operation
            occurred.
        expireAt:
          type: string
          format: date-time
          description: >-
            This parameter displays the time and date the deposit operation will
            timeout.
        externalId:
          type:
            - string
            - 'null'
          description: >-
            This parameter allows you to insert an Internal ID (from your own
            system) to better keep track of these operations.
        createdAt:
          type: string
          format: date-time
          description: >-
            This parameter displays the time and date the deposit operation was
            created.
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            This parameter displays the time and date the deposit operation was
            updated.
        toAsset:
          type: object
          description: >-
            This parameter displays the crypto currency to what the amout was
            converted.
          properties:
            id:
              type: string
              format: uuid
              description: >-
                This parameter displays the unique code that identifies the
                crypto currency.
            name:
              type: string
              description: This parameter displays the name given to the crypto currency.
            symbol:
              type: string
              description: >-
                This parameter displays the symbol associated to the crypto
                currency.
        amountUsd:
          type: string
          description: This parameter displays the equivalent of the deposit total in USD.
        amountEuro:
          type: post-reporting
          description: This parameter displays the equivalent of the deposit total in EURO.
    Exchange:
      type: object
      x-examples:
        Example 1:
          id: 649be79d-a480-496f-9874-1f3b92971bbc
          initiator: AUTO
          fromAsset:
            id: c21f664c-d2a1-4b41-9564-25e3dcde497c
            name: Litecoin Test
            symbol: LTC_TEST
          toAsset:
            id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
            name: USD Coin Test (Goerli)
            symbol: USDC_TEST3
          fromAmount: '0.024200646910223343'
          toAmount: '2.149090047568563567'
          status: FAILED
          createdAt: '2023-04-24T12:49:15+00:00'
          updatedAt: null
      examples:
        - id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
          initiator: AUTO
          fromAsset:
            id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
            name: string
            symbol: string
          toAsset:
            id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
            name: string
            symbol: string
          fromAmount: string
          toAmount: string
          status: FAILED
          createdAt: '2019-08-24T14:15:22Z'
          updatedAt: '2019-08-24T14:15:22Z'
      description: Exchange object
      properties:
        id:
          type: string
          format: uuid
          description: >-
            This parameter displays the unique code that identifies the exchange
            operation.
        initiator:
          type: string
          enum:
            - AUTO
            - MANUAL
          description: >-
            This parameter displays the type of exchange operation (automatic or
            manual).
        fromAsset:
          type: object
          description: >-
            This parameter displays the crypto currency from what the amout was
            converted.
          properties:
            id:
              type: string
              format: uuid
              description: >-
                This parameter displays the unique code that identifies the
                asset.
            name:
              type: string
              description: This parameter displays the name given to the asset.
            symbol:
              type: string
              description: This parameter displays the symbol given to the asset.
        toAsset:
          type: object
          description: >-
            This parameter displays the crypto currency to what the amount was
            converted.
          properties:
            id:
              type: string
              format: uuid
              description: >-
                This parameter displays the unique code that identifies the
                asset.
            name:
              type: string
              description: This parameter displays the name given to the asset.
            symbol:
              type: string
              description: This parameter displays the symbol given to the asset.
        fromAmount:
          type: string
          description: >-
            This parameter displays the amount converted from the original
            crypto currency.
        toAmount:
          type: string
          description: >-
            This parameter displays the amount converted to the final crypto
            currency.
        toAmountFee:
          type: string
          description: >-
            This parameter displays the amount charged as fee for the exchange
            operation.
        status:
          type: string
          enum:
            - CREATED
            - PENDING
            - PROCESSING
            - SUCCESS
            - FAILED
          description: This parameter displays the status of the exchange operation.
        accountId:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            This parameter displays an Account ID if this operation is related
            to an Account.
        externalId:
          type:
            - string
            - 'null'
          description: >-
            This parameter allows you to insert an Internal ID (from your own
            system) to better keep track of these operations.
        createdAt:
          type: string
          format: date-time
          description: >-
            This parameter displays the date and time the exchange operatyion
            was created.
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            This parameter displays the date and time the exchange operatyion
            was updated.
      x-stoplight:
        id: wsxb0zu3sna2j
    ExchangeAuto:
      type: object
      x-examples:
        Example 1:
          fromAsset:
            id: df6abe62-04a2-49d5-898e-c0f359f7cd81
            name: Tron Test
            symbol: TRX_TEST
          toAsset:
            id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
            name: USD Coin Test (Goerli)
            symbol: USDC_TEST3
          createdAt: '2023-04-19T16:55:33+00:00'
      examples:
        - fromAsset:
            id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
            name: string
            symbol: string
          toAsset:
            id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
            name: string
            symbol: string
          createdAt: '2019-08-24T14:15:22Z'
      description: Auto exchange object
      properties:
        fromAsset:
          type: object
          description: >
            This parameter displays the unique code that identifies the crypto
            currency to be converted from.
          properties:
            id:
              type: string
              format: uuid
              description: >
                This parameter displays the unique code that identifies the
                asset.
            name:
              type: string
              description: |
                This parameter displays the name given to the asset.
            symbol:
              type: string
              description: |
                This parameter displays the symbol given to the asset.
        toAsset:
          type: object
          description: >
            This parameter displays the unique code that identifies the crypto
            currency to be converted to.
          properties:
            id:
              type: string
              format: uuid
              description: >
                This parameter displays the unique code that identifies the
                asset.
            name:
              type: string
              description: |
                This parameter displays the name given to the asset.
            symbol:
              type: string
              description: |
                This parameter displays the symbol given to the asset.
        createdAt:
          type: string
          format: date-time
          description: >
            This parameter displays the date and time when auto exchange was
            created.
      x-stoplight:
        id: jow51t0433apf
    ExchangeEstimate:
      type: object
      x-examples:
        Example 1:
          data:
            type: exchange
            feeAmount: '0.010000000000000000'
            feePercent: '1'
            grossAmount: '1'
            netAmount: '0.990000000000000000'
            exchangeAmount: '0.06592806'
            rate: '0.066594'
            inverseRate: '15.016367840946631829'
      examples:
        - type: exchange
          feeAmount: '0.010000000000000000'
          feePercent: '1'
          grossAmount: '1'
          netAmount: '0.990000000000000000'
          exchangeAmount: '0.06592806'
          rate: '0.066594'
          inverseRate: '15.016367840946631829'
      description: Exchange estimate object
      x-stoplight:
        id: p8x5ipn53dekx
      properties:
        type:
          type: string
          description: This parameter displays the type of operation (exchange).
        feeAmount:
          type: string
          description: >-
            This parameter displays the amount charged as fee for the exchange
            operation.
        feePercent:
          type: string
          description: >-
            This parameter displays the percentage charged from the indicated
            amount to be converted.
        grossAmount:
          type: string
          description: >-
            This parameter displays the gross amount to be charged for the
            exchange operation. 
        netAmount:
          type: string
          description: >-
            This parameter displays the net amount to be charged for the
            exchange operation. 
        exchangeAmount:
          type: string
          description: >-
            This parameter displays the amount to be charged by the network for
            the exchange operation. 
        rate:
          type: string
          description: >-
            This parameter displays the rate between the from crypto currency
            and the to crypto currency.
        inverseRate:
          type: string
          description: >-
            This parameter displays the rate between the to crypto currency and
            the from crypto currency.
        freezeInfo:
          type: object
          x-stoplight:
            id: t4eeen2m95o5n
          description: >-
            This parameter displays whether the received exchange rate is
            frozen, and for how long.
          properties:
            id:
              type: string
              x-stoplight:
                id: gno26my2qe94d
              description: >-
                This parameter is the id of the frozen exchange rate and may be
                used to check if it is still valid.
              format: uuid
            expiresAt:
              type: string
              x-stoplight:
                id: eitm3sreq6q44
              description: >-
                This parameter displays the date and time when the current
                frozen exchange rate expires.
              format: date-time
    ExchangePair:
      type: object
      x-examples:
        Example 1:
          assetFrom:
            id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
            name: USD Coin Test (Goerli)
            symbol: USDC_TEST3
          assetsTo:
            - assetTo:
                id: a1b98c9a-e5d8-4cd2-b1be-37d05276008b
                name: Bitcoin Test
                symbol: BTC_TEST
              enabled: true
              autoExchangeAvailable: false
      examples:
        - assetFrom:
            id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
            name: string
            symbol: string
        - assetTo:
            id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
            name: string
            symbol: string
        - enabled: false
        - autoExchangeAvailable: true
      description: Exchange pair object
      properties:
        assetFrom:
          type: object
          description: This parameter displays the crypto currency to be converted from.
          properties:
            id:
              type: string
              format: uuid
              description: >-
                This parameter displays the unique code that identifies the
                asset.
            name:
              type: string
              description: This parameter displays the name given to the asset.
            symbol:
              type: string
              description: This parameter displays the symbol given to the asset.
        assetsTo:
          type: object
          description: >-
            This parameter displays the crypto currency to be converted to, if
            this pair is enabled, and if it can be converted automatically.
          properties:
            id:
              type: string
              format: uuid
              description: >-
                This parameter displays the unique code that identifies the
                asset.
            name:
              type: string
              description: This parameter displays the name given to the asset.
            symbol:
              type: string
              description: This parameter displays the symbol given to the asset.
        enabled:
          type: boolean
          description: >-
            This parameter indicates if the from crypto currency and to crypto
            currency pair is available to be converted.
        autoExchangeAvailable:
          type: boolean
          description: >-
            This parameter indicates if the from crypto currency and to crypto
            currency can be converted automatically.
      x-stoplight:
        id: k5233tsztr21u
    ExchangeRate:
      type: object
      x-examples:
        Example 1:
          pair: XRP/USDT
          rate: '5.228599426051655357'
      examples:
        - pair: XRP/USDT
          rate: '5.228599426051655357'
      description: Exchange rate object
      properties:
        pair:
          type: string
          description: >-
            This parameter displays the pair of crypto currencies selected for
            the exchange operation.
        rate:
          type: string
          description: >-
            This parameter displays the rate of the crypto currencies pair (from
            and to) swelected for the exchange operation.
      x-stoplight:
        id: b3qea8zjmviqi
    ExchangeRates:
      description: Exchange rate object
      type: object
      properties:
        USDT:
          type: object
          properties:
            source:
              type: string
              example: FineryMarkets
            date:
              type: string
              format: date-time
              example: '2024-12-06 09:50:46'
            value:
              type: string
              format: double
              example: '5.228599426051655357'
            liquidity:
              type: string
              format: double
              example: '0.00'
          description: >-
            This parameter displays the pair of crypto currencies selected for
            the exchange operation.
      x-stoplight:
        id: jh5t4avis88v4
    Balance:
      type: object
      x-examples:
        Example 1:
          id: 908cc544-afc5-46ec-a1f1-604792765707
          asset:
            id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
            name: USD Coin Test (Goerli)
            symbol: USDC_TEST3
            contract: '0x07865c6E87B9F70255377e024ace6630C1Eaa37F'
            decimals: 6
            network: ETH_TEST3
          available: '2128394.656684775994004183'
          createdAt: '2023-03-27T12:41:32+00:00'
          updatedAt: '2023-04-25T05:32:51+00:00'
          network: ETH_TEST3
      examples:
        - id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
          asset:
            id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
            name: string
            symbol: string
            contract: string
            decimals: 18
            network: string
          available: '11466.994555'
          createdAt: '2019-08-24T14:15:22Z'
          updatedAt: '2019-08-24T14:15:22Z'
          network: string
      description: Balance object
      properties:
        asset:
          type: object
          description: >-
            This parameter displays the crypto currency associated with the
            balance.
          properties:
            id:
              type: string
              format: uuid
              description: >-
                This parameter displays the unique code that identifies the
                asset.
            name:
              type: string
              description: This parameter displays the name given to the asset.
            symbol:
              type: string
              description: This parameter displays the symbol given to the asset.
            contract:
              type: string
              description: >-
                This parameter displays the unique code that identifies the
                crypto currency's contract.
            decimals:
              type: integer
              description: >-
                This parameter displays the amount of decimals acepted by the
                crypto currency.
            network:
              type: string
              description: >-
                This parameter displays the network where the crypto currency is
                available.
        available:
          type: string
          description: >-
            This parameter displays the amount available of the crypto currency
            associated with the balance.
        createdAt:
          type: string
          format: date-time
          description: This parameter displays the date and time the balance was created.
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: This parameter displays the date and time the balance was updated.
        network:
          type: string
          description: >-
            This parameter displays the network where the crypto currency is
            available.
        id:
          type: string
          format: uuid
          description: This parameter displays the unique code that identifies the balance.
      x-stoplight:
        id: vb5cb2eefmzhn
    BalanceDetails:
      type: object
      x-examples:
        Example 1:
          id: 908cc544-afc5-46ec-a1f1-604792765707
          asset:
            id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
            name: USD Coin Test (Goerli)
            symbol: USDC_TEST3
          total: '2128395.122443756183974226'
          available: '2128395.122443756183974226'
          deposit: '3044.962527947551134743'
          withdraw: '0.000000000000000000'
          exchange: '0.000000000000000000'
          locked: '0.000000000000000000'
          blocked: '0.000000000000000000'
          withdrawFee: '0.000000000000000000'
          exchangeFee: '0.000000000000000000'
          networkFee: '0.000000000000000000'
          network: 120
          createdAt: '2023-03-27T12:41:32+00:00'
          updatedAt: '2023-04-25T05:35:10+00:00'
      examples:
        - id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
          asset:
            id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
            name: string
            symbol: string
          total: string
          available: string
          deposit: string
          withdraw: string
          exchange: string
          locked: string
          blocked: string
          withdrawFee: string
          exchangeFee: string
          networkFee: string
          network: 123
          createdAt: '2019-08-24T14:15:22Z'
          updatedAt: '2019-08-24T14:15:22Z'
      description: Balance details object
      properties:
        id:
          type: string
          format: uuid
          description: This parameter displays the unique code that identifies the balance.
        asset:
          type: object
          description: >-
            This parameter displays the crypto currency associated with the
            balance.
          properties:
            id:
              type: string
              format: uuid
              description: >-
                This parameter displays the unique code that identifies the
                crypto currency.
            name:
              type: string
              description: This parameter displays the name given to the crypto currency.
            symbol:
              type: string
              description: >-
                This parameter displays the symbol associated to the crypto
                currency.
        total:
          type: string
          description: >-
            This parameter displays the amount available of the crypto currency
            associated with the balance. 
        available:
          type: string
          description: >-
            This parameter displays the amount available of the crypto currency
            associated with the balance.
        deposit:
          type: string
          description: This parameter displays the amount deposited into the system.
        withdraw:
          type: string
          description: This parameter displays the amount of money that went out.
        exchange:
          type: string
          description: >-
            This parameter displays the amout that went from one asset to
            another (eg.: BTC to ETH)
        locked:
          type: string
          description: >-
            This parameter displays the amount into transitional state (eg.: you
            want to withdraw some amount and, until the blockchain transaction
            is confirmed, this amount is taken out of available, put into
            locked, and after success it goes to withdraw.
        blocked:
          type: string
          description: 'This parameter displays the amounts blocked by the AML system. '
        withdrawFee:
          type: string
          description: This parameter displays the amount charged as withdraw fee.
        exchangeFee:
          type: string
          description: This parameter displays the amount charged as exchange fee.
        networkFee:
          type: string
          description: This parameter displays the amount charged as network fee.
        network:
          type: integer
          description: >-
            This parameter displays the network where the crypto currency is
            available.
        createdAt:
          type: string
          format: date-time
          description: This parameter displays the date and time the balance was created.
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: This parameter displays the date and time the balance was updated.
      x-stoplight:
        id: 09m7e31wqond3
    BalanceLogDetails:
      type: object
      x-examples:
        Example 1:
          id: 377328cf-21a3-4bcf-b1c6-98137e2c37a2
          wallet:
            id: ead69f53-6a79-4196-9b5f-22c1b0e41f06
            address: '0xA95454Ec7D8ad3DC9B8526F95ee0e4f418fD3d13'
            createdAt: '2023-03-27T09:57:50+00:00'
          transaction:
            tx: '0xf426c86a57c9e924f56faf26f45db2b5b2a4183811c8c9fb4cc0358f4ffdc666'
            networkFee: '0.000210000000000000'
            destinationAddress: '0xA95454Ec7D8ad3DC9B8526F95ee0e4f418fD3d13'
            createdAt: '2023-03-27T12:41:38+00:00'
            updatedAt: '2023-03-27T12:41:48+00:00'
            id: d4457b40-69fd-42f1-b4d9-ad12b618d522
            fee: '0.000726339658963996'
            lease:
              id: bbbe4b93-5fa4-452a-8a8c-2d1ccfb48105
              asset:
                id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
                name: USD Coin Test (Goerli)
                symbol: USDC_TEST3
              address: '0xA95454Ec7D8ad3DC9B8526F95ee0e4f418fD3d13'
              expires: '2023-03-27T13:11:37+00:00'
              network: 120
              createdAt: '2023-03-27T12:41:37+00:00'
              updatedAt: '2023-03-27T12:41:38+00:00'
          asset:
            id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
            name: USD Coin Test (Goerli)
            symbol: USDC_TEST3
          amount: '0.072633965896399621'
          balanceBefore: '0.063385321808833923'
          balanceAfter: '0.135292948046269548'
          type: DEPOSIT
          network: 120
          createdAt: '2023-03-27T12:41:48+00:00'
      examples:
        - id: 377328cf-21a3-4bcf-b1c6-98137e2c37a2
          wallet:
            id: ead69f53-6a79-4196-9b5f-22c1b0e41f06
            address: '0xA95454Ec7D8ad3DC9B8526F95ee0e4f418fD3d13'
            createdAt: '2023-03-27T09:57:50+00:00'
          transaction:
            tx: '0xf426c86a57c9e924f56faf26f45db2b5b2a4183811c8c9fb4cc0358f4ffdc666'
            networkFee: '0.000210000000000000'
            destinationAddress: '0xA95454Ec7D8ad3DC9B8526F95ee0e4f418fD3d13'
            createdAt: '2023-03-27T12:41:38+00:00'
            updatedAt: '2023-03-27T12:41:48+00:00'
            id: d4457b40-69fd-42f1-b4d9-ad12b618d522
            fee: '0.000726339658963996'
            lease:
              id: bbbe4b93-5fa4-452a-8a8c-2d1ccfb48105
              asset:
                id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
                name: USD Coin Test (Goerli)
                symbol: USDC_TEST3
              address: '0xA95454Ec7D8ad3DC9B8526F95ee0e4f418fD3d13'
              expires: '2023-03-27T13:11:37+00:00'
              network: 120
              createdAt: '2023-03-27T12:41:37+00:00'
              updatedAt: '2023-03-27T12:41:38+00:00'
          asset:
            id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
            name: USD Coin Test (Goerli)
            symbol: USDC_TEST3
          amount: '0.072633965896399621'
          balanceBefore: '0.063385321808833923'
          balanceAfter: '0.135292948046269548'
          type: DEPOSIT
          network: 120
          createdAt: '2023-03-27T12:41:48+00:00'
      description: Balance log details object
      properties:
        id:
          type: string
          format: uuid
          description: >
            This parameter displays the unique code that identifies the balance
            log.
        wallet:
          type: object
          description: >
            This Object displays the wallet of the balance log with the
            following 3 parameters:
          properties:
            id:
              type: string
              format: uuid
              description: >
                This parameter displays the unique code that identifies the
                wallet.
            address:
              type: string
              description: |
                This parameter displays the address that locates the wallet.
            createdAt:
              type: string
              format: date-time
              description: >
                This parameter displays the date and time the wallet was
                created.
        transaction:
          type: object
          description: >
            This object displays the transaction that was logged with the
            following 18 parameters:
          properties:
            tx:
              type: string
              description: >-
                This parameter displays the unique code that identifies the
                transaction.
            networkFee:
              type: string
              description: |
                This parameter displays the amount charged as network fee.
            destinationAddress:
              type: string
              description: >
                This parameter displays the address used as the destination of
                the transaction.
            createdAt:
              type: string
              format: date-time
              description: >
                This parameter displays the date and time the transaction was
                created.
            updatedAt:
              type:
                - string
                - 'null'
              format: date-time
              description: >
                This parameter displays the date and time the transaction was
                updated.
            id:
              type: string
              format: uuid
              description: >
                This parameter displays the unique code that identifies the
                transaction.
            fee:
              type: string
              description: |
                This parameter displays the amount charged for the transaction.
            lease:
              type: object
              description: Lease object
              properties:
                id:
                  type: string
                  format: uuid
                  description: >
                    This parameter displays the unique code that identifies the
                    lease.
                asset:
                  type: object
                  description: >
                    This object displays the crypto currency used on the
                    transaction with the following 3 parameters:
                  properties:
                    id:
                      type: string
                      format: uuid
                      description: >
                        This parameter displays the unique code that identifies
                        the asset.
                    name:
                      type: string
                      description: |
                        This parameter displays the name given to the asset.
                    symbol:
                      type: string
                      description: |
                        This parameter displays the symbol given to the asset.
                address:
                  type: string
                  description: >
                    This parameter displays the address that locates the wallet
                    used on the transaction.
                expires:
                  type: string
                  description: >
                    This parameter displays the date and time the transaction
                    times out.
                network:
                  type: integer
                  description: >
                    This parameter displays the network used for the
                    transaction.
                createdAt:
                  type: string
                  format: date-time
                  description: >
                    This parameter displays the date and time the transaction
                    was created.
                updatedAt:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: >
                    This parameter displays the date and time the transaction
                    was updated.
        asset:
          type: object
          description: >
            This parameter displays the crypto currency used on the transaction
            with the following 3 parameters:
          properties:
            id:
              type: string
              format: uuid
              description: >
                This parameter displays the unique code that identifies the
                asset.
            name:
              type: string
              description: |
                This parameter displays the name given to the asset.
            symbol:
              type: string
              description: |
                This parameter displays the symbol given to the asset.
        amount:
          type: string
          description: >
            This parameter displays the amount of the crypto currency used on
            the transaction.
        balanceBefore:
          type: string
          description: >
            This parameter displays the balance of the crypto currency before
            the transaction occurred.
        type:
          type: string
          enum:
            - DEPOSIT
            - WITHDRAW
            - INCOMING_EXCHANGE
            - OUTGOING_EXCHANGE
          description: >-
            This parameter displays the type of transaction that occurred
            (deposit, withdraw, exchanging to, or exchanging from).
        balanceAfter:
          type: string
          description: >
            This parameter displays the balance of the crypto currency after the
            transaction occurred.
        network:
          type: integer
          description: |
            This parameter displays the network where the transaction occurred.
        createdAt:
          type: string
          format: date-time
          description: >
            This parameter displays the date and time when the transaction
            occurred.
      x-stoplight:
        id: enb8qeijx9baa
    Payout-create:
      type: object
      x-examples:
        Example 1:
          amount: '0.01'
          networkFee: '0.000556532775603'
          status: APPROVED
          asset:
            id: 0b47a85e-a66a-461c-bb1a-e818def2ff82
            name: Ethereum Test (Goerli)
            symbol: ETH_TEST3
            displayName: Ethereum Test
            displaySymbol: ETH_TEST
            exchangeSymbol: ETH
            type: CRYPTO
            subType: BASE_ASSET
            token: false
            contract: null
            nativeAsset: ETH_TEST3
            decimals: 18
            network: 120
          id: ccd57031-cc2c-4ca2-bc73-6b087ce4c0e3
          transaction:
            createdAt: '2023-05-30T11:39:04+00:00'
            updatedAt: null
            id: c6f48ae4-b458-4caf-8875-d1ff06e7ecce
            lease: null
          fee: '0.000424495513613041'
          feePriority: MEDIUM
          destination: '0xb94E056b4931b27D9C2565963D0a34B043217989'
          note: null
          network: 120
          createdAt: '2023-05-30T11:39:04+00:00'
          updatedAt: null
      description: Payout object
      x-stoplight:
        id: rvtkwmh4nmdk9
      properties:
        amount:
          type: string
          description: >-
            This parameter displays the amount of the crypto currency that will
            be used on the payout operation.
        networkFee:
          type: string
          description: >-
            This parameter displays the amount charged by the network as fee for
            the payout operation.
        status:
          type: string
          enum:
            - APPROVAL
            - APPROVED
            - PROGRESS
            - REJECTED
            - SUCCESS
            - FAILED
          description: This parameter displays the status of the payout operation.
        asset:
          $ref: '#/components/schemas/AssetEntity'
          description: >-
            This parameter displays the crypto currency that will be used on the
            payout operation.
        id:
          type: string
          description: >
            This parameter displays the unique code that identifies the payout
            operation.
        transaction:
          type: object
          description: >-
            This object displays the information on the transaction required for
            the payout operation.
          properties:
            createdAt:
              type: string
              format: date-time
              description: >
                This parameter displays the time and date the transaction was
                created.
            updatedAt:
              type:
                - string
                - 'null'
              format: date-time
              description: >
                This parameter displays the time and date the transaction was
                updated.
            id:
              type: string
              format: uuid
              description: >
                This parameter displays the unique code that identifies the
                transaction.
            lease:
              $ref: '#/components/schemas/WalletLease'
              description: Lease object, can be null
        fee:
          type: string
          description: >-
            This parameter displays the amount charged as fee for the payout
            operation.
        feePriority:
          type: string
          description: >-
            This parameters displays the amount of fee paid for gas (in ETH
            language). Note: more gas = faster transaction processing on the
            blockchain.
        destination:
          type: string
          description: This parameter displays the address for the payout operation.
        note:
          type:
            - string
            - 'null'
          description: This parameters displays the memo related to the transaction.
        walletTag:
          type:
            - string
            - 'null'
          description: >-
            This parameter allows you to insert the unique numerical code,
            required by some blockchains, to pair with the deposit address, as
            an additional Security measure.
        network:
          type: integer
          description: >-
            This parameter displays the network where the payout operation
            occurred.
        createdAt:
          type: string
          format: date-time
          description: >-
            This parameter displays the time and date the payout operation was
            created.
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            This parameter displays the time and date the payout operation was
            updated.
        exchangeRequested:
          type: boolean
          x-stoplight:
            id: pdl3fjibdq0a3
          description: >-
            This parameter determines whether an auto exchange to another asset
            has been requested as part of this operation.
        requestedAsset:
          type: string
          x-stoplight:
            id: bj3u30ii5fl4u
          format: uuid
          description: >-
            If auto exchange was requested, this parameter is the asset being
            exchanged to.
        requestedAmount:
          type: string
          x-stoplight:
            id: 98v5c6owqx8vi
          description: >-
            If auto exchange was requested, this parameter is the amount of the
            requested asset being exchanged to.
        treatAsGrossAmount:
          type: boolean
          x-stoplight:
            id: j7vx5k3owfgno
          description: >-
            This parameter determines whether the payout amount is treated as
            total amount debited from your account (including all fees).
        externalId:
          type: string
          x-stoplight:
            id: 9asnaugges6o0
          description: >-
            This parameter allows you to insert an Internal ID (from your own
            system) to better keep track of these operations.
    Payout:
      type: object
      x-examples:
        Example 1:
          id: d4fc0230-7fa8-4ac0-96d4-63bd61e80987
          destination: '0x92009d7A79d3813DD3309e663d3a77844EF675D4'
          amount: '0.001'
          fee: '0.000437136971405779'
          feePriority: MEDIUM
          networkFee: '0.00002100000084'
          network: ETH_TEST3
          status: APPROVED
          note: null
          asset:
            id: 78f8b41f-507c-4fc3-bdcb-7f2c1c6a2d0c
            name: Ethereum Test (Goerli)
            symbol: ETH_TEST3
            displayName: Ethereum Test
            displaySymbol: ETH_TEST
            exchangeSymbol: ETH
            type: CRYPTO
            subType: BASE_ASSET
            token: false
            contract: null
            nativeAsset: ETH_TEST3
            decimals: 18
            network: ETH_TEST3
          createdAt: '2023-08-02T04:12:53+00:00'
          updatedAt: null
      x-stoplight:
        id: cr1sohi50i31q
      properties:
        id:
          type: string
          description: >-
            This parameter displays the unique code that identifies the payout
            operation.
          format: uuid
        destination:
          type: string
          description: This parameter displays the address for the payout operation.
        amount:
          type: string
          description: >-
            This parameter displays the amount of the crypto currency that will
            be used on the payout operation.
        fee:
          type: string
          description: >-
            This parameter displays the amount charged as fee for the payout
            operation.
        feePriority:
          type: string
          description: >-
            This parameters displays the amount of fee paid for gas (in ETH
            language). Note: more gas = faster transaction processing on the
            blockchain.
        networkFee:
          type: string
          description: >-
            This parameter displays the amount charged by the network as fee for
            the payout operation.
        network:
          type: string
          description: >-
            This parameter displays the network where the payout operation
            occurred.
        status:
          type: string
          description: This parameter displays the status of the payout operation.
        note:
          type: 'null'
          description: This parameters displays the memo related to the transaction.
        walletTag:
          type:
            - string
            - 'null'
          description: >-
            This parameter allows you to insert the unique numerical code,
            required by some blockchains, to pair with the deposit address, as
            an additional Security measure.
        asset:
          $ref: '#/components/schemas/AssetEntity'
          description: >-
            This parameter displays the crypto currency that will be used on the
            payout operation.
        externalId:
          type:
            - string
            - 'null'
          description: >-
            This parameter allows you to insert an Internal ID (from your own
            system) to better keep track of these operations.
        createdAt:
          type: string
          description: >-
            This parameter displays the time and date the payout operation was
            created.
          format: date-time
        updatedAt:
          type:
            - string
            - 'null'
          description: >-
            This parameter displays the time and date the payout operation was
            updated.
          format: date-time
        sourceAddress:
          type: string
          x-stoplight:
            id: 4n2h11bo86qug
          description: The Wallet address from which the Payout originates.
        txHash:
          type: string
          x-stoplight:
            id: dxs45gjxkmjun
          description: The transaction hash of the transaction on the public blockchain
    Asset:
      type: object
      x-examples:
        Example 1:
          id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
          network: ETH_TEST3
          name: USD Coin Test (Goerli)
          symbol: USDC_TEST3
          contract: '0x07865c6E87B9F70255377e024ace6630C1Eaa37F'
          decimals: 6
          active: true
      examples:
        - id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
          network: ETH_TEST3
          name: USD Coin Test (Goerli)
          symbol: USDC_TEST3
          contract: '0x07865c6E87B9F70255377e024ace6630C1Eaa37F'
          decimals: 6
          active: true
      description: Asset object
      properties:
        id:
          type: string
          format: uuid
          description: >
            This parameter displays the unique code that identifies the crypto
            currency.
        network:
          type: string
          description: >
            This parameter displays the network where the crypto currency is
            available.
        name:
          type: string
          description: |
            This parameter displays the name given to the crypto currency.
        symbol:
          type: string
          description: >
            This parameter displays the symbol associated to the crypto
            currency.
        contract:
          type:
            - string
            - 'null'
          description: >
            This parameter displays the unique code that identifies the crypto
            currency's contract.
        decimals:
          type: integer
          description: >
            This parameter displays the amount of decimals acepted by the crypto
            currency.
        active:
          type: boolean
          description: >
            This parameter displays the current status of the crypto currency
            (active or inactive) on your account.
      x-stoplight:
        id: f3z1geuj0k3v7
    OperationLog:
      type: object
      x-examples:
        Example 1:
          operationId: 570344a1-1192-450e-b6a5-aa2bf63e8964
          refId: 4CEA646DE4424218
          asset: BNB_TEST
          amount: '0.007142803271208617'
          status: SUCCESS
          subStatus: null
          createdAt: 24-05-2023 10:17:38
          type: DEPOSIT
          clientEmail: null
          assetFrom: null
          amountFrom: null
          children: []
          accountId: null
      description: Operation object
      x-stoplight:
        id: j06uanhgzkdg7
      properties:
        operationId:
          type: string
          format: uuid
          description: >-
            This parameter displays the unique code that identifies the
            operation.
        refId:
          type: string
          description: This parameter displays the operation human readable id.
        asset:
          type: string
          description: |
            This parameter displays the crypto currency used on the transaction.
        amount:
          type: string
          description: >
            This parameter displays the amount of the crypto currency used on
            the transaction.
        status:
          type: string
          description: |
            This parameter displays the status of the transaction.
        subStatus:
          type:
            - string
            - 'null'
          description: >
            This parameter displays the sub status of the transaction that
            provides more information that the first status.
        createdAt:
          type: string
          format: date-time
          description: >
            This parameter displays the date and time when the transaction
            occurred.
        type:
          type: string
          description: >-
            This parameter displays the type of transaction that occurred
            (deposit, withdraw, exchanging to, or exchanging from).
        clientEmail:
          type:
            - string
            - 'null'
          description: >
            This parameter displays the email address of the client involved on
            the transaction.
        assetFrom:
          type:
            - string
            - 'null'
          description: >-
            This parameter displays the crypto currency being exchanged or spent
            in the transaction.
        amountFrom:
          type:
            - string
            - 'null'
          description: >
            This parameter displays the amount of the crypto currency used on
            the transaction by the client.
        children:
          type: array
          description: This parameter displays any sub operation of the current one.
          items:
            type: object
        tx:
          type: string
          description: >-
            This parameter displays the unique code that identifies the
            transaction.
        context:
          type: object
          description: >-
            This parameter displays additional information concerning the
            operation.
        accountId:
          type:
            - string
            - 'null'
          description: >
            This parameter displays an Account ID if this operation is realted
            to an Account.
    WalletLease:
      title: WalletLease
      x-stoplight:
        id: xq44kjf19o70v
      type: object
      description: Wallet lease object
      properties:
        id:
          type: string
          format: uuid
          description: This parameter displays the unique code that identifies the lease.
        asset:
          $ref: '#/components/schemas/Asset'
          description: Asset object
        address:
          type: string
          description: >-
            This parameter displays the address of the wallet associated with
            the lease (payout or deposit).
        amount:
          type: string
          description: >-
            This parameter displays the amount of the crypto currency that will
            be used on the lease.
        expired:
          type: boolean
          description: This parameter displays the date and time the lease timed out.
        used:
          type: boolean
          description: This parameter indicares if the lease has been used or not.
        expires:
          type: string
          format: date-time
          description: This parameter displays the date and time the lease times out.
        network:
          type: integer
          description: This parameter displays the network where the lease is available.
        createdAt:
          type: string
          format: date-time
          description: This parameter displays the time and date the lease was created.
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: This parameter displays the time and date the lease was updated.
    Callback:
      type: object
      x-examples:
        Example 1:
          id: 2033b9fb-e282-4fb7-9eeb-be1fe957c513
          project: f282babd-138e-4852-a7ab-214f89b1d488
          url: https://example.com/webhook
          active: true
          createdAt: '2023-06-10T20:55:48+00:00'
          updatedAt: '1970-01-01T00:00:00+00:00'
      examples:
        - id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
          project: 9ec8a81a-31b2-4a83-bcd8-cef9150932d2
          url: string
          active: true
          createdAt: '2019-08-24T14:15:22Z'
          updatedAt: '2019-08-24T14:15:22Z'
      description: Callback object
      properties:
        id:
          type: string
          format: uuid
          description: >
            This parameter displays the unique code that identifies the callback
            url.
        project:
          type: string
          format: uuid
          description: >
            This parameter displays the name that identifies the project the
            callback url is associated with.
        url:
          type: string
          description: |
            This parameter displays the url associated with the callback url.
        active:
          type: boolean
          description: >
            This parameter indicates if the callback url is active to receive
            callbacks or not.
        createdAt:
          type: string
          format: date-time
          description: >
            This parameter displays the date and time when the callback url was
            created.
        updatedAt:
          type: string
          format: date-time
          description: >
            This parameter displays the date and time when the callback url was
            updated.
      x-stoplight:
        id: h6uhlh0ihe9po
    CallbackQueue:
      type: object
      x-stoplight:
        id: n1sc2v91xd945
      description: Callback queue object
      examples:
        - id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
          project: 9ec8a81a-31b2-4a83-bcd8-cef9150932d2
          scope: DEPOSIT
          event: CREATED
          payload: >-
            {"scope":"DEPOSIT","event":"STATUS_UPDATED","project":"1d6e80e6-6016-4736-90c4-9e047e00423a","data":{"id":"b69f68a3-9e97-42b6-a728-1977f6841909","asset":{"id":"c21f664c-d2a1-4b41-9564-25e3dcde497c","name":"Litecoin
            Test","symbol":"LTC_TEST","displayName":"Litecoin
            Test","displaySymbol":"LTC_TEST","exchangeSymbol":"LTC","type":"CRYPTO","subType":"BASE_ASSET","token":false,"contract":null,"nativeAsset":"LTC_TEST","decimals":8,"network":"LTC_TEST"},"amount":"0.003424501459681069","targetAmount":null,"wallet":"tltc1qar05t4myq978esl36mv7ca3c6czmzq57azymkz","status":"PAID","network":"LTC_TEST","expireAt":"2023-06-20T08:58:50+00:00","createdAt":"2023-06-20T08:28:50+00:00","updatedAt":[],"operationLog":{"operationId":"b69f68a3-9e97-42b6-a728-1977f6841909","refId":"4CEA649163424E46","asset":"USDC_TEST3","amount":"0.26424735458973054","status":"SUCCESS","subStatus":null,"createdAt":"20-06-2023
            08:28:50","clientEmail":null,"assetFrom":"LTC_TEST","amountFrom":"0.003424501459681069","children":[]},"toAsset":{"id":"585c16ca-d438-4ef6-bcd2-a6d5ff685af4","name":"USD
            Coin Test (Goerli)","symbol":"USDC_TEST3","displayName":"USD Coin
            Test
            (Goerli)","displaySymbol":"USDC_TEST3","exchangeSymbol":"USDC","type":"CRYPTO","subType":"ERC20","token":true,"contract":"0x07865c6E87B9F70255377e024ace6630C1Eaa37F","nativeAsset":"ETH_TEST3","decimals":6,"network":"ETH_TEST3"}}}
          status: QUEUED
          retries: 0
          createdAt: '2019-08-24T14:15:22Z'
          url:
            id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
            project: 9ec8a81a-31b2-4a83-bcd8-cef9150932d2
            url: string
            active: true
            createdAt: '2019-08-24T14:15:22Z'
            updatedAt: '2019-08-24T14:15:22Z'
      properties:
        id:
          type: string
          format: uuid
          description: >
            This parameter displays the unique code that identifies the
            callback.
        project:
          type: string
          format: uuid
          description: >
            This parameter displays the name that identifies the project the
            callback is associated with.
        scope:
          type: string
          enum:
            - DEPOSIT
            - ORDER
            - WITHDRAWAL
            - EXCHANGE
            - PAYOUT
          description: >
            This parameter displays the name that identifies the scope of the
            callback.
        event:
          type: string
          enum:
            - CREATED
            - UPDATED
            - STATUS_UPDATED
          description: >
            This parameter displays the name that identifies the event status of
            the callback.
        payload:
          anyOf:
            - $ref: '#/components/schemas/DirectDeposit'
            - $ref: '#/components/schemas/Exchange'
            - $ref: '#/components/schemas/Payout'
        status:
          type: string
          enum:
            - QUEUED
            - SUCCESS
            - FAILED
          description: >
            This parameter displays the name that identifies the status of the
            callback.
        retries:
          type: integer
          description: |
            This parameter displays the amount of tries to send the callback.
        createdAt:
          type: string
          format: date-time
          description: >
            This parameter displays the date and time when the callback was
            created.
        url:
          $ref: '#/components/schemas/Callback'
          description: >
            This object identifies the callback url associated with the callback
            to send.
      x-internal: false
    CallbackLog:
      title: CallbackLog
      x-stoplight:
        id: 0zjvk9y742j6f
      type: object
      description: Callback log object
      properties:
        id:
          type: string
          format: uuid
          description: >
            This parameter displays the unique code that identifies the
            callback.
        responseCode:
          type: string
          description: |
            This parameter displays the response code assingned to the callback.
        project:
          type: string
          format: uuid
          description: >
            This parameter displays the name that identifies the project the
            callback is associated with.
        createdAt:
          type: string
          format: date-time
          description: >
            This parameter displays the date and time when the callback was
            created.
        callback:
          $ref: '#/components/schemas/CallbackQueue'
          description: |
            This object identifies the callbackQueue associated with the item.
    AssetEntity:
      title: AssetEntity
      x-stoplight:
        id: 2zrwoc77dw0oh
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: >-
            This parameter displays the unique code that identifies the crypto
            currency.
        name:
          type: string
          description: This parameter displays the name given to the crypto currency.
        symbol:
          type: string
          description: >-
            This parameter displays the symbol associated to the crypto
            currency.
        displayName:
          type: string
          description: This paramater displays the name of the asset.
        displaySymbol:
          type: string
          description: This paramater displays the symbol of the asset.
        type:
          type: string
          description: This paramater displays the type of asset (fiat or crypto).
        exchangeSymbol:
          type: string
          description: >-
            This parameter displays the id that identifies the exchange provider
            asset.
        subType:
          type: string
          description: This paramater displays the subtype of asset (token or based asset).
        token:
          type: string
          description: This paramater displays the if the asset is a token or not.
        contract:
          type: string
          description: >-
            This parameter displays the unique code that identifies the crypto
            currency's contract.
        nativeAsset:
          type: string
          description: >-
            This parameter displays the base asset of the blockchain (e.g.: USDT
            on Ethereum network is USDT asset and ETH base asset).
        decimals:
          type: string
          description: >-
            This parameter displays the amount of decimals acepted by the crypto
            currency.
        network:
          type: string
          description: >-
            This parameter displays the network where the crypto currency is
            available.
    Batch:
      type: object
      x-examples:
        Example 1:
          id: 8d05ea22-87c6-4730-80c3-407d1c81b688
          title: test h
          createdAt: 03-08-2023 11:24:00
          itemsCount: '1'
          status: PENDING
      properties:
        id:
          type: string
          format: uuid
          description: This parameter displays the unique code that identifies the batch.
        title:
          type: string
          description: This parameter displays the name given to identify the batch.
        createdAt:
          type: string
          format: date-time
          description: This parameter displays the time and date the batch was created.
        itemsCount:
          type: string
          description: This parameter displays the amount of items in the batch.
        status:
          type: string
          description: This parameter displays the status of the operation.
        totalAmountUsd:
          type: string
          description: >-
            This parameter displays the total amount of the operations in the
            batch in USD.
      x-stoplight:
        id: 53bce3nt4ljsl
    DirectDepositQR:
      allOf:
        - $ref: '#/components/schemas/DirectDeposit'
        - type: object
          properties:
            qr:
              type: string
              description: >-
                This parameter displays the base64 encoded qr code that
                identifies the wallet (that you can decode and display as
                data:image/png;base64).
      x-stoplight:
        id: br56jij86t93o
    TopUp:
      type: object
      x-examples:
        Example 1:
          id: d4fc0230-7fa8-4ac0-96d4-63bd61e80987
          amount: '0.001'
          fee: '0.000437136971405779'
          note: null
          asset:
            id: 78f8b41f-507c-4fc3-bdcb-7f2c1c6a2d0c
            name: Ethereum Test (Goerli)
            symbol: ETH_TEST3
            displayName: Ethereum Test
            displaySymbol: ETH_TEST
            exchangeSymbol: ETH
            type: CRYPTO
            subType: BASE_ASSET
            token: false
            contract: null
            nativeAsset: ETH_TEST3
            decimals: 18
            network: ETH_TEST3
          createdAt: '2023-08-02T04:12:53+00:00'
      properties:
        id:
          type: string
          description: >-
            This parameter displays the unique code that identifies the topup
            operation.
          format: uuid
        amount:
          type: string
          description: >-
            This parameter displays the amount of the crypto currency that will
            be used on the topup operation.
        fee:
          type: string
          description: >-
            This parameter displays the amount charged as fee for the topup
            operation.
        status:
          type: string
          description: This parameter displays the status of the topup operation.
        note:
          type: 'null'
          description: This parameters displays the memo related to the transaction.
        asset:
          $ref: '#/components/schemas/AssetEntity'
          description: >-
            This parameter displays the crypto currency that will be used on the
            topup operation.
        createdAt:
          type: string
          description: >-
            This parameter displays the time and date the topup operation was
            created.
          format: date-time
      x-stoplight:
        id: w1arrpgtwe745
    Settlement:
      type: object
      x-examples:
        Example 1:
          id: d4fc0230-7fa8-4ac0-96d4-63bd61e80987
          amount: '0.001'
          fee: '0.000437136971405779'
          networkFee: '0.00002100000084'
          note: null
          asset:
            id: 78f8b41f-507c-4fc3-bdcb-7f2c1c6a2d0c
            name: Ethereum Test (Goerli)
            symbol: ETH_TEST3
            displayName: Ethereum Test
            displaySymbol: ETH_TEST
            exchangeSymbol: ETH
            type: CRYPTO
            subType: BASE_ASSET
            token: false
            contract: null
            nativeAsset: ETH_TEST3
            decimals: 18
            network: ETH_TEST3
          createdAt: '2023-08-02T04:12:53+00:00'
      properties:
        id:
          type: string
          description: >-
            This parameter displays the unique code that identifies the
            settlement operation.
          format: uuid
        amount:
          type: string
          description: >-
            This parameter displays the amount of the crypto currency that will
            be used on the settlement operation.
        fee:
          type: string
          description: >-
            This parameter displays the amount charged as fee for the settlement
            operation.
        networkFee:
          type: string
          description: >-
            This parameter displays the amount charged by the network as fee for
            the settlement operation.
        status:
          type: string
          description: This parameter displays the status of the settlement operation.
        note:
          type: 'null'
          description: This parameters displays the memo related to the transaction.
        asset:
          $ref: '#/components/schemas/AssetEntity'
          description: >-
            This parameter displays the crypto currency that will be used on the
            settlement operation.
        createdAt:
          type: string
          description: >-
            This parameter displays the time and date the settlement operation
            was created.
          format: date-time
      x-stoplight:
        id: amce4t3jgplit
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: integer
                description: >-
                  This parameter displays the unique code of the error message
                  produced.
              msg:
                type: string
                description: This parameter describes the message of the error produced.
          examples:
            Example 1:
              value:
                code: -100
                msg: Request data is invalid
  securitySchemes:
    HMAC:
      name: Authorization contains username algorithm headers signature
      type: apiKey
      in: header
      description: >-
        # Example bash script

        ```bash

        #!/bin/bash


        set -e


        METHOD=$(echo "$1" | tr a-z A-Z)

        ENDPOINT=$2

        GATEWAY_HOST=API_HOST

        GATEWAY_URL=API_URL

        HMAC_KEY=

        HMAC_SECRET=


        ENDPOINT_URL=$GATEWAY_URL$ENDPOINT

        DATE=$(LC_ALL=en_US.utf8 date --utc +"%a, %d %b %Y %H:%M:%S UTC")


        if [ -z "$METHOD" ] || [ -z "$ENDPOINT" ]

        then

        echo -e "Usage `basename "$0"` METHOD ENDPOINT\nExample GET /endpoint"

        exit 0

        fi


        SIGN_STRING="date: $DATE\n$METHOD $ENDPOINT HTTP/1.1"

        SIGNATURE=$(echo -en $SIGN_STRING | openssl dgst -sha256 -hmac
        "$HMAC_SECRET" -binary | base64)


        curl -s -X "$METHOD" "$ENDPOINT_URL" -H "Host: $GATEWAY_HOST" -H "Date:
        $DATE" -H "Authorization: hmac username=\"$HMAC_KEY\",
        algorithm=\"hmac-sha256\", headers=\"date request-line\",
        signature=\"$SIGNATURE\"" | jq

        ```
  parameters:
    offset:
      name: offset
      in: query
      required: false
      schema:
        type: integer
        default: 0
        minimum: 0
      description: >-
        This parameter allows you to indicate in what position to start from the
        list.
    limit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 20
        minimum: 0
        maximum: 50
      description: This parameter allows you to determine the amount of results per page.
    from:
      name: from
      in: query
      required: false
      schema:
        type: string
        format: date
        description: This parameter allows you to indicate the start date of the list.
    to:
      name: to
      in: query
      required: false
      schema:
        type: string
        format: date
        description: This parameter allows you to indicate the end date of the list.
    order:
      name: order
      in: query
      required: false
      schema:
        type: string
        description: This parameter allows you to indicate the order.
        enum:
          - ASC
          - DESC
    assets:
      name: assets
      in: query
      required: false
      schema:
        type: array
        description: This parameter allows you to indicate assets to filter the list
  requestBodies:
    CreateOrder:
      content:
        application/x-www-form-urlencoded:
          schema:
            type: object
            required:
              - name
              - description
              - amount
              - asset
            properties:
              name:
                type: string
                description: This parameter displays the name given to the payment link.
              description:
                type: string
                description: >-
                  This parameters displays the description given to the payment
                  link's target.
              amount:
                type: string
                description: >-
                  This parameter displays the amount associated to the order. If
                  left empty, any amount deposited will change the Order to
                  “PAID”
              asset:
                type: string
                format: uuid
                description: >-
                  The unique code that identifies the desired asset you want to
                  be the cryptocurrency associated with the Order. Full list of
                  assets will be given to you by Coinsflow integration manager.
              clientEmail:
                type: string
                format: string
                description: >-
                  This parameter displays the email address of the client
                  involved in the transaction. It is optional.
              externalId:
                type: string
                format: string
                description: >-
                  Allows you to insert an Internal ID (from your own system) to
                  better keep track of these operations.
              expirationDate:
                type: string
                format: date
                description: >-
                  This parameter sets the date and time until then the client is
                  allowed to follow the payment link (payment link lifetime). 

                  The format is as follows: `yyyy-mm-dd hh:ii:ss`.

                  The date and time should be in UTC.
              isSinglePayment:
                type: boolean
                default: false
                description: >-
                  This parameter limits the Order to only one Deposit. amount
                  will not affect final status, it will always reach PAID.
    OrderDeposit:
      content:
        application/x-www-form-urlencoded:
          schema:
            type: object
            properties:
              amount:
                type: string
                pattern: ^\d{1,18}(\.\d{1,18})?$
                description: >-
                  This parameter allows you to insert the desired amount to
                  deposit.
              asset:
                type: string
                format: uuid
                description: >-
                  This parameter allows you to indicate the crypto currency in
                  which the amount is deposited. The asset is provided by the
                  unique code that identifies it (if you don't have the asset's
                  code, contact our support).
              description:
                type: string
                description: >-
                  This parameters displays the description given to the deposit
                  target.
              externalId:
                type: string
                description: >-
                  This parameter allows you to insert an Internal ID (from your
                  own system) to better keep track of these operations.
              clientEmail:
                type: string
                description: >-
                  This parameter displays the email address of the client
                  involved in the transaction.
            required:
              - amount
              - clientEmail
              - asset
              - description
    DirectDeposit:
      content:
        application/x-www-form-urlencoded:
          schema:
            type: object
            x-examples:
              Example 1:
                data:
                  id: edb68017-78a7-4c80-9ac6-68b0520ad27b
                  asset:
                    id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
                    name: USD Coin Test (Goerli)
                    symbol: USDC_TEST3
                  amount: '0'
                  targetAmount: '10.10'
                  wallet: '0x1598E7fefFb36fbAD683Fd72F7D6a08A7c703438'
                  status: PENDING
                  network: ETH_TEST3
                  expireAt: '2023-04-21T09:28:04+00:00'
                  createdAt: '2023-04-21T08:58:04+00:00'
                  updatedAt: null
                  toAsset:
                    id: 585c16ca-d438-4ef6-bcd2-a6d5ff685af4
                    name: USD Coin Test (Goerli)
                    symbol: USDC_TEST3
            properties:
              amount:
                type: string
                pattern: ^\d{1,18}(\.\d{1,18})?$
                description: >-
                  This parameter allows you to insert the desired amount to
                  deposit.
              asset:
                type: string
                format: uuid
                description: >-
                  This parameter allows you to indicate the  crypto currency in
                  which the amount is deposited. The asset is provided by the
                  unique code that identifies it (if you don't have the asset's
                  code, contact our support).
              externalId:
                type: string
                description: >-
                  This parameter allows you to insert an Internal ID (from your
                  own system) to better keep track of these operations.
              qr:
                type: boolean
                description: >-
                  This parameter (set as FALSE by default), if checked as TRUE,
                  indicates that you want the base64 encoded qr code for this
                  wallet to be included as part of the response so you can
                  decode the base64 string and display it as
                  data:image/png;base64).
                default: false
            required:
              - amount
          examples:
            Example 1:
              value:
                amount: '10.12'
                asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
    Exchange:
      content:
        application/x-www-form-urlencoded:
          schema:
            type: object
            required:
              - fromAsset
              - toAsset
              - amount
            properties:
              fromAsset:
                type: string
                format: uuid
                description: >-
                  This parameter allows you to determine the crypto currency
                  from what the determined amount will be converted from.
              toAsset:
                type: string
                format: uuid
                description: >-
                  This parameter allows you to determine the crypto currency to
                  what the amount of the from crypto currency will be converted
                  to.
              amount:
                type: string
                description: >-
                  This parameter allows you to determine the amount of the
                  crypto currency that will be converted into another crypto
                  currency.
              externalId:
                type: string
                description: >-
                  This parameter allows you to insert an Internal ID (from your
                  own system) to better keep track of these operations.
              accountId:
                type: string
                format: uuid
                description: >-
                  This parameter allows you to insert an Account ID if this
                  operation is related to an Account.
              freezeRateId:
                x-stoplight:
                  id: 49135418qvk59
                description: >-
                  This parameter allows you to insert a freeze id provided by
                  the /estimate endpoint. If a frozen exchange rate with such id
                  exists, this exchange rate will be used instead of the current
                  exchange rate.
                type: string
                format: uuid
    ExchangeAuto:
      content:
        application/x-www-form-urlencoded:
          schema:
            type: object
            properties:
              fromAsset:
                type: string
                format: uuid
              toAsset:
                type: string
                format: uuid
            required:
              - fromAsset
              - toAsset
    ExchangePairList:
      content:
        application/x-www-form-urlencoded:
          schema:
            type: object
            properties:
              fromAsset:
                type: string
                format: uuid
                description: >-
                  This parameter displays the crypto currency to be converted
                  from.
              toAsset:
                type: string
                format: uuid
                description: >-
                  This parameter displays the crypto currency to be converted
                  to.
              autoExchangeEnabled:
                type: boolean
                description: >-
                  This parameter indicates if the from crypto currency and to
                  crypto currency can be converted automatically.
              enabled:
                type: boolean
                description: >-
                  This parameter indicates if the from crypto currency and to
                  crypto currency pair is available to be converted.
    OperationReport:
      content:
        application/x-www-form-urlencoded:
          schema:
            type: object
            properties:
              from:
                type: string
                format: date
                description: >
                  This parameter allows you to indicate the start date of the
                  report time range.
              to:
                type: string
                format: date
                description: >
                  This parameter allows you to indicate the end date of the
                  report time range.
              status:
                type: string
                enum:
                  - CREATED
                  - PENDING
                  - PROCESSING
                  - PAID
                  - UNDERPAID
                  - EXPIRED
                  - FAILED
                  - SUCCESS
                  - EXCHANGING
                description: >
                  This parameter allows you to indicate the status to filter the
                  report (CREATED, PENDING, PROCESSING, PAID, UNDERPAID,
                  EXPIRED, FAILED, SUCCESS or EXCHANGING). Leaving the filed
                  empty generates a report with all statuses.
              asset:
                type: string
                format: uuid
                description: >
                  This parameter allows you to indicate the crypto currency to
                  filter the report. Leaving the field empty generates a report
                  with all assets.
              order:
                type: string
                description: >
                  This parameter allows you to indicate the order to filter the
                  report.
              type:
                type: string
                enum:
                  - DEPOSIT
                  - ORDER
                  - WITHDRAWAL
                  - EXCHANGE
                  - PAYOUT
                description: >
                  This parameter allows you to indicate thetype to filter the
                  report (DEPOSIT, WITHDDRAWAL, EXCHANGE, or PAYOUT). Leaving
                  the field empty generates a report with all assets.
              orderField:
                type: string
                description: >
                  This parameter allows you to indicate the order field to
                  filter the report.
              reportFormat:
                type: string
                enum:
                  - Xlsx
                  - Xls
                  - Csv
                description: >
                  This parameter allows you to indicate the format to generate
                  the report (XLXS, XLS, or CSV).
    PayoutCreate:
      content:
        application/x-www-form-urlencoded:
          schema:
            type: object
            description: Payout create object
            properties:
              amount:
                type: string
                description: >
                  This parameter displays the amount of the selected asset to
                  send to another wallet.
              destination:
                type: string
                description: >
                  this parameter displays the address of the wallet to receive
                  the inserted amount.
              asset:
                type: string
                format: uuid
                description: >
                  This parameter displays the selected crypto currency in which
                  the amount will be sent.
              treatAsGrossAmount:
                type: boolean
                default: false
                description: >-
                  This parameter indicates if the network fee is deducted from
                  the requested amount (set as True) or from your account (set
                  as False, by default). This allows you to define who is
                  charged with the network fee (the payout receiver or you).
              externalId:
                type: string
                description: >-
                  This parameter allows you to insert an Internal ID (from your
                  own system) to better keep track of these operations.
              fromAddress:
                type: string
                description: >-
                  This optional parameter allows you to specify an address of an
                  account wallet from which you want to make a payout.
              walletTag:
                type: string
                x-stoplight:
                  id: vdeqj7gjje0fb
                description: >-
                  This optional parameter allows you to insert the unique
                  numerical code, required by some blockchains, to pair with the
                  deposit address, as an additional security measure.
              exchange:
                type: boolean
                x-stoplight:
                  id: tzns5e27lup56
                description: >-
                  Set this parameter to `true` if the payout requires an asset
                  exchange before being processed. When enabled, the system will
                  exchange the `asset` from your available balance into the one
                  specified in `requestedAsset`. The recipient will receive the
                  equivalent of `amount` in `requestedAsset`, minus any
                  applicable fees.
              requestedAsset:
                type: string
                x-stoplight:
                  id: u64aepgih6a5i
                format: uuid
                description: >-
                  This parameter indicates the asset the funds should be
                  converted to before payout is processed. Mandatory if
                  `exchange` is `true`.
              treatAsRequestedAmount:
                type: boolean
                x-stoplight:
                  id: fsnml8413775o
                description: >-
                  This parameter determines, whether the `amount` value refers
                  to the requested asset amount. If `treatAsRequestedAmount` is
                  `true`, exchange should be `true` as well. If
                  `treatAsRequestedAmount` is `true`, requestedAsset must be
                  provided.
    PaymentLinkCreate:
      content:
        application/x-www-form-urlencoded:
          schema:
            type: object
            properties:
              name:
                type: string
                description: This parameter displays the name given to the payment link.
              description:
                type: string
                description: >-
                  This parameters displays the description given to the payment
                  link's target.
              amount:
                type: string
                description: >-
                  This parameter displays the amount associated to the payment
                  link. This field can be left empty as it is not mandatory.
              asset:
                type: string
                format: uuid
                description: >-
                  This parameters displays the crypto currency associated to the
                  payment link.
              clientEmail:
                type: string
                x-stoplight:
                  id: jc7odlykkf574
                description: >-
                  This parameter displays the client email which will receive
                  notifications concerning the operation.
              externalId:
                type: string
                x-stoplight:
                  id: 6rum4w41dnim3
                description: >-
                  This parameter displays the external ID that can be used to
                  identify the payment link in your own systems.
              expirationDate:
                type: string
                format: date-time
                x-stoplight:
                  id: wqhd92hxfifko
                description: >-
                  This parameter displays the desired date until which the link
                  is available.
    OperationList:
      content:
        application/x-www-form-urlencoded:
          schema:
            type: object
            properties:
              from:
                type: string
                format: date
                description: >
                  This parameter allows you to indicate the start date of the
                  report time range.
              to:
                type: string
                format: date
                description: >
                  This parameter allows you to indicate the end date of the
                  report time range.
              status:
                type: string
                enum:
                  - CREATED
                  - PENDING
                  - PROCESSING
                  - PAID
                  - UNDERPAID
                  - EXPIRED
                  - FAILED
                  - SUCCESS
                  - EXCHANGING
                  - EXCHANGE_FAILED
                description: >
                  This paramater allows to indicate the operation status to be
                  displayed (hiding all other statuses).
              asset:
                type: string
                format: uuid
                description: >
                  This paramater allows to indicate the crypto currency used on
                  the operation (hiding all other assets).
              assetFrom:
                type: string
                x-stoplight:
                  id: mh5yhkw4sokx7
                format: uuid
                description: >-
                  This parameter allows to indicate the crypto currency being
                  exchanged or spent in the transaction.
              type:
                type: string
                enum:
                  - DEPOSIT
                  - ORDER
                  - WITHDRAWAL
                  - EXCHANGE
                  - PAYOUT
                description: >
                  This paramater allows to indicate the type of operation
                  (hiding all other operation types).
              order:
                type: string
                enum:
                  - ASC
                  - DESC
                description: >
                  This paramater allows to indicate the way the list is
                  displayed (ascending or desceding).
              orderField:
                type: string
                enum:
                  - operationId
                  - asset
                  - createdAt
                  - clientEmail
                  - amount
                  - status
                  - type
                description: >
                  This paramater allows to indicate the order to display the
                  fields.
              search:
                type: string
                description: >
                  This paramater allows to indicate the partial code of the
                  redId to be displayed (hiding all entries whose refID does not
                  match the partial code).
              accounts:
                type: array
                description: |
                  This paramater allows to filter by account ID.
                items:
                  type: string
                  format: uuid
              orFilter[asset][]:
                type: array
                x-stoplight:
                  id: xxtfvh5brkw9d
                description: >-
                  This parameter allows to filer the results by multiple `asset`
                  values.
                items:
                  x-stoplight:
                    id: dgdy0xkwft6u9
                  type: string
                  format: uuid
              orFilter[assetFrom][]:
                type: array
                x-stoplight:
                  id: n83w9tcplhtvl
                description: >-
                  This parameter allows to filer the results by multiple
                  `assetFrom` values.
                items:
                  x-stoplight:
                    id: nq2rt1yk9izkd
                  type: string
                  format: uuid
          examples:
            Example 1:
              value:
                from: '2019-08-24'
                to: '2019-08-24'
                status: CREATED
                asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
                type: DEPOSIT
                order: ASC
                orderField: operationId
                search: string
        application/xml:
          schema:
            type: object
            properties:
              from:
                type: string
              to:
                type: string
              status:
                type: string
              asset:
                type: string
      description: Operation list filter and order
    Callback:
      content:
        application/x-www-form-urlencoded:
          schema:
            type: object
            properties:
              url:
                type: string
                description: >
                  This parameter allows you to indicate the url path to receive
                  the callbacks.
              active:
                type: boolean
                default: true
                description: >
                  This parameter allows you to indicate if the callback url is
                  active to receive callbacks or not. (it is active by default).
    MassPayoutCreate:
      content:
        application/x-www-form-urlencoded:
          schema:
            type: object
            required:
              - title
            properties:
              title:
                type: string
                description: This parameter identifies the mass payout on the platform.
              data:
                type: string
                description: >-
                  CSV data for creating multiple payouts. Must contain actual
                  line breaks between rows (not `\n` escape sequences).


                  Format: destination,amount,asset,treatAsGrossAmount


                  **Note:** When using API tools, use Shift+Enter to create
                  actual line breaks in the form data field.
          examples:
            Example 1:
              value:
                title: string
                data: >-
                  destination,amount,asset,treatAsGrossAmount

                  0x92009d7A79d3813DD3309e663d3a77844EF675D4,0.001,0b47a85e-a66a-461c-bb1a-e818def2ff82,FALSE
    DirectDepositUpdate:
      content:
        application/json:
          schema:
            type: object
            properties:
              externalId:
                type: string
                description: >-
                  This parameter allows you to insert an Internal ID (from your
                  own system) to better keep track of these operations.
security:
  - HMAC: []
tags:
  - name: balance
  - name: callbacks
  - name: deposit
  - name: exchange
  - name: merchant
  - name: order
  - name: payment link
  - name: payout
  - name: top up
