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

# Simulate L2l3

> > 🚧 Alpha
> This is a Alpha endpoint. Feedback from the community is welcome. We may make breaking changes to this endpoint.

Simulate a l2l3 type transaction by including the original_transaction_id and enhanced data in your request.

L2L3 events enhance the data of a transaction with the `l2l3` details from your request.




## OpenAPI

````yaml openapi.json post /cards/transaction_simulations/clearing/l2l3
openapi: 3.0.3
info:
  description: >-
    This is the official reference documentation for Synctera APIs. If you need
    something specific or have a question, <a class='text-blue-600'
    href='https://synctera.com/contact-us' target='_blank'
    rel='noreferrer'>contact us</a>.</p>
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: Synctera API
  version: 0.213.0
servers:
  - description: Sandbox (no real world financial impact)
    url: https://api-sandbox.synctera.com/v0
  - description: Production
    url: https://api.synctera.com/v0
security:
  - bearerAuth: []
tags:
  - description: Lookup merchant information
    name: Merchants
  - description: Requests to generate simulated webhooks
    name: Card Webhook Simulations
  - description: >-
      Account programs define configurations for payment rails and transaction
      capabilities across different account types.
    name: Account Programs
  - description: Simulate receiving ACH transactions and returns
    name: ACH Transaction Simulations
  - description: Requests for risk evaluation and decisioning
    name: Risk Evaluations
  - description: Requests to link and manage External Cards
    name: External Cards
  - description: |
      The disclosures resource is used to track the status of disclosures and
      ensure that all parties have been shown the necessary disclosures to meet
      regulatory obligations.
    name: Disclosures
  - description: Create and manage Cash Order and Cash Deposit transfers
    name: Cash Orders and Deposits (alpha)
  - description: Requests to initiate customer verification.
    name: KYC Verification (deprecated)
  - description: Request to create and manage users
    name: Users
  - description: See balance history
    name: BalanceHistory
  - description: >-
      Migration mappings associate resources from an old tenant identity with a
      new tenant identity.
    name: Migration Mappings
  - description: |
      The External Account resource is used for managing links to accounts
      that operate outside of the Synctera ecosystem.
    name: External Accounts
  - description: Requests to create and manage account products, including fees, interest.
    name: Account Products
  - description: Requests to create and manage webhooks
    name: Webhooks
  - description: Create and manage documents.
    name: Documents
  - description: >-
      Create and manage same currency and multi-currency international wire
      transfers
    name: International Wires (alpha)
  - description: Requests for transaction risk detection
    name: Transaction risk
  - description: >-
      Used to configure bank accounts for which synctera accounts are considered
      a "subledger" to
    name: Bank Account
  - description: Request to create and manage party groups and party group members
    name: Party Groups
  - description: Requests to manage addresses
    name: Addresses
  - description: Requests to manage monitoring subscriptions and alerts for customers.
    name: Monitoring
  - description: Requests to search and manage compliance searches
    name: Compliance Searches
  - description: Requests to create and manage customers
    name: Customers
  - description: |
      The internal account resource is used for managing links to internal
      accounts where the funds are managed by integrators.
    name: Internal Accounts
  - description: Create and manage spending controls
    name: Spend Controls
  - description: Retrieve user identity information
    name: Identity
  - description: Requests to manage banks
    name: Banks
  - description: |
      The Disclosures resource is used to track the status of disclosures and
      ensure that customers have been shown the necessary disclosures to meet
      regulatory obligations.
    name: Disclosures (deprecated)
  - description: Create and manage wire transfers
    name: Wires
  - description: Requests to issue and manage Cards
    name: Cards
  - description: Request to create and manage edd
    name: Trust
  - description: Request to enroll, renew, or cancel watchlist monitors
    name: Watchlist (deprecated)
  - description: Endpoints for modifying or fetching posting dates
    name: Posting Dates
  - description: Transaction lines API
    name: transactions
  - description: Request to create and manage accounts
    name: Accounts
  - description: Requests to create and manage notes
    name: Notes
  - description: Account Template
    name: Account Templates
  - description: API for effective balances
    name: effective_balances
  - description: Requests to create and manage personal ID configurations
    name: Personal ID Configuration
  - description: >
      A natural person (individual human) that is relevant to the Synctera
      platform in some way: e.g. a personal customer or a director/officer/owner
      of a business.
    name: Persons
  - description: >
      Represents the relationships between parties. A relationship can exist
      between personal customers, business customers, or non-customer
      persons/organizations.
    name: Relationships
  - description: >
      A legal entity (corporation, partnership, etc.) that is relevant to the
      Synctera platform in some way: a business customer or some other
      organization that has an ownership share in such a business customer.
    name: Businesses
  - description: Request to create and manage payment_schedules
    name: Cronut
  - description: Requests to manage partners
    name: Partners
  - description: Request to create and manage deposits using remote deposit capture
    name: Remote Check Deposit
  - description: Requests to create and manage API keys
    name: API Keys
  - description: Requests to create and manage ban rules
    name: Ban Rules
  - description: Admin API for Middesk configuration using the tenants API keys.
    name: Middesk
  - description: Request to create and manage exclusions
    name: Stately
  - description: Request to create and manage partner configurations
    name: Quickstart
  - description: Manage contacts for bank and fintech partners
    name: Contacts
  - description: Create and manage transactions
    name: Transactions
  - description: Request to create and manage rdc configurations
    name: RDC Config
  - description: Create and manage holds
    name: Hold
  - description: Requests to create and manage roles
    name: Roles
  - description: Simulate receiving Wire transactions and returns
    name: Wire Transaction Simulations
  - description: Requests to create licenses
    name: Licenses
  - description: Requests to Admins to grant permissions to user
    name: Request Permissions
  - description: Configure vendor secrets for egress requests
    name: Egress Gateway Vendor Secret CRUD API
  - description: Requests to screen parties against sanctions watchlists
    name: Sanctions Screening
  - description: Create and manage payments
    name: ACH
  - description: Requests to calculate and manage CRR
    name: CRR
  - description: Requests to search financial institutions
    name: Institutions (Beta)
  - description: Create and manage tenant configurations
    name: Tenant Configs
  - description: Create and manage sweep configurations
    name: Configs
  - description: >
      Represents the compliance rules that are used to verify certain kinds of
      money movement.
    name: Compliance Rules
  - description: Configure webhook secrets for egress requests
    name: Egress Gateway Webhook Secret CRUD API
  - description: Create and manage transactions
    name: Transactions (internal)
  - description: History
    name: History
  - description: Create and manage EFT Canada transfers
    name: EFT Canada (Beta)
  - description: Requests to generate simulated transactions
    name: Card Transaction Simulations
  - description: Requests to initiate customer verification.
    name: KYC/KYB Verifications
paths:
  /cards/transaction_simulations/clearing/l2l3:
    summary: Simulate L2l3
    post:
      tags:
        - Card Transaction Simulations
      summary: Simulate L2l3
      description: >
        > 🚧 Alpha

        > This is a Alpha endpoint. Feedback from the community is welcome. We
        may make breaking changes to this endpoint.


        Simulate a l2l3 type transaction by including the
        original_transaction_id and enhanced data in your request.


        L2L3 events enhance the data of a transaction with the `l2l3` details
        from your request.
      operationId: simulatel2l3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/l2l3_model'
        description: L2l3 details
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/simulation_response_model'
          description: Success
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '500':
          $ref: '#/components/responses/internal_server_error'
components:
  schemas:
    l2l3_model:
      properties:
        enhanced_data_id:
          example: ED123456
          type: string
        financial:
          $ref: '#/components/schemas/financial'
        fleet_emv:
          $ref: '#/components/schemas/fleets_emv'
        fleets:
          $ref: '#/components/schemas/fleets'
        inventory_details:
          items:
            $ref: '#/components/schemas/inventory_details'
          type: array
        original_transaction_id:
          description: >-
            Value of the `transaction.token` returned in the simulated clearing
            response.
          type: string
        purchase_order:
          example: PO987654
          type: string
      required:
        - original_transaction_id
      type: object
    simulation_response_model:
      type: object
    financial:
      properties:
        tax_id:
          example: TAX123
          type: string
        total_tax_amount:
          example: 200
          format: int64
          type: integer
        total_tax_amount_indicator:
          example: Indicator
          type: string
      type: object
    fleets_emv:
      properties:
        employee_number:
          example: EMP001
          type: string
        expanded_fuel_type:
          example: TypeC
          type: string
        fuel_gross_amount:
          example: 165
          format: int64
          type: integer
        fuel_net_amount:
          example: 150
          format: int64
          type: integer
        fuel_quantity:
          example: 40
          format: float
          type: number
        fuel_unit_of_measure:
          example: Gallons
          type: string
        fuel_unit_price:
          example: 1.1
          format: float
          type: number
        non_fuel_gross_amount:
          example: 275
          format: int64
          type: integer
        non_fuel_item_details:
          items:
            $ref: '#/components/schemas/non_fuel_item_details'
          type: array
        non_fuel_net_amount:
          example: 250
          format: int64
          type: integer
        odometer_reading:
          example: '654321'
          type: string
        service_type:
          example: Repair
          type: string
        trailer_number:
          example: TR002
          type: string
        type_of_purchase:
          example: Non-Fuel
          type: string
        vat_tax_rate:
          example: 0.15
          format: float
          type: number
      type: object
    fleets:
      properties:
        driver_id:
          example: DR789
          type: string
        expanded_fuel_type:
          example: TypeB
          type: string
        fleet_number:
          example: FL123
          type: string
        fuel_gross_amount:
          example: 220
          format: int64
          type: integer
        fuel_net_amount:
          example: 200
          format: int64
          type: integer
        fuel_product_qualifier:
          example: QualifierA
          type: string
        fuel_purchase_type:
          example: TypeA
          type: string
        fuel_quantity:
          example: 50
          format: float
          type: number
        fuel_service_type:
          example: ServiceA
          type: string
        fuel_tax_amount:
          example: 20
          format: int64
          type: integer
        fuel_tax_exemption_status:
          example: Exempt
          type: string
        fuel_type:
          example: Diesel
          type: string
        fuel_unit_of_measure:
          example: Liters
          type: string
        fuel_unit_price:
          example: 1.5
          format: float
          type: number
        job_number:
          example: JN456
          type: string
        non_fuel_gross_amount:
          example: 330
          format: int64
          type: integer
        non_fuel_item_details:
          items:
            $ref: '#/components/schemas/non_fuel_item_details'
          type: array
        non_fuel_net_amount:
          example: 300
          format: int64
          type: integer
        non_fuel_tax_amount:
          example: 30
          format: int64
          type: integer
        non_fuel_tax_exemption_status:
          example: Non-Exempt
          type: string
        odometer_reading:
          example: '123456'
          type: string
        sales_tax_amount:
          example: 100
          format: int64
          type: integer
        service_type:
          example: Maintenance
          type: string
        type_of_purchase:
          example: Fuel
          type: string
        vat_tax_rate:
          example: 0.15
          format: float
          type: number
        vehicle_id:
          example: VH012
          type: string
      type: object
    inventory_details:
      properties:
        commodity_code:
          example: COM123
          type: string
        description:
          example: Item description
          type: string
        discount_amount:
          example: '5.00'
          type: string
        item_detail_taxes:
          items:
            $ref: '#/components/schemas/item_detail_taxes'
          type: array
        item_discount_amount:
          example: 500
          type: integer
        item_discount_amount_indicator:
          example: D
          type: string
        item_discount_applied_indicator:
          example: 'true'
          type: string
        item_discount_rate:
          example: 10
          type: integer
        item_extended_amount:
          example: 1000
          type: integer
        item_extended_amount_indicator:
          example: E
          type: string
        item_total_amount:
          example: 1500
          type: integer
        item_total_amount_indicator:
          example: T
          type: string
        item_vat_amount:
          example: 200
          type: integer
        item_vat_rate:
          example: 20
          type: integer
        product_code:
          example: PROD123
          type: string
        quantity:
          example: 10
          format: float
          type: number
        total_amount:
          example: '1500.00'
          type: string
        unit_of_measure:
          example: Piece
          type: string
        unit_price:
          example: 100
          type: integer
        vat_tax_amount:
          example: '200.00'
          type: string
        vat_tax_rate:
          example: '0.20'
          type: string
      type: object
    error:
      description: >-
        Synctera error responses in API v0 follow [RFC
        7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that
        standard, the field for a machine-readable "error code" in API v0 is
        `type`.

        In our future API v1, we are phasing out RFC 7807 and adopting a custom
        error format. That format will be documented in our API v1 spec. But you
        may see some v0 error responses with a machine-readable `code` field
        while we are making the transition from v0 to v1.
      properties:
        code:
          description: >-
            An optional “sneak preview” of our future API v1 error responses.
            This is provided to give integrators a chance to work with our
            future error codes. Error codes for the same error may change
            between v0 and v1.
          example: BAD_REQUEST_BODY
          type: string
        detail:
          description: |
            A human-readable string explaining this particular error.
          example: 'missing required fields: first_name, dob'
          type: string
        status:
          description: the HTTP status code for this response
          example: 400
          type: integer
        title:
          description: >
            A human-readable string for this general category of error, which
            corresponds 1-to-1 with error types (`title` is the human-readable
            version of `type`). There can be multiple distinct titles for the
            same HTTP status code, and the same `title` can result in many
            different `detail` strings.

            This field will be removed in API v1.
          example: Bad Request Body
          type: string
        type:
          description: >
            A machine-readable string that identifies the error for programmatic
            use. This is a URI, i.e. a globally unique identifier. It is _not_
            necessarily a URL, so do not expect it to resolve to a web page. You
            can use this whole string as an error code, or just everything after
            the last slash.

            This field will be removed in API v1.
          example: https://dev.synctera.com/errors/bad-request-body
          type: string
      title: Standard error response (RFC 7807 problem report)
      type: object
    non_fuel_item_details:
      properties:
        description:
          example: Item description
          type: string
        product_code:
          example: PC001
          type: string
        quantity:
          example: 10
          format: int64
          type: integer
        unit_of_measure:
          example: Units
          type: string
        unit_price:
          example: 15
          format: int64
          type: integer
      type: object
    item_detail_taxes:
      properties:
        detail_tax_amount:
          example: 1
          format: int64
          type: integer
        detail_tax_amount_inclusion_indicator:
          example: Included
          type: string
        detail_tax_amount_indicator:
          example: D
          type: string
        detail_tax_rate:
          example: 1
          format: int64
          type: integer
        detail_tax_type_applied:
          example: VAT
          type: string
        detail_tax_type_identifier:
          example: VAT123
          type: string
      type: object
  responses:
    bad_request:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
      description: BadRequest
    unauthorized:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
      description: Unauthorized
    forbidden:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
      description: Forbidden error
    internal_server_error:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
      description: Internal server error
  securitySchemes:
    bearerAuth:
      bearerFormat: api_key
      scheme: bearer
      type: http

````