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

# Simulate a fiat deposit

> Simulates a bank transfer credited to the project's master collateral account. The deposit is recorded as already settled, the master balance is credited, and `FIAT_DEPOSIT_CREATED` is delivered, matching what a reconciled transfer does in production. Only available to Program-Funded projects, which are the ones that have a master collateral account. Pass `originalAmount` and `originalCurrency` together to simulate a transfer that was converted on the way in.



## OpenAPI

````yaml /api-reference/openapi.json post /simulation/fiat-deposits
openapi: 3.1.0
info:
  title: Reap API
  version: 1.0.0
  description: Reap platform API
servers:
  - url: https://sandbox.api.reap.global
    description: Sandbox
  - url: https://prod.api.reap.global
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Accounts
  - name: Activities
  - name: Card Designs
  - name: Card Shipments
  - name: Card Transactions
  - name: Cards
  - name: Companies
  - name: Crypto Deposits
  - name: Disputes
  - name: Fiat Deposits
  - name: Fraud Alerts
  - name: Policies
  - name: Simulation
  - name: Users
  - name: Virtual Asset Postings
  - name: Virtual Assets
  - name: Webhooks
paths:
  /simulation/fiat-deposits:
    post:
      tags:
        - Simulation
      summary: Simulate a fiat deposit
      description: >-
        Simulates a bank transfer credited to the project's master collateral
        account. The deposit is recorded as already settled, the master balance
        is credited, and `FIAT_DEPOSIT_CREATED` is delivered, matching what a
        reconciled transfer does in production. Only available to Program-Funded
        projects, which are the ones that have a master collateral account. Pass
        `originalAmount` and `originalCurrency` together to simulate a transfer
        that was converted on the way in.
      operationId: fiatDeposit_simulation
      parameters:
        - name: Reap-Version
          in: header
          required: true
          schema:
            type: string
            enum:
              - '2025-02-14'
            description: API version (YYYY-MM-DD)
            example: '2025-02-14'
      requestBody:
        description: >-
          Simulate a bank transfer credited to the project's master collateral
          account
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: number
                  exclusiveMinimum: 0
                  examples:
                    - 100.5
                    - 0
                    - 1234.99
                  description: >-
                    Amount credited to the master account, in the project's
                    billing currency
                originalAmount:
                  description: >-
                    Amount the sending bank transferred, when the transfer was
                    converted on the way in. Must be provided together with
                    `originalCurrency`. Defaults to `amount`.
                  type: number
                  exclusiveMinimum: 0
                originalCurrency:
                  description: >-
                    Currency the transfer was sent in as an ISO 4217 alpha code
                    (e.g. `EUR`). Must be provided together with
                    `originalAmount`. Defaults to the project's billing
                    currency.
                  type: string
                  pattern: ^[A-Z]{3}$
                senderName:
                  examples:
                    - MOON INC LIMITED
                  description: Name of the sender. Randomly generated if omitted.
                  type: string
                  minLength: 1
                  maxLength: 255
                reference:
                  examples:
                    - INV-2024-0142
                  description: >-
                    Reference the sender attached to the transfer. Absent if
                    omitted.
                  type: string
                  minLength: 1
                  maxLength: 255
              required:
                - amount
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                amount:
                  type: number
                  exclusiveMinimum: 0
                  examples:
                    - 100.5
                    - 0
                    - 1234.99
                  description: >-
                    Amount credited to the master account, in the project's
                    billing currency
                originalAmount:
                  description: >-
                    Amount the sending bank transferred, when the transfer was
                    converted on the way in. Must be provided together with
                    `originalCurrency`. Defaults to `amount`.
                  type: number
                  exclusiveMinimum: 0
                originalCurrency:
                  description: >-
                    Currency the transfer was sent in as an ISO 4217 alpha code
                    (e.g. `EUR`). Must be provided together with
                    `originalAmount`. Defaults to the project's billing
                    currency.
                  type: string
                  pattern: ^[A-Z]{3}$
                senderName:
                  examples:
                    - MOON INC LIMITED
                  description: Name of the sender. Randomly generated if omitted.
                  type: string
                  minLength: 1
                  maxLength: 255
                reference:
                  examples:
                    - INV-2024-0142
                  description: >-
                    Reference the sender attached to the transfer. Absent if
                    omitted.
                  type: string
                  minLength: 1
                  maxLength: 255
              required:
                - amount
          multipart/form-data:
            schema:
              type: object
              properties:
                amount:
                  type: number
                  exclusiveMinimum: 0
                  examples:
                    - 100.5
                    - 0
                    - 1234.99
                  description: >-
                    Amount credited to the master account, in the project's
                    billing currency
                originalAmount:
                  description: >-
                    Amount the sending bank transferred, when the transfer was
                    converted on the way in. Must be provided together with
                    `originalCurrency`. Defaults to `amount`.
                  type: number
                  exclusiveMinimum: 0
                originalCurrency:
                  description: >-
                    Currency the transfer was sent in as an ISO 4217 alpha code
                    (e.g. `EUR`). Must be provided together with
                    `originalAmount`. Defaults to the project's billing
                    currency.
                  type: string
                  pattern: ^[A-Z]{3}$
                senderName:
                  examples:
                    - MOON INC LIMITED
                  description: Name of the sender. Randomly generated if omitted.
                  type: string
                  minLength: 1
                  maxLength: 255
                reference:
                  examples:
                    - INV-2024-0142
                  description: >-
                    Reference the sender attached to the transfer. Absent if
                    omitted.
                  type: string
                  minLength: 1
                  maxLength: 255
              required:
                - amount
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Unique fiat deposit identifier
                  accountId:
                    type: string
                    format: uuid
                    description: Account credited by the deposit
                  transactionId:
                    type: string
                    examples:
                      - 20240115HKHHXXXX000123456
                    description: >-
                      The bank's unique identifier for the incoming transfer.
                      Use it to reconcile the deposit against a bank statement.
                  status:
                    type: string
                    enum:
                      - SETTLED
                    description: Current deposit status
                    example: SETTLED
                  amount:
                    type: number
                    minimum: 0
                    examples:
                      - 100.5
                      - 0
                      - 1234.99
                    description: Amount credited to the account balance
                  currency:
                    type: string
                    examples:
                      - USD
                      - HKD
                      - EUR
                    description: Currency the credit was applied in
                  originalAmount:
                    type: number
                    minimum: 0
                    examples:
                      - 100.5
                      - 0
                      - 1234.99
                    description: Amount of the incoming transfer, as received by the bank
                  originalCurrency:
                    type: string
                    examples:
                      - USD
                      - HKD
                      - EUR
                    description: >-
                      Currency the transfer was sent in. Differs from `currency`
                      when the transfer was converted on the way in; `amount`
                      divided by `originalAmount` is the rate that was applied.
                  senderName:
                    anyOf:
                      - type: string
                      - type: 'null'
                    examples:
                      - MOON INC LIMITED
                    description: Name of the sender, when the bank reported one
                  reference:
                    anyOf:
                      - type: string
                      - type: 'null'
                    examples:
                      - INV-2024-0142
                    description: >-
                      Reference the sender attached to the transfer, when
                      present
                  occurredAt:
                    type: string
                    examples:
                      - '2024-01-15T10:30:00Z'
                    description: ISO 8601 timestamp of when the bank received the transfer
                  createdAt:
                    type: string
                    examples:
                      - '2024-01-15T10:30:00Z'
                    description: ISO 8601 timestamp of creation
                  updatedAt:
                    type: string
                    examples:
                      - '2024-01-15T10:35:00Z'
                    description: ISO 8601 timestamp of last update
                required:
                  - id
                  - accountId
                  - transactionId
                  - status
                  - amount
                  - currency
                  - originalAmount
                  - originalCurrency
                  - senderName
                  - reference
                  - occurredAt
                  - createdAt
                  - updatedAt
        '400':
          description: The resource is not in a valid state for the requested simulation
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        const: SIMULATION_INVALID_STATE
                      message:
                        type: string
                      detail:
                        anyOf:
                          - type: object
                            additionalProperties: {}
                          - type: 'null'
                    required:
                      - code
                      - message
                      - detail
                required:
                  - error
                title: SimulationInvalidStateError
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key as Bearer token

````