openapi: 3.2.0 info: title: Caliza API documentation reference Payment V1 API 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: Payment V1 description: 'Payment-specific operations: create payments, attach supporting documents, set/update payment blockchain hashes and retrieve payment instructions. Use these when initiating or inspecting single payment flows and their required documentation.' paths: /v1/payments: post: tags: - Payment V1 summary: Create new payment description: Initiates a payment transaction to transfer funds between accounts or to external recipients. Before calling this endpoint, you must first create a simulation using the /v1/simulations or /v2/simulations endpoint to get estimated fees and exchange rates. The simulation ID is required in the request. This endpoint processes the payment according to the simulated parameters and returns a transaction object with status tracking information. operationId: createPayment requestBody: content: application/json: schema: $ref: '#/components/schemas/TransactionRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TransactionResponse' /v1/payments/:withDocuments: post: tags: - Payment V1 summary: Create payment with supporting documents description: Initiates a new payment transaction and attaches required supporting documentation such as invoices, receipts, purchase orders, commercial agreements, or proof of goods/services. This is particularly important for high-value transactions or cross-border payments that require additional compliance documentation. Documents should be provided as multipart form-data attachments. operationId: createPaymentWithDocuments parameters: - name: request in: query description: Payment request parameters including simulation ID, beneficiary, amount, and payment details. required: true schema: type: string requestBody: content: multipart/form-data: schema: required: - files type: object properties: files: type: array items: type: string format: binary responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TransactionResponse' /v1/payments/payment-instructions: get: tags: - Payment V1 summary: Get payment instructions description: Retrieves detailed, step-by-step payment instructions for a beneficiary to deposit funds using the specified payment rail. Instructions include recipient bank details (account number, routing number, SWIFT/BIC), reference codes to include in the transfer, required documentation, transfer limits, processing times, and any special notes. For MXN deposits over the SPEI payment rail, the response includes the beneficiary's 18-digit `clabe` account. Use this to generate deposit instructions that you can display to end users or send via email. operationId: getPaymentInstructions parameters: - name: beneficiaryId in: query description: Unique identifier of the beneficiary to get payment instructions for. required: true schema: type: string - name: paymentRail in: query description: Payment rail to use for the deposit instructions. required: true schema: 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 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentInstructionsResponse' /v1/payments/{id}: get: tags: - Payment V1 summary: Retrieve payment details description: Retrieves complete information about a specific payment transaction including current status (created, processing, completed, failed), amounts sent and received, applied fees and exchange rates, recipient details, beneficiary information, payment method used, timestamps for each stage, and any error messages if the payment failed. Use this to track payment progress or for customer support inquiries. operationId: getTransactionById_1 parameters: - name: id in: path description: Unique identifier of the payment to retrieve. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TransactionResponse' components: schemas: TargetInfoResponse: type: object description: Information about the target account and source of funds for a transaction. properties: targetId: type: string description: Identifier of the target account receiving the funds. example: target_123456 fundsTarget: type: string description: Specifies which account type is the destination for the funds. enum: - BENEFICIARY_FUNDS - INTEGRATOR_FUNDS - CALIZA_FUNDS - RETURN_DEPOSIT_FUNDS example: BENEFICIARY_FUNDS CvuAccountDto: type: object description: CVU (Clave Virtual Uniforme) account details for instant transfers in Argentina. properties: recipientName: type: string description: Full name of the account holder as registered with the CVU. example: María Fernández cvu: type: string description: 22-digit CVU identifier for the recipient account. example: '0000003100010000000001' pattern: ^[0-9]{22}$ BankInfo: required: - bic - city - country - name - postalCode - state - street1 type: object description: Bank information including BIC/SWIFT code and address details for international wire transfers. properties: bic: type: string description: Bank Identifier Code (BIC) or SWIFT code - 8 or 11 character code identifying the bank. example: CHASUS33XXX pattern: ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$ minLength: 8 maxLength: 11 name: type: string description: Full legal name of the bank. example: JPMorgan Chase Bank N.A. street1: type: string description: Primary street address line of the bank. example: 270 Park Avenue street2: type: string description: Secondary street address line (optional). example: Floor 12 postalCode: type: string description: Postal or ZIP code. example: '10017' city: type: string description: City name. example: New York state: type: string description: State, province, or region. example: NY country: maxLength: 2 minLength: 2 type: string description: ISO 3166-1 alpha-2 country code. example: US pattern: ^[A-Z]{2}$ FixedFeeItemResponse: type: object description: Details of a fixed fee charged on a transaction, independent of transaction amount. properties: block: type: string description: Fee category or grouping identifier. example: NETWORK_FEE type: type: string description: Type of fee being charged. example: FIXED value: type: number description: Fixed fee amount. example: 2.5 currencyCode: type: string description: Currency in which the fee is charged. example: USD concept: type: string description: Human-readable description of what the fee covers. example: Wire transfer processing fee paymentRail: type: string description: Payment method this fee applies to. example: WIRE chargeMode: type: string description: How the fee is applied (DEDUCT = deducted from amount, ADD = added to total). example: ADD enum: - DEDUCT - ADD BusinessInfo: required: - accountNumber - accountType - address - city - country - name - postalCode - routingNumber - state type: object description: Business account information for wire transfers including company details and bank account information. properties: name: type: string description: Legal business name of the company. example: Tech Solutions Corp. address: type: string description: Street address of the business headquarters. example: 500 Corporate Plaza city: type: string description: City where the business is located. example: San Francisco state: type: string description: State or province code (2 letters). example: CA country: maxLength: 2 minLength: 2 type: string description: ISO 3166-1 alpha-2 country code. example: US postalCode: type: string description: ZIP or postal code. example: '94105' accountNumber: type: string description: Business bank account number for wire transfers. example: '1234567890' accountType: type: string description: Type of bank account. example: CHECKING enum: - CHECKING routingNumber: type: string description: 9-digit ABA routing number or SWIFT code. example: '121000248' registrationNumber: type: string description: Business registration or tax ID number (EIN/Tax ID). example: 98-7654321 phoneNumber: type: string description: Business contact phone number. example: '+14155551234' registrationType: type: string description: Type of business registration document. example: EIN registrationDate: type: string description: Date when the business was registered. example: '2015-03-20' format: date registrationExpiryDate: type: string description: Expiry date of business registration (if applicable). example: '2035-03-20' format: date mobileNumber: type: string description: Mobile phone number for business contact. example: '+14155559999' businessNature: type: string description: Nature or type of business activity/industry. example: Financial technology services email: type: string description: Business email address for correspondence. example: treasury@techsolutions.com ExpectedSettlementTimeDetails: type: object description: Information about expected settlement time for a transaction. properties: expectedTime: type: string description: Standardized settlement time category. enum: - INSTANT_MARKET_HOURS - INSTANT - WITHIN_5_MINUTES - WITHIN_15_MINUTES - SAME_DAY_BEFORE_CUTOFF - ONE_TO_TWO_DAYS - ONE_TO_THREE_DAYS - UNKNOWN displayText: type: string description: Human-readable settlement time description to display to end users. example: Instant (during market hours) additionalInfo: type: string description: Additional context or conditions affecting settlement time. example: Settlements outside business hours will be processed on the next business day. cutoffTime: type: string description: Cutoff time for same-day settlement in ISO 8601 format. example: '2025-12-05T17:00:00Z' format: date-time NFLocalInfoDto: type: object description: Local payment network information for SPEI, PIX, and other domestic payment systems. properties: speiInClabe: type: string description: CLABE (Clave Bancaria Estandarizada) for incoming SPEI transfers in Mexico. example: 012345678901234567 pattern: ^[0-9]{18}$ speiInBankName: type: string description: Name of the bank for incoming SPEI transfers. example: Banco Santander speiInBeneficiaryName: type: string description: Beneficiary name for incoming SPEI transfers. example: Juan Pérez speiOutClabe: type: string description: CLABE for outgoing SPEI transfers. example: 098765432109876543 pattern: ^[0-9]{18}$ pixCopyAndPaste: type: string description: PIX copy-and-paste code (QR code text equivalent) for payment. example: 00020126580014br.gov.bcb.pix... pixExpiresAt: type: string format: date-time description: Expiration date and time for the PIX payment code. example: '2025-12-17T23:59:59Z' targetPixKey: type: string description: PIX key (CPF, CNPJ, email, phone, or random key) for the recipient. example: '+5511999999999' targetAccount: $ref: '#/components/schemas/LocalTargetBankAccountDto' destinationFiatAccount: $ref: '#/components/schemas/FiatAccountDto' pixOutSearchableId: type: string description: Searchable identifier for outgoing PIX transactions. example: PIX_OUT_123456 speiOutSearchableId: type: string description: Searchable identifier for outgoing SPEI transactions. example: SPEI_OUT_789012 fundingDetails: type: object additionalProperties: type: string uetr: type: string description: Unique End-to-end Transaction Reference for SWIFT/wire transfers (ISO 20022). example: 97ed4827-7b6f-4491-a06f-b548d5a7512d pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ achTraceNumber: type: string description: 'Nacha trace number for ACH transfers. Fifteen digits: an 8-digit ODFI routing prefix followed by a 7-digit sequence. For inbound ACH it carries the originating bank''s prefix.' example: 091311220037464 pattern: ^[0-9]{15}$ achSecCode: type: string description: ACH Standard Entry Class code identifying the type of ACH entry (e.g. CCD for business, PPD for consumer). example: CCD achEffectiveDate: type: string format: date description: The effective settlement date for the ACH entry. example: '2026-08-05' ConversionDetails: type: object description: Detailed breakdown of currency conversion including exchange rates and amounts for multi-currency transactions. properties: effectiveTransactionValue: type: number description: The final value of the transaction after all conversions and fees. example: 95.25 marketExchangeRate: type: number description: The current market exchange rate between the source and destination currencies. example: 5.42 clientRate: type: number description: The exchange rate offered to the client (may include markup). example: 5.35 calizaRate: type: number description: The exchange rate component retained by Caliza. example: 5.4 integratorRate: type: number description: The exchange rate component allocated to the integrator. example: 5.38 amountToBeConverted: $ref: '#/components/schemas/AmountFourDecimalPlacesResponse' SwiftAccountDto: required: - bankInfo type: object description: SWIFT international wire transfer account details supporting both individual and business accounts. properties: personInfo: $ref: '#/components/schemas/SwiftPersonInfo' bankInfo: $ref: '#/components/schemas/SwiftBankInfo' businessInfo: $ref: '#/components/schemas/SwiftBusinessInfo' isPobo: type: boolean description: Indicates if this account uses Pay-on-Behalf-Of (POBO) arrangement where payments are made on behalf of another entity. pobo: type: boolean description: Indicates if POBO (Pay-on-Behalf-Of) services are enabled for this account. TransactionDetailsResponse: type: object description: Detailed information about a transaction including conversion details, fees, and settlement expectations. properties: conversionDetails: $ref: '#/components/schemas/ConversionDetails' feeDetails: $ref: '#/components/schemas/FeeDetails' transferPurpose: type: string description: Purpose or reason for the transfer. example: Payment for services paymentReference: type: string description: Reference number or code for the payment. example: INV-2025-001 memo: type: string description: Additional notes or memo for the transaction. example: Monthly subscription payment expectedSettlementTimeDetails: $ref: '#/components/schemas/ExpectedSettlementTimeDetails' CopAccountDto: type: object description: Colombian Peso (COP) bank account details for transfers in Colombia. properties: firstName: type: string description: Account holder's first name. example: Juan lastName: type: string description: Account holder's last name. example: Rodriguez accountType: type: integer format: int32 description: Type of bank account (1 = Savings, 2 = Checking). example: 1 bankAccount: type: string description: Bank account number. example: '1234567890' bankCode: type: string description: Colombian bank code identifying the financial institution. example: '001' thirdPartyWithdrawal: type: boolean description: Indicates if withdrawals to third parties are allowed. example: false documentId: type: string description: Identification document number. example: '1234567890' documentType: type: string description: Type of identification document. enum: - CC - CE - NIT - PASS - PEP example: CC email: type: string description: Email address associated with the account. format: email example: juan.rodriguez@example.com bitsoContactId: type: string description: Bitso platform contact identifier (if applicable). example: btso_123456 PixAccountDto: type: object description: PIX account details for instant payments in Brazil. properties: pixKey: type: string description: PIX key identifier. Can be CPF, CNPJ, email, phone number (+55...), or random key (UUID). example: '+5511999887766' SpreadFeeItemResponse: type: object description: Details of fees derived from exchange rate spread in currency conversion transactions. properties: block: type: string description: Fee category or grouping identifier. example: FX_SPREAD type: type: string description: Type of fee being charged. example: SPREAD fromCurrency: type: string description: Source currency being converted from. example: USD toCurrency: type: string description: Target currency being converted to. example: BRL marketRate: type: number description: Current market exchange rate between the two currencies. example: 5.42 spreadBasisPoint: type: number description: Spread markup in basis points (1 bp = 0.01%). example: 150 effectiveRate: type: number description: Final exchange rate applied after spread. example: 5.35 calizaRate: type: number description: Exchange rate component retained by Caliza. example: 5.4 baseCurrency: type: string description: Base currency for fee calculation. example: USD baseAmount: type: number description: Amount in base currency used for fee calculation. example: 100 calculatedFee: type: number description: Calculated spread fee amount. example: 0.7 feeCurrency: type: string description: Currency in which the spread fee is expressed. example: USD concept: type: string description: Human-readable description of the spread fee. example: Currency conversion spread chargeMode: type: string description: How the fee is applied to the transaction. example: EMBEDDED enum: - EMBEDDED - DEDUCT - ADD FiatAccountDto: type: object description: Fiat currency bank account information including account type, ownership, and detailed banking information for various payment rails. properties: id: type: string description: Unique identifier of the fiat account. example: fiat_acc_123456 name: type: string description: Display name or nickname for the account. example: Main USD Account beneficiaryId: type: string description: ID of the beneficiary who owns this account (if applicable). example: ben_123456 integratorId: type: string description: ID of the integrator associated with this account. example: int_123456 belongsToBeneficiary: type: boolean description: Indicates whether this account belongs to a beneficiary (true) or integrator (false). example: true fiatAccountType: type: string description: Type of fiat account/payment rail. enum: - WIRE - SWIFT - ACH - PIX - COP - SPEI - CVU example: ACH accountDetails: $ref: '#/components/schemas/AccountDetailsDto' owner: type: string enum: - BENEFICIARY - INTEGRATOR SwiftPersonInfo: required: - accountType - city - country - iban - name - postalCode - routingKey - state - street1 - type type: object description: Individual person account information for SWIFT international wire transfers including IBAN details. properties: name: type: string description: Full name of the account holder. example: Emma Thompson street1: type: string description: Primary street address. example: 45 Baker Street postalCode: type: string description: Postal code. example: W1U 6TE city: type: string description: City name. example: London state: type: string description: State or region. example: Greater London country: maxLength: 2 minLength: 2 type: string description: ISO 3166-1 alpha-2 country code. example: GB routingKey: type: string description: Bank routing key or sort code. example: '201029' iban: type: string description: International Bank Account Number. example: GB33BUKB20201555555555 pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]+$ accountType: type: string description: Type of account. example: CHECKING enum: - CHECKING type: type: string description: Account holder type. enum: - NATURAL_PERSON - COMPANY email: type: string description: Email address of the account holder. example: emma.thompson@email.com dateOfBirth: type: string description: Date of birth of the account holder. example: '1985-07-22' format: date mobileNumber: type: string description: Mobile phone number. example: '+447700900456' identificationType: type: string description: Type of identification document (e.g., PASSPORT, ID_CARD, DRIVING_LICENSE). example: PASSPORT identificationNumber: type: string description: Identification document number. example: '987654321' identificationIssuer: type: string description: Issuing authority or country of the identification document. example: GB occupation: type: string description: Occupation or profession of the account holder. example: Software Engineer AmountFourDecimalPlacesResponse: type: object description: Monetary amount with up to four decimal places precision, typically used for fee calculations and exchange rate conversions. properties: currencyCode: type: string description: ISO 4217 currency code or cryptocurrency ticker symbol. example: USD enum: - USDT - USDC - USD - BRL - MXN - COP - EUR - EURT - HKD - SGD - CNY - CNH - ARS - ANY value: type: number description: The monetary amount with up to 4 decimal places of precision. example: 1234.5678 minimum: 0 AccountDetailsDto: type: object description: 'Container for different types of bank account details supporting multiple payment rails. Each property corresponds to a specific payment method: - wireDetails: Wire transfer account details for domestic U.S. transfers - achDetails: ACH (Automated Clearing House) account details for U.S. electronic transfers - swiftDetails: SWIFT international wire transfer account details - pixDetails: PIX account details for instant payments in Brazil - copDetails: Colombian Peso (COP) account details for transfers in Colombia - speiDetails: SPEI account details for electronic transfers in Mexico - cvuDetails: CVU (Clave Virtual Uniforme) account details for transfers in Argentina ' properties: wireDetails: $ref: '#/components/schemas/WireAccountDto' achDetails: $ref: '#/components/schemas/AchAccountDto' swiftDetails: $ref: '#/components/schemas/SwiftAccountDto' pixDetails: $ref: '#/components/schemas/PixAccountDto' copDetails: $ref: '#/components/schemas/CopAccountDto' speiDetails: $ref: '#/components/schemas/SpeiAccountDto' cvuDetails: $ref: '#/components/schemas/CvuAccountDto' OldFeeItemResponse: type: object description: Legacy fee structure format (deprecated). Use FixedFeeItemResponse, PercentageFeeItemResponse, or SpreadFeeItemResponse for new integrations. deprecated: true properties: block: type: string description: Fee category identifier. type: type: string description: Type of fee. fromCurrency: type: string description: Source currency (for conversion fees). toCurrency: type: string description: Target currency (for conversion fees). feeValue: type: number description: Fee amount or percentage value. feeCurrency: type: string description: Currency in which the fee is charged. marketRate: type: number description: Market exchange rate (for FX fees). effectiveRate: type: number description: Effective rate after spread (for FX fees). calizaRate: type: number description: Caliza's rate component. baseCurrency: type: string description: Base currency for calculations. baseAmount: type: number description: Base amount for percentage calculations. concept: type: string description: Fee description. chargeMode: type: string description: How the fee is applied. NFBlockchainInfoDto: type: object description: Blockchain network information for crypto transactions including transaction hashes and wallet addresses. properties: depositTransactionHash: type: string description: Blockchain transaction hash for the deposit transaction. example: 0xabc123def456... withdrawalTransactionHash: type: string description: Blockchain transaction hash for the withdrawal/payout transaction. example: 0x789ghi012jkl... fundingWallet: type: string description: Wallet address used to fund the transaction. example: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb' targetWallet: $ref: '#/components/schemas/NFTransferWalletDto' PaymentInstructionsResponse: type: object description: Payment instructions for funding a transaction including bank details and reference codes. properties: accountNumber: type: string routingNumber: type: string receiverName: type: string receiverAddress: type: string receiverBankName: type: string swiftCode: type: string receiverBankAddress: type: string reference: type: string clabe: type: string description: 18-digit CLABE account the beneficiary can be funded through. Returned for MXN deposits over the SPEI payment rail. example: '646180123456789012' AmountDto: type: object description: Represents a monetary amount with currency code and value. required: - currencyCode - value properties: currencyCode: type: string description: ISO 4217 currency code or cryptocurrency ticker symbol. example: USD enum: - USDT - USDC - USD - BRL - MXN - COP - EUR - EURT - HKD - SGD - CNY - CNH - ARS - ANY value: type: number description: The monetary amount in the specified currency. Precision depends on the currency (typically 2 decimal places for fiat, up to 8 for crypto). example: 100.5 minimum: 0 PayInSenderResponse: type: object description: Information about the payment rail and sender details for pay-in transactions. properties: paymentRails: type: string description: Payment method or rail used for the transaction. 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 example: PIX details: type: object description: Additional sender-specific details (structure varies by payment rail). additionalProperties: type: object AchPersonInfo: required: - accountNumber - accountType - city - country - name - postalCode - routingKey - state - street1 - type type: object properties: name: type: string description: Full name of the account holder. example: John Doe street1: type: string description: Primary street address. example: 456 Elm Street postalCode: type: string description: ZIP or postal code. example: '90210' city: type: string description: City name. example: Beverly Hills state: type: string description: State or province code (2 letters). example: CA country: maxLength: 2 minLength: 2 type: string description: ISO 3166-1 alpha-2 country code. example: US routingKey: type: string description: Routing key for the account (routing number). example: '121000248' accountNumber: type: string description: Bank account number. example: '987654321' accountType: type: string description: Type of account. enum: - CHECKING type: type: string description: Account holder type. enum: - NATURAL_PERSON - COMPANY TransactionResponse: type: object description: Complete transaction information including status, amounts, blockchain info, and timestamps. properties: id: type: string description: Unique transaction identifier. example: txn_123456789 simulationId: type: string description: ID of the simulation used to create this transaction. example: sim_987654321 integratorId: type: string description: ID of the integrator who initiated the transaction. example: int_123456 beneficiaryId: type: string description: ID of the beneficiary involved in the transaction. example: ben_123456 from: $ref: '#/components/schemas/AmountDto' to: $ref: '#/components/schemas/AmountDto' status: type: string description: Current status of the transaction. enum: - CREATED - PENDING - PROCESSING - SUCCEEDED - WAITING_WEBHOOK - FAILED - EXPIRED - CANCELLED - REJECTED - DEPOSIT_RECEIVED - DEPOSIT_COMPLETED - INTERNAL_TRANSFER_SENT - INTERNAL_TRANSFER_COMPLETED - EXCHANGE_SENT - EXCHANGE_COMPLETED - PAYMENT_SENT - PAYMENT_COMPLETED - PAYMENT_UNDER_REVIEW - PROCESSED_BY_BANK - PROCESSED_BY_INTERMEDIARY_BANK - RECEIVED_BY_INTERMEDIARY_BANK - RECEIVED_BY_BENEFICIARY_BANK - UNKNOWN example: SUCCEEDED blockchainInfo: $ref: '#/components/schemas/NFBlockchainInfoDto' localInfo: $ref: '#/components/schemas/NFLocalInfoDto' beneficiaryIp: type: string flowOfFundsId: type: string targetInfo: $ref: '#/components/schemas/TargetInfoResponse' transactionDetails: $ref: '#/components/schemas/TransactionDetailsResponse' settledAt: type: string format: date-time createdDate: type: string format: date-time lastModifiedDate: type: string format: date-time payInSender: $ref: '#/components/schemas/PayInSenderResponse' AchAccountDto: required: - bankInfo type: object description: 'ACH account information for electronic fund transfers in the United States. - personInfo: Personal information for individual account holders - bankInfo: Bank identification and routing information (required) - businessInfo: Business information for corporate account holders ' properties: personInfo: $ref: '#/components/schemas/AchPersonInfo' bankInfo: $ref: '#/components/schemas/AchBankInfo' businessInfo: $ref: '#/components/schemas/AchBusinessInfo' SwiftBusinessInfo: required: - accountNumber - accountType - address - city - country - name - postalCode - routingNumber - state type: object description: Business account information for SWIFT international wire transfers. properties: name: type: string description: Legal business name. example: Global Trading LLC address: type: string description: Business street address. example: 123 Commerce Street city: type: string description: City where the business is located. example: London state: type: string description: State or region. example: Greater London country: maxLength: 2 minLength: 2 type: string description: ISO 3166-1 alpha-2 country code. example: GB postalCode: type: string description: Postal code. example: EC2N 2DL registrationNumber: type: string description: Company registration number. example: '12345678' accountNumber: type: string description: Bank account number or IBAN. example: GB29NWBK60161331926819 accountType: type: string description: Type of account. example: CHECKING enum: - CHECKING routingNumber: type: string description: Bank routing number or sort code. example: '601613' phoneNumber: type: string description: Business contact phone number. example: '+442071234567' registrationType: type: string description: Type of business registration. example: Companies House registrationDate: type: string description: Date of business registration. example: '2010-06-15' format: date registrationExpiryDate: type: string description: Registration expiry date (if applicable). example: '2030-06-15' format: date mobileNumber: type: string description: Mobile contact number. example: '+447700900123' businessNature: type: string description: Nature of business operations. example: International trade and finance email: type: string description: Business email address. example: accounts@globaltrading.com PercentageFeeItemResponse: type: object description: Details of a percentage-based fee calculated as a portion of the transaction amount. properties: block: type: string description: Fee category or grouping identifier. example: SERVICE_FEE type: type: string description: Type of fee being charged. example: PERCENTAGE percentageRate: type: number description: Fee percentage rate in decimal form (e.g., 0.025 = 2.5%). example: 0.025 baseAmount: type: number description: Transaction amount used as the base for percentage calculation. example: 1000 baseCurrency: type: string description: Currency of the base amount. example: USD calculatedFee: type: number description: Calculated fee amount based on the percentage and base amount. example: 25 feeCurrency: type: string description: Currency in which the fee is charged. example: USD concept: type: string description: Human-readable description of what the fee covers. example: Transaction processing fee paymentRail: type: string chargeMode: type: string FeeDetails: type: object description: 'Comprehensive breakdown of all fees applied to a transaction: - taxes: Tax amount charged on the transaction (e.g., IOF in Brazil, VAT, etc.) - integratorFee: Fee amount allocated to the integrator - fixedFees: List of fixed fees charged regardless of transaction amount - percentageFees: List of fees calculated as a percentage of the transaction amount - spreadFees: List of fees derived from exchange rate spreads in currency conversions - oldFees: Legacy fee structure (deprecated) - totalFees: Sum of all fees charged on this transaction - vet: VET (Valor Efetivo Total) - Brazilian total effective value including all costs ' properties: taxes: $ref: '#/components/schemas/AmountFourDecimalPlacesResponse' integratorFee: $ref: '#/components/schemas/AmountFourDecimalPlacesResponse' fixedFees: type: array description: List of fixed fees charged regardless of transaction amount. items: $ref: '#/components/schemas/FixedFeeItemResponse' percentageFees: type: array description: List of fees calculated as a percentage of the transaction amount. items: $ref: '#/components/schemas/PercentageFeeItemResponse' spreadFees: type: array description: List of fees derived from exchange rate spreads in currency conversions. items: $ref: '#/components/schemas/SpreadFeeItemResponse' oldFees: type: array description: Legacy fee structure (deprecated). items: $ref: '#/components/schemas/OldFeeItemResponse' totalFees: $ref: '#/components/schemas/AmountFourDecimalPlacesResponse' vet: type: number description: VET (Valor Efetivo Total) - Brazilian total effective value including all costs. example: 105.5 NFTransferWalletDto: type: object description: Cryptocurrency wallet information for blockchain-based transfers. properties: address: type: string description: Blockchain wallet address (cryptocurrency public address). example: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb' tag: type: string description: Destination tag or memo (required for some networks like Stellar, XRP). example: '123456' chain: type: string description: Blockchain network identifier. enum: - SOL - XLM - POLY - TRX - MATIC - BASE example: POLY provider: type: string description: Wallet service provider or custody solution. example: CALIZA type: type: string description: Type of wallet integration. enum: - CALIZA_BRIDGE - EXTERNAL_BRIDGE - RENTAL_PAYMENT - CUSTODY example: CALIZA_BRIDGE LocalTargetBankAccountDto: type: object description: Local bank account details for a beneficiary in their domestic country, supporting multiple countries and payment systems. properties: targetCountry: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CK - CR - CI - HR - CU - CW - CY - CZ - CD - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - SZ - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JE - JO - KZ - KE - KI - XK - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - IM - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - KP - MK - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - BL - MF - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - KR - SS - ES - LK - SD - SR - SJ - SE - CH - SY - TW - TJ - TZ - TH - BS - GM - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VA - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - ALL accountDetails: type: object additionalProperties: type: string SwiftBankInfo: required: - city - country - name - postalCode - state - street1 - swiftCode type: object description: Bank information for SWIFT international wire transfers including SWIFT code and bank address. properties: swiftCode: type: string description: SWIFT/BIC code identifying the bank (8 or 11 characters). example: CHASUS33XXX pattern: ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$ name: type: string description: Full legal name of the bank. example: JPMorgan Chase Bank N.A. street1: type: string description: Primary street address of the bank. example: 383 Madison Avenue street2: type: string description: Secondary address line (optional). example: Floor 12 postalCode: type: string description: Postal or ZIP code. example: '10179' city: type: string description: City name. example: New York state: type: string description: State or province. example: NY country: maxLength: 2 minLength: 2 type: string description: ISO 3166-1 alpha-2 country code. example: US AchBusinessInfo: required: - accountNumber - accountType - address - city - country - name - postalCode - routingNumber - state type: object properties: name: type: string description: Legal business name of the company. example: Acme Corporation Inc. address: type: string description: Street address of the business. example: 123 Business Park Drive city: type: string description: City where the business is located. example: Austin state: type: string description: State or province code (2 letters). example: TX country: maxLength: 2 minLength: 2 type: string description: ISO 3166-1 alpha-2 country code. example: US postalCode: type: string description: ZIP or postal code. example: '78701' accountNumber: type: string description: Bank account number for ACH transfers. example: '123456789012' accountType: type: string enum: - CHECKING routingNumber: type: string registrationNumber: type: string phoneNumber: type: string registrationType: type: string registrationDate: type: string registrationExpiryDate: type: string mobileNumber: type: string businessNature: type: string email: type: string TransactionRequest: required: - beneficiaryIp - simulationId type: object properties: simulationId: type: string beneficiaryIp: type: string marketExecutionType: type: string enum: - NONE - EXECUTE_IMMEDIATELY - MARKET_OPEN_TIME achSameDay: type: boolean description: When true, requests same-day ACH settlement. Optional if achSameDay was already set on the simulation — the simulation value carries over automatically. transferPurpose: type: string memo: type: string paymentReference: type: string WireAccountDto: required: - bankInfo type: object description: Domestic wire transfer account details for U.S. transfers supporting both individual and business accounts. properties: personInfo: $ref: '#/components/schemas/PersonInfo' bankInfo: $ref: '#/components/schemas/BankInfo' businessInfo: $ref: '#/components/schemas/BusinessInfo' AchBankInfo: required: - city - country - name - postalCode - routingNumber - state - street1 type: object description: Bank information for ACH transfers including routing details and bank address. properties: routingNumber: type: string description: 9-digit ABA routing number identifying the bank. example: '021000021' pattern: ^[0-9]{9}$ name: type: string description: Full legal name of the financial institution. example: JPMorgan Chase Bank street1: type: string description: Primary street address of the bank. example: 270 Park Avenue street2: type: string description: Secondary address line (suite, floor, etc.). example: Floor 12 postalCode: type: string description: ZIP or postal code. example: '10017' city: type: string description: City name. example: New York state: type: string description: State or province code (2 letters). example: NY country: maxLength: 2 minLength: 2 type: string description: ISO 3166-1 alpha-2 country code. example: US pattern: ^[A-Z]{2}$ SpeiAccountDto: required: - bankCode - clabe - receiverName type: object description: SPEI (Sistema de Pagos Electrónicos Interbancarios) account details for electronic transfers in Mexico. properties: clabe: type: string description: 18-digit CLABE (Clave Bancaria Estandarizada) number identifying the Mexican bank account. example: 012180001234567890 pattern: ^[0-9]{18}$ bankCode: type: string description: 3-digit Mexican bank code. example: '012' pattern: ^[0-9]{3}$ receiverName: type: string description: Full name of the account holder as registered with the bank. example: Carlos Hernández PersonInfo: required: - accountNumber - accountType - city - country - name - postalCode - routingKey - state - street1 - type type: object description: Individual person account information for wire transfers including personal details and bank account information. properties: name: type: string street1: type: string postalCode: type: string city: type: string state: type: string country: maxLength: 2 minLength: 2 type: string routingKey: type: string accountNumber: type: string accountType: type: string enum: - CHECKING type: type: string enum: - NATURAL_PERSON - COMPANY 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