Skip to main content
Ivy’s API is built around 3 modular resource domains. Each is a building block for your product—use them independently or together.

​
Incoming Payments

Accept instant bank payments from your users, customers, or partners.

​
Checkout Session

Checkout Session lets your customers pay you with their online banking. Instead of manually sending money, customers are redirected into their banking app to make an instant transaction.
  • Instantly initiates a payin flow
  • Handles user redirection and payment confirmation
  • Automatically creates an Order on success
Learn more

​
Order

Order represents a completed or in-progress payment attempt. It contains details about the payer, amount, status, and outcome. Use this to track the status of an expected incoming payment.
  • Created automatically by Checkout Session
  • Can also be created directly for manual bank transfers
Learn More

​
Deposits

Allow your customers to send money whenever they want to your Ivy account in FIAT or STABLECOIN. Great for recurring or ad-hoc payments. Learn More

​
Outgoing Payments

Send money out to users, partners, or external accounts—instantly and globally.

​
Payout

Payout is the main object for sending funds out of Ivy. It defines the destination, amount, currency, and status. Use it to automate withdrawals, partner payments, or payroll. Learn more.

​
Refund

Refund allows you to refund a previous incoming payment back to your customer. Supports full or partial refunds of an Order. Learn more.

​
Settlements

Settlements are a batched payout to your pre-defined beneficiary bank account or wallet. It sweeps your total or partial available balance in all currencies at a set interval (weekly, daily, monthly), or can be triggered manually via API or Dashboard. Learn more
  • Settlements can be combined with a currency conversion with a settlement. Settle in stablecoins after being paid in FIAT, or vice versa.

​
Account & Reporting

Swap currencies, Track balances, transactions, and reports for full financial visibility.

​
Balance

Balance shows your available and pending funds in all supported currencies. Track your cash position and manage liquidity.

​
Payout Report

Payout Report provides a detailed reconciliation of all incoming and outgoing payments over a period. Use it for financial reporting, compliance, and cash management. Learn more

​
FX

Swap between your Ivy-held FIAT and STABLECOIN balances with one API. Useful for treasury, cross-border payments, or flexible settlement. Learn more

​
Onramp, Offramp

Convert FIAT-to-STABLECOIN, and STABLECOIN-to-FIAT in real time.