> ## Documentation Index
> Fetch the complete documentation index at: https://nextgen-docs.enfuce.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Send an clearing request

> Creates a clearing request for authorisation request




## OpenAPI

````yaml json-files/mycore-test-api.openapi.json post /v1/clearing/request
openapi: 3.0.3
info:
  version: '1'
  title: Test API
  description: >
    Available in the integration environment. Use this API to simulate payment
    card transactions

    for integration testing and card programme.


    All endpoints require **HTTP Basic Authentication** with the `CAT2_API_ALL`
    role.
servers:
  - url: https://test-api.ext-uat1-sandbox.mycore.enfuce.com/test-api
security:
  - basicAuth: []
tags:
  - name: authorizations
    description: Send authorisation, reversal, advice, and adjustment messages.
  - name: incremental
    description: >-
      Incremental authorisation — add authorized amount on top of an existing
      authorization.
  - name: stip
    description: Stand-In Processing — simulate scheme-initiated authorization decisions.
  - name: batch-transactions
    description: Run a full transaction lifecycle in one call.
  - name: legacy
    description: Legacy load-testing endpoint.
paths:
  /v1/clearing/request:
    post:
      tags:
        - Clearing
      summary: Send an clearing request
      description: |
        Creates a clearing request for authorisation request
      operationId: postClearing
      parameters:
        - $ref: '#/components/parameters/auditUser'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/clearingRequest'
            example:
              id: '123456789012345678'
      responses:
        '200':
          description: Clearing processed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/clearingResponse'
        '400':
          $ref: '#/components/responses/badRequest'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
        '500':
          $ref: '#/components/responses/internalServerError'
components:
  parameters:
    auditUser:
      name: auditUser
      in: query
      description: Identifier of the user performing the action, used for audit logging.
      required: true
      schema:
        type: string
  schemas:
    clearingRequest:
      description: Clearing request
      type: object
      properties:
        id:
          $ref: '#/components/schemas/docId'
        clearingAmount:
          $ref: '#/components/schemas/moneyAmount'
        card:
          $ref: '#/components/schemas/cardRequestData'
        merchantData:
          $ref: '#/components/schemas/merchantRequestData'
        transactionType:
          $ref: '#/components/schemas/transactionType'
        isFinal:
          type: boolean
          description: Whether this is the final clearing request.
          default: true
      required:
        - id
        - clearingAmount
        - card
        - merchantData
        - transactionType
    clearingResponse:
      description: Clearing response
      type: object
      properties:
        transactionId:
          type: string
          description: Clearing transaction identifier.
        filename:
          type: string
          description: Name of the clearing file.
    docId:
      type: string
      description: Unique authorization identifier (internal docId / ISO 8583 DE37).
      maxLength: 18
    moneyAmount:
      description: A monetary amount with currency.
      type: object
      required:
        - amount
        - currency
      properties:
        amount:
          type: number
          minimum: 0
          example: 25
        currency:
          type: string
          description: ISO 4217 currency code.
          example: EUR
    cardRequestData:
      description: Card used in the transaction.
      type: object
      required:
        - cardId
      properties:
        cardId:
          type: string
          description: Card identifier.
        applicationSelection:
          $ref: '#/components/schemas/applicationSelection'
    merchantRequestData:
      description: Merchant and acquirer data (ISO 8583 DE18, DE32, DE41–43).
      type: object
      required:
        - merchantId
        - merchantName
        - merchantCity
        - merchantCountry
        - merchantCategoryCode
        - acquirerId
        - acquirerCountry
        - terminalId
      properties:
        merchantId:
          type: string
          description: Uniquely identifies the card acceptor (ISO 8583 DE42).
          maxLength: 15
        subMerchantId:
          type: string
          maxLength: 15
        merchantName:
          type: string
          description: Merchant name (part of ISO 8583 DE43).
          maxLength: 25
        merchantCity:
          type: string
          description: City where the transaction occurred (part of ISO 8583 DE43).
          maxLength: 13
        merchantCountry:
          $ref: '#/components/schemas/country'
        merchantCategoryCode:
          type: string
          description: >
            Merchant category code per card scheme classification (ISO 8583
            DE18).

            Use `6011` for ATM transactions.
          maxLength: 4
          example: '5812'
        acquirerId:
          type: string
          description: Financial institution acting as the acquirer (ISO 8583 DE32).
          maxLength: 11
        acquirerCountry:
          $ref: '#/components/schemas/country'
        terminalId:
          type: string
          description: Uniquely identifies the terminal at the merchant (ISO 8583 DE41).
          maxLength: 8
        partialApprovalCapable:
          type: boolean
          description: >-
            Whether the merchant accepts partial approval of the requested
            amount.
    transactionType:
      type: string
      description: |
        The transaction type.
        - `ATM` requires `merchantCategoryCode: 6011`
      enum:
        - RETAIL
        - CASH
        - ATM
        - CREDIT
        - UNIQUE
        - P2P_CREDIT
        - P2P_DEBIT
        - BALANCE_INQUIRY
    errorResponse:
      description: Standard error response.
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        id:
          type: string
          format: uuid
        errorCode:
          type: string
        errorType:
          type: string
          enum:
            - STATIC_VALIDATION_ERROR
            - DYNAMIC_VALIDATION_ERROR
            - INTEGRATION_ERROR
            - SECURITY_ERROR
            - UNEXPECTED_ERROR
        errorReason:
          type: string
        timestamp:
          type: string
          format: date-time
    applicationSelection:
      type: string
      description: Card application selected for the transaction (for combo cards).
      enum:
        - credit
        - debit
    country:
      type: string
      description: ISO 3166-1 alpha-3 country code.
      example: FIN
  responses:
    badRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
    unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
    forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
    notFound:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
    internalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Auth. Credentials must carry the `CAT2_API_ALL` role.

````