Get to know the core concepts of the Ivy API.

Checkout SessionA Checkout Session represents your user's session as they do a one-time payment through Checkout or Payment Links.

You can start the Session with different modes depending on the use case. E.g. start the session with guest mode, if users should not need to provide their email. We recommend creating a new Session each time your user attempts to pay.

Once your user authorised the payment successfully, the Checkout Session switches to status closed and a new Order is created with the Checkout Session linked via the field checkoutSessionId.
OrderAn Order is the Ivy equivalent for a one-time user payment. We create exactly one Order for each user deposit or payment attempt. You can reference the Order later to see the current status of the user's one-time payment attempt.

An Order transitions through multiple statuses throughout its lifetime as users start and finish the payment or deposit flow.
Webhook SubscriptionUse incoming webhooks to get real-time updates. Listen for events on your Ivy merchant account so your integration can automatically trigger reactions.

To start receiving webhook events in your app, register a webhook endpoint by creating a new webhook subscription. You can register and create one endpoint to handle several different event types at once, or set up individual endpoints for specific events.
Data SessionA Data Session represents your user's session as they link their bank accounts. We recommend creating a new Session each time your user attempts to link a new bank account.
RefundA Refund is essentially a reversal of a user's payment. Money will be sent back directly to the bank account of the user as soon as possible. For most of the time instant bank rails are used to settle money instantly with user's bank account.
Payout ReportPayout Reports allow you to reconcile all payments coming in and going out from your bank account. You can either retrieve a payout report via API or by downloading it from the Ivy Dashboard.

Payouts from your balance of your Ivy settlement account are made regularly, and the payout report will show you the associated orders, refunds, amount, and the date for each payout.