openapi: 3.2.0
info:
  title: fiat-republic Simulator API
  version: '1.0'
servers:
- url: https://sandbox.fiatrepublic.com/api/v1
security:
- sec0: []
tags:
- name: Simulator
paths:
  /simulator/payment:
    post:
      summary: Create Payin
      description: Create a `COMPLETED` Payin on Sandbox to simulate the behaviour of Payins received from external bank accounts in the live environment. Payins created via this endpoint will also trigger events to relevant webhooks.
      operationId: create-payin
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - amount
              - from
              - paymentScheme
              - reference
              - toId
              properties:
                amount:
                  type: string
                  description: Amount of the payment.
                from:
                  type: object
                  description: Details of the Payer from who you want to simulate the payment.
                  required:
                  - type
                  - name
                  properties:
                    type:
                      type: string
                      description: Type of the Payer.
                      enum:
                      - PERSON
                      - BUSINESS
                    name:
                      type: string
                      description: Name of the Payer.
                    bankDetails:
                      type: object
                      description: Bank Details of the Payer.
                      properties:
                        accountNumber:
                          type: string
                        bic:
                          type: string
                        iban:
                          type: string
                        routingCodes:
                          type: object
                          properties:
                            type:
                              type: string
                              description: Type of the routing code. Either SORT_CODE or BSB
                              enum:
                              - SORT_CODE
                              - BSB
                            value:
                              type: string
                              description: Value of the routing code.
                        bankName:
                          type: string
                        bankAddressLine1:
                          type: string
                          description: First line of Bank's address.
                        bankAddressCity:
                          type: string
                          description: City
                        bankAddressPostalCode:
                          type: string
                          description: Postal/Zip code
                        bankAddressState:
                          type: string
                        bankAddressCountry:
                          type: string
                          description: Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom
                        bankCountry:
                          type: string
                          description: Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom
                    additionalDetails:
                      type: object
                      description: Address details of the Payer.
                      properties:
                        addressCity:
                          type: string
                        addressLine1:
                          type: string
                        addressLine2:
                          type: string
                        addressCountry:
                          type: string
                        addressPostalCode:
                          type: string
                          description: Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom
                paymentScheme:
                  type: string
                  description: Payment Scheme of the incoming payment you want to simulate.
                  enum:
                  - FPS
                  - CHAPS
                  - SCT
                reference:
                  type: string
                  description: Reference on the incoming payment. e.g. `deposit`.
                toId:
                  type: string
                  description: Id of the destination of the payment. Destination can be a Fiat Account or a Payee.
            examples:
              GBP Example:
                value:
                  from:
                    type: PERSON
                    name: John Doe
                    bankDetails:
                      routingCodes:
                      - type: SORT_CODE
                        value: '401276'
                      accountNumber: '12345658'
                      bankName: Hsbc Uk Bank Plc
                      bankCountry: GB
                  toId: vac_5opkx8g1jo50lz4m3e
                  amount: '1000'
                  paymentScheme: FPS
                  reference: Simulate Deposit
              EUR Example:
                value: "{\n  \"from\": {\n    \"type\": \"PERSON\",\n    \"name\": \"John Doe\",\n    \"bankDetails\": {\n        \"bankName\": \"BANKING CIRCLE S.A.\",\n        \"bankAddressLine1\": \"2 boulvard de la foire\",\n        \"bankAddressCity\": \"Luxembourg\",\n        \"bankAddressPostalCode\": \"1528\",\n        \"bankAddressState\": null,\n        \"bankAddressCountry\": \"LU\",\n        \"iban\": \"LU254080000024546498\",\n        \"bic\": \"BCIRLULLXXX\",\n        \"bankCountry\": \"LU\"\n    }\n    \"metadata\": null\n  },\n  \"toId\": \"fac_01010101010101\",\n  \"amount\": \"1000\",\n  \"paymentScheme\": \"SCT\",\n  \"reference\": \"Custom reference here\"\n}"
      responses:
        '202':
          description: '202'
          content:
            application/json:
              examples:
                Result:
                  value: ''
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Simulator
components:
  securitySchemes:
    sec0:
      type: oauth2
      flows: {}
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.fiatrepublic.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.fiatrepublic.com/reference/create-business-end-user.md
  - https://docs.fiatrepublic.com/reference/create-conversion.md
  - https://docs.fiatrepublic.com/reference/create-document.md
  - https://docs.fiatrepublic.com/reference/create-emt-payee.md
  - https://docs.fiatrepublic.com/reference/create-emt-payment.md
  - https://docs.fiatrepublic.com/reference/create-fiat-account.md
  - https://docs.fiatrepublic.com/reference/create-individual-end-user.md
  - https://docs.fiatrepublic.com/reference/create-payee.md
  - https://docs.fiatrepublic.com/reference/create-payin.md
  - https://docs.fiatrepublic.com/reference/create-payment.md
  - https://docs.fiatrepublic.com/reference/create-quote.md
  - https://docs.fiatrepublic.com/reference/create-return.md
  - https://docs.fiatrepublic.com/reference/create-virtual-account.md
  - https://docs.fiatrepublic.com/reference/create-webhook.md
  - https://docs.fiatrepublic.com/reference/delete-emt-payee.md
  - https://docs.fiatrepublic.com/reference/delete-payee.md
  - https://docs.fiatrepublic.com/reference/delete-webhook.md
  - https://docs.fiatrepublic.com/reference/get-business-end-user.md
  - https://docs.fiatrepublic.com/reference/get-business.md
  - https://docs.fiatrepublic.com/reference/get-conversion.md
  - https://docs.fiatrepublic.com/reference/get-documents.md
  - https://docs.fiatrepublic.com/reference/get-emt-payee.md
  - https://docs.fiatrepublic.com/reference/get-emt-payer.md
  - https://docs.fiatrepublic.com/reference/get-emt-payment.md
  - https://docs.fiatrepublic.com/reference/get-emt-wallet.md
  - https://docs.fiatrepublic.com/reference/get-fiat-account-copy.md
  - https://docs.fiatrepublic.com/reference/get-fiat-account.md
  - https://docs.fiatrepublic.com/reference/get-individual-end-user.md
  - https://docs.fiatrepublic.com/reference/get-member-details.md
  - https://docs.fiatrepublic.com/reference/get-member-review-settings.md
  - https://docs.fiatrepublic.com/reference/get-payee-verification.md
  - https://docs.fiatrepublic.com/reference/get-payee.md
  - https://docs.fiatrepublic.com/reference/get-payer.md
  - https://docs.fiatrepublic.com/reference/get-payment.md
  - https://docs.fiatrepublic.com/reference/get-return.md
  - https://docs.fiatrepublic.com/reference/get-transaction.md
  - https://docs.fiatrepublic.com/reference/get-virtual-account-transactions.md
  - https://docs.fiatrepublic.com/reference/get-virtual-account.md
  - https://docs.fiatrepublic.com/reference/get-webhook.md
  - https://docs.fiatrepublic.com/reference/list-business-end-users.md
  - https://docs.fiatrepublic.com/reference/list-conversions.md
  - https://docs.fiatrepublic.com/reference/list-emt-payees.md
  - https://docs.fiatrepublic.com/reference/list-emt-payers.md
  - https://docs.fiatrepublic.com/reference/list-emt-payments.md
  - https://docs.fiatrepublic.com/reference/list-emt-wallets.md
  - https://docs.fiatrepublic.com/reference/list-fiat-accounts.md
  - https://docs.fiatrepublic.com/reference/list-individual-end-users.md
  - https://docs.fiatrepublic.com/reference/list-member-businesses.md
  - https://docs.fiatrepublic.com/reference/list-payee.md
  - https://docs.fiatrepublic.com/reference/list-payers.md
  - https://docs.fiatrepublic.com/reference/list-payments.md
  - https://docs.fiatrepublic.com/reference/list-returns.md
  - https://docs.fiatrepublic.com/reference/list-transactions.md
  - https://docs.fiatrepublic.com/reference/list-virtual-accounts.md
  - https://docs.fiatrepublic.com/reference/list-webhook-notifications.md
  - https://docs.fiatrepublic.com/reference/list-webhooks.md
  - https://docs.fiatrepublic.com/reference/payee-verification-review.md
  - https://docs.fiatrepublic.com/reference/payment-review.md
  - https://docs.fiatrepublic.com/reference/transactions-summary.md
  - https://docs.fiatrepublic.com/reference/update-business-end-user.md
  - https://docs.fiatrepublic.com/reference/update-document.md
  - https://docs.fiatrepublic.com/reference/update-fiat-account.md
  - https://docs.fiatrepublic.com/reference/update-individual-end-user.md
  - https://docs.fiatrepublic.com/reference/update-member-review-settings.md
  - https://docs.fiatrepublic.com/reference/update-payee.md
  - https://docs.fiatrepublic.com/reference/update-virtual-account.md
  - https://docs.fiatrepublic.com/reference/update-webhook.md
  - https://docs.fiatrepublic.com/reference/validate-payee.md
  - https://docs.fiatrepublic.com/reference/verify-payee.md
  merge:
    pages: 69
    deduped: 68
    conflicts_kept_first: 0