Skip to content

Quote

A Quote (Payment Quote) represents pricing and timing information for a transfer between two payment profiles. Quotes include exchange rates, fees, and expected completion dates, and are required before creating payments.

Quote Object

{
  "id": "Z2lkOi8vd2FsbGV0LWFwcC9QYXltZW50UXVvdGUvMQ",
  "created_at": "2025-01-17T10:30:00.000Z",
  "updated_at": "2025-01-17T10:30:00.000Z",
  "instructed_amount": "1000.0",
  "instructed_amount_currency": "USD",
  "source_amount": "1005.0",
  "source_amount_currency": "USD",
  "target_amount": "1000.0",
  "target_amount_currency": "USD",
  "currency_pair": null,
  "exchange_rate": "1.0",
  "expires_at": "2025-01-17T10:45:00.000Z",
  "fee": "5.0",
  "fee_currency": "USD",
  "expected_completion_date": "2025-01-18",
  "from_profile": {
    "id": "Z2lkOi8vd2FsbGV0LWFwcC9QYXltZW50UHJvZmlsZS8x",
    "status": "active",
    "currency": "USD",
    "payment_method": "ach",
    "usage_type": "debit",
    "created_at": "2025-01-15T10:00:00.000Z",
    "updated_at": "2025-01-15T10:00:00.000Z"
  },
  "to_profile": {
    "id": "Z2lkOi8vd2FsbGV0LWFwcC9QYXltZW50UHJvZmlsZS8z",
    "status": "active",
    "currency": "USD",
    "payment_method": "ach",
    "usage_type": "credit",
    "created_at": "2025-01-15T12:00:00.000Z",
    "updated_at": "2025-01-15T12:00:00.000Z"
  }
}

{
  "id": "Z2lkOi8vd2FsbGV0LWFwcC9QYXltZW50UXVvdGUvMg",
  "created_at": "2025-01-17T14:30:00.000Z",
  "updated_at": "2025-01-17T14:30:00.000Z",
  "instructed_amount": "1000.0",
  "instructed_amount_currency": "USD",
  "source_amount": "1005.0",
  "source_amount_currency": "USD",
  "target_amount": "850.0",
  "target_amount_currency": "EUR",
  "currency_pair": "USDEUR",
  "exchange_rate": "0.85",
  "expires_at": "2025-01-17T14:45:00.000Z",
  "fee": "5.0",
  "fee_currency": "USD",
  "expected_completion_date": "2025-01-19",
  "from_profile": {
    "id": "Z2lkOi8vd2FsbGV0LWFwcC9QYXltZW50UHJvZmlsZS8x",
    "status": "active",
    "currency": "USD",
    "payment_method": "ach",
    "usage_type": "debit",
    "created_at": "2025-01-15T10:00:00.000Z",
    "updated_at": "2025-01-15T10:00:00.000Z"
  },
  "to_profile": {
    "id": "Z2lkOi8vd2FsbGV0LWFwcC9QYXltZW50UHJvZmlsZS80",
    "status": "active",
    "currency": "EUR",
    "payment_method": "swift",
    "usage_type": "credit",
    "created_at": "2025-01-16T09:00:00.000Z",
    "updated_at": "2025-01-16T09:00:00.000Z"
  }
}

Attributes

Attribute Type Description
id string Unique identifier for the quote
created_at string ISO 8601 timestamp when the quote was created
updated_at string ISO 8601 timestamp when the quote was last updated
instructed_amount string Original requested amount as decimal string
instructed_amount_currency string ISO 4217 three-letter currency code of instructed amount
source_amount string Total amount debited from source account (includes fees) as decimal string
source_amount_currency string ISO 4217 three-letter currency code of source amount
target_amount string Amount credited to destination account as decimal string
target_amount_currency string ISO 4217 three-letter currency code of target amount
currency_pair string/null Currency pair for foreign exchange (e.g., "USDEUR"), or null for same-currency transfers
exchange_rate string Exchange rate used for conversion (as decimal string)
expires_at string ISO 8601 timestamp when the quote expires (15 minutes from creation)
fee string Fee amount as decimal string
fee_currency string ISO 4217 three-letter currency code of the fee
expected_completion_date string Expected date when payment will complete (ISO 8601 date format)
from_profile object Source payment profile details (see Payment Profile)
to_profile object Destination payment profile details (see Payment Profile)

Quote Characteristics

Quotes can be categorized into two types based on whether currency conversion is required:

Characteristic Description
Exchange Rate Live rates from TreasuryPath (Always "1.0" for same-currency transfers)
Currency Pair Currency pair notation (e.g., "USDEUR", "GBPJPY") for cross-currency transfers, or null for same-currency transfers
Fee Basis Payment method and amount
Validity 15 minutes from creation
Target Amount Equals instructed amount for same-currency transfers, varies based on exchange rate for cross-currency transfers

Quote Lifecycle

Quotes follow a simple lifecycle:

  1. Creation - Quote is generated with current exchange rates and fees
  2. Active Period - Quote is valid for 15 minutes
  3. Expiration - Quote expires after 15 minutes and cannot be used
  4. Usage - Quote can be used once to create a payment

Quote Expiration

Quotes expire 15 minutes after creation. After expiration, you must generate a new quote to create a payment. Exchange rates and fees may differ in the new quote.

Payment Profile Validation

Both the from_profile and to_profile must have active status to create a quote. Attempting to create a quote with inactive, draft, failed, or deleted payment profiles will result in a validation error: "Payment profile is not in active status".

Available Operations

  • Create Quote - Generate a new payment quote for a transfer between payment profiles

Read-Only After Creation

Quotes cannot be updated or deleted after creation. If you need different pricing, generate a new quote.

Fee Calculation

Fees are automatically calculated based on multiple factors:

  • Payment Method - Different methods (ACH, wire, SWIFT) have different fee structures
  • Transfer Amount - Fee may vary based on the amount being transferred
  • Currency Pair - Cross-currency transfers may have additional FX fees
  • Fee Schedule - Company-specific fee configuration

The fee and fee_currency fields in the quote show the exact fee that will be charged for the payment. The sender will be charged the payment amount plus the fee (as reflected in the source_amount field).

Usage Notes

  • Required for Payments - All payments must reference a valid quote
  • 15-Minute Validity - Quotes expire 15 minutes after creation
  • Single Use - Each quote can only be used once to create a payment
  • Live Exchange Rates - Cross-currency quotes use real-time exchange rates
  • Multi-Currency Requirement - Cross-currency quotes require an active multi-currency account feature
  • Profile Validation - Both payment profiles must be active and have valid connections
  • Rate Limiting - Quote generation is subject to rate limiting to prevent abuse

For detailed API endpoints and request/response examples, see the Quotes API Reference.