openapi: 3.2.0
info:
  title: Caliza API documentation reference Transaction V1 Sandbox…
  description: The Caliza API enables seamless integration of financial services including payments, payouts, currency conversions, and compliance workflows.
  version: v1
  contact:
    name: Caliza API Support
    email: api-support@caliza.com
    url: https://docs.caliza.com
  termsOfService: https://caliza.com/terms
servers:
- url: https://api.sandbox.com
  description: Sandbox Environment
- url: https://api.caliza.com
  description: Production Environment
- url: https://api.sandbox.caliza.com
  description: Sandbox Environment (backoffice)
security:
- bearerAuth: []
tags:
- name: Transaction V1 Sandbox
  description: Sandbox-only transaction utilities for integration and testing. Simulate deposits, payouts and webhook notifications (PIX, SPEI, USD, etc.) without real funds to validate integration behavior and webhook handling.
paths:
  /v1/transactions/sandbox/crypto-deposit:
    post:
      tags:
      - Transaction V1 Sandbox
      summary: Simulate crypto deposit (sandbox)
      description: Creates a simulated cryptocurrency deposit arriving at a DFNS wallet in the sandbox environment. Use this to test crypto deposit detection, balance updates, webhook notifications, and any custom business logic that triggers on incoming blockchain transactions. Specify the beneficiary, wallet address, amount, blockchain network, and currency. Only available in sandbox mode.
      operationId: createFakeCryptoDeposit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MockCryptoDepositRequest'
        required: true
      responses:
        '200':
          description: OK
  /v1/transactions/sandbox/pix:
    post:
      tags:
      - Transaction V1 Sandbox
      summary: Simulate PIX deposit (sandbox)
      description: Creates a simulated PIX (Pix Instant Payment - Brazilian instant payment system) deposit for testing deposit flows, balance updates, and webhook notifications in the sandbox environment. PIX is Brazil's instant payment infrastructure. This endpoint allows you to test the complete deposit lifecycle without real funds or connecting to the Brazilian Central Bank's PIX network. Only available in sandbox mode.
      operationId: createFakePixInDeposit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MockDepositRequest'
        required: true
      responses:
        '200':
          description: OK
  /v1/transactions/sandbox/pixOutConfirmation:
    post:
      tags:
      - Transaction V1 Sandbox
      summary: Simulate PIX payout confirmation (sandbox)
      description: Triggers a simulated webhook event notification for PIX payout confirmation in the sandbox environment. Use this to test your webhook handlers for successful payout completion, verify your webhook processing logic handles PIX payout confirmations correctly, and test your user notification flows without waiting for real PIX network confirmations. This simulates the webhook that would be sent when a real PIX payout is confirmed by the Brazilian payment infrastructure. Only available in sandbox mode.
      operationId: createFakePixInDeposit_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MockWithdrawalRequest'
        required: true
      responses:
        '200':
          description: OK
  /v1/transactions/sandbox/spei:
    post:
      tags:
      - Transaction V1 Sandbox
      summary: Simulate SPEI deposit (sandbox)
      description: Creates a simulated SPEI (Sistema de Pagos Electrónicos Interbancarios - Mexican interbank electronic payment system) deposit for testing purposes in the sandbox environment. This allows you to test deposit flows, balance updates, and webhook notifications without processing real funds or connecting to actual Mexican banking infrastructure. Provide `transactionId` to settle an existing pending deposit (matched mode), or `clabe` and `amount` to simulate an unmatched deposit that auto-creates a transaction. Only available in sandbox mode.
      operationId: createFakeSpeiInDeposit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MockSpeiDepositRequest'
        required: true
      responses:
        '200':
          description: OK
  /v1/transactions/sandbox/travel-rule-clearance:
    post:
      tags:
      - Transaction V1 Sandbox
      summary: Simulate Travel Rule clearance (sandbox)
      description: Resolves the Travel Rule decision a transaction is waiting on in the sandbox environment, standing in for the counterparty that never responds there. For a crypto payout paused on Travel Rule clearance, AUTHORIZED lets the withdrawal resume and REJECTED keeps it under compliance review; for a crypto deposit held on its inbound Travel Rule message, AUTHORIZED credits the deposit and REJECTED keeps it held. Only available in sandbox mode.
      operationId: simulateTravelRuleClearance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MockTravelRuleClearanceRequest'
        required: true
      responses:
        '200':
          description: OK
        '404':
          description: The transaction has no Travel Rule to resolve (`travel-rule.transfer_not_found`)
        '422':
          description: The transaction's Travel Rule was already resolved (`travel-rule.clearance_not_applicable`)
  /v1/transactions/sandbox/usd-deposit:
    post:
      tags:
      - Transaction V1 Sandbox
      summary: Simulate USD deposit (sandbox)
      description: Creates a simulated USD deposit via wire transfer for testing international payment flows, balance updates, and webhook notifications in the sandbox environment. This simulates deposits from U.S. banks or international wire transfers. Use this to test your deposit handling logic, webhook processing, and balance reconciliation without processing actual funds or connecting to real banking infrastructure. Only available in sandbox mode.
      operationId: createFakeUSDDeposit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MockUSDepositRequest'
        required: true
      responses:
        '200':
          description: OK
components:
  schemas:
    MockUSDepositRequest:
      type: object
      description: Mock request to simulate a U.S. deposit for testing purposes in the sandbox environment.
      properties:
        beneficiaryId:
          type: string
        amount:
          type: number
        accountNumber:
          type: string
        paymentRail:
          type: string
          enum:
          - PIX
          - SPEI
          - WIRE
          - RTP
          - COP
          - CVU
          - LOCAL_EXCHANGE
          - CRYPTO_INTERNAL_TRANSFER
          - POLYGON
          - ETH
          - TRON
          - STELLAR
          - UNKNOWN
          - ACH
          - SWIFT
          - BASE
          - SOLANA
          - CALIZA_WALLET
          - MAIN_CALIZA_WALLET
          - ANY
    MockSpeiDepositRequest:
      type: object
      description: Mock request to simulate an incoming SPEI deposit in the sandbox environment. Provide `transactionId` to settle an existing pending deposit (matched mode), or `clabe` and `amount` to simulate an unmatched deposit that auto-creates a transaction. The two modes are mutually exclusive.
      properties:
        transactionId:
          type: string
          description: ID of an existing pending SPEI deposit to settle. Provide this or `clabe`, not both.
        clabe:
          type: string
          description: Destination CLABE for an unmatched deposit that auto-creates a transaction. Must be provided together with `amount`.
        amount:
          type: number
          description: Deposit amount in MXN. Required when `clabe` is provided.
        payerRfc:
          type: string
          description: Payer's RFC (tax ID). Unmatched mode only. Defaults to XAXX010101000.
        payerName:
          type: string
          description: Payer's name. Unmatched mode only. Defaults to SANDBOX PAYER.
        payerBank:
          type: string
          description: Payer's bank code. Unmatched mode only. Defaults to 40002.
        payerAccount:
          type: string
          description: Payer's account number. Unmatched mode only. Defaults to 000000000000000000.
    MockCryptoDepositTravelRule:
      type: object
      description: Optional Travel Rule scenario for a simulated crypto deposit. With withMessage true, the sender VASP's Travel Rule message is simulated for the deposit; false (or omitting the block) simulates a self-hosted origin with no message, which clears via the hold's timeout path when at or above the threshold.
      properties:
        withMessage:
          type: boolean
          default: true
          description: Whether the sender's VASP transmits a Travel Rule message for the deposit.
        originatorName:
          type: string
          description: The sender name declared in the Travel Rule message. Defaults to a test value.
        beneficiaryName:
          type: string
          description: The recipient name the sender's VASP declares in the Travel Rule message. Defaults to the account's registered name (name check passes); a divergent value fails the beneficiary name check and the deposit stays held for review.
    MockDepositRequest:
      type: object
      description: Mock request to simulate a deposit for testing purposes in the sandbox environment.
      properties:
        documentId:
          type: string
        transactionId:
          type: string
    MockWithdrawalRequest:
      type: object
      description: Mock request to simulate a withdrawal for testing purposes in the sandbox environment.
      properties:
        referenceId:
          type: string
        transactionId:
          type: string
        type:
          type: string
    MockTravelRuleClearanceRequest:
      required:
      - transactionId
      - outcome
      type: object
      description: Sandbox request to resolve the Travel Rule decision a transaction is waiting on, standing in for the counterparty VASP (payouts) or the inbound verdict (deposits).
      properties:
        transactionId:
          type: string
          description: The transaction waiting on Travel Rule clearance.
        outcome:
          type: string
          description: The decision the counterparty would have made.
          enum:
          - AUTHORIZED
          - REJECTED
    MockCryptoDepositRequest:
      required:
      - beneficiaryId
      - walletAddress
      - amount
      - network
      - currency
      type: object
      description: Mock request to simulate a cryptocurrency deposit at a DFNS wallet for testing purposes in the sandbox environment.
      properties:
        beneficiaryId:
          type: string
          description: Unique identifier of the beneficiary receiving the deposit.
        walletAddress:
          type: string
          description: Destination wallet address for the simulated deposit.
        amount:
          type: number
          description: Amount of cryptocurrency to deposit.
        network:
          type: string
          description: Blockchain network for the deposit.
          enum:
          - POLYGON
          - ETH
          - TRON
          - STELLAR
          - BASE
          - SOLANA
        currency:
          type: string
          description: Cryptocurrency currency code (e.g. USDT, USDC).
        fromAddress:
          type: string
          description: On-chain origin of the simulated deposit; random when omitted. Passing the address being proven completes a microtransfer (Satoshi) ownership proof.
        travelRule:
          $ref: '#/components/schemas/MockCryptoDepositTravelRule'
  securitySchemes:
    bearerAuth:
      type: http
      description: 'JWT Bearer token authentication. Include your access token in the Authorization header:


        `Authorization: Bearer YOUR_ACCESS_TOKEN`


        Tokens are obtained through the Caliza authentication flow and typically expire after 24 hours.

        Refresh your token before expiration to maintain uninterrupted access.

        '
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: searched
  source: https://docs.caliza.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.caliza.com/reference/accepttermsandconditions.md
  - https://docs.caliza.com/reference/addrelatedpersondocument.md
  - https://docs.caliza.com/reference/approveverificationsandbox.md
  - https://docs.caliza.com/reference/createfakecryptodeposit.md
  - https://docs.caliza.com/reference/createfakepixindeposit.md
  - https://docs.caliza.com/reference/createfakepixindeposit_1.md
  - https://docs.caliza.com/reference/createfakespeiindeposit.md
  - https://docs.caliza.com/reference/createfakeusddeposit.md
  - https://docs.caliza.com/reference/createpayment.md
  - https://docs.caliza.com/reference/createpaymentwithdocuments.md
  - https://docs.caliza.com/reference/createrecipient.md
  - https://docs.caliza.com/reference/createrelatedperson.md
  - https://docs.caliza.com/reference/createsimulation.md
  - https://docs.caliza.com/reference/createsimulation_1.md
  - https://docs.caliza.com/reference/createtransaction.md
  - https://docs.caliza.com/reference/createtransaction_1.md
  - https://docs.caliza.com/reference/createverification.md
  - https://docs.caliza.com/reference/createvirtualaccount.md
  - https://docs.caliza.com/reference/deletebeneficiary.md
  - https://docs.caliza.com/reference/deleterecipient.md
  - https://docs.caliza.com/reference/deleterelatedperson.md
  - https://docs.caliza.com/reference/disablebeneficiary.md
  - https://docs.caliza.com/reference/enablebeneficiary.md
  - https://docs.caliza.com/reference/findorcreatewallet.md
  - https://docs.caliza.com/reference/getall.md
  - https://docs.caliza.com/reference/getalltransactions.md
  - https://docs.caliza.com/reference/getbeneficiary.md
  - https://docs.caliza.com/reference/getbeneficiarybalance.md
  - https://docs.caliza.com/reference/getbeneficiarydetailedbalance.md
  - https://docs.caliza.com/reference/getbeneficiarydetailedbalancebycurrencies.md
  - https://docs.caliza.com/reference/getcapabilitiesbyintegratorid.md
  - https://docs.caliza.com/reference/getdepositinfo.md
  - https://docs.caliza.com/reference/getdepositinstructions.md
  - https://docs.caliza.com/reference/getintegratorbalances.md
  - https://docs.caliza.com/reference/getintegratorwebhooks.md
  - https://docs.caliza.com/reference/getintegratorwebhooksecret.md
  - https://docs.caliza.com/reference/getme.md
  - https://docs.caliza.com/reference/getpaymentinstructions.md
  - https://docs.caliza.com/reference/getproof.md
  - https://docs.caliza.com/reference/getrecipient.md
  - https://docs.caliza.com/reference/getrecipients.md
  - https://docs.caliza.com/reference/getrelatedperson.md
  - https://docs.caliza.com/reference/getsimulationbyid.md
  - https://docs.caliza.com/reference/getsimulationbyidv2.md
  - https://docs.caliza.com/reference/gettermsandconditions.md
  - https://docs.caliza.com/reference/gettransactionbyid.md
  - https://docs.caliza.com/reference/gettransactionbyid_1.md
  - https://docs.caliza.com/reference/gettransactionbyidwithdocuments.md
  - https://docs.caliza.com/reference/gettransactionproofofpayment.md
  - https://docs.caliza.com/reference/getverificationstatus.md
  - https://docs.caliza.com/reference/issuedelegatetoken.md
  - https://docs.caliza.com/reference/issuemanualattestation.md
  - https://docs.caliza.com/reference/listrelatedpersons.md
  - https://docs.caliza.com/reference/listvirtualaccounts.md
  - https://docs.caliza.com/reference/payouts.md
  - https://docs.caliza.com/reference/savebeneficiary.md
  - https://docs.caliza.com/reference/searchvasps.md
  - https://docs.caliza.com/reference/simulatetravelruleclearance.md
  - https://docs.caliza.com/reference/startmicrotransfertest.md
  - https://docs.caliza.com/reference/submitproof.md
  - https://docs.caliza.com/reference/sweeppayouts.md
  - https://docs.caliza.com/reference/updatebeneficiary.md
  - https://docs.caliza.com/reference/updateintegratorwebhooksecret.md
  - https://docs.caliza.com/reference/updateme.md
  - https://docs.caliza.com/reference/updaterecipient.md
  - https://docs.caliza.com/reference/updaterelatedperson.md
  - https://docs.caliza.com/reference/updatewebhookconfig.md
  - https://docs.caliza.com/reference/uploaddocument.md
  merge:
    pages: 68
    deduped: 414
    conflicts_kept_first: 0