Ivy Docs home page
Search...
⌘K
Ask AI
Contact Us
Dashboard
Dashboard
Search...
Navigation
Getting Started
Introduction
Documentation
API Reference
Webhooks
Getting Started
Introduction
Authentication
Versioning
Metadata
Errors
Subaccount
POST
Retrieve a Subaccount
POST
Create a Subaccount
Checkout
POST
Create a Checkout Session
POST
Expire a Checkout Session
POST
Retrieve a Checkout Session
Customer
POST
Create a Customer
POST
Retrieve a Customer
POST
Search Customers
Bank
POST
Search a Bank
POST
List Banks
POST
Retrieve a Bank
FX
POST
Retrieve Exchange Rate
POST
Retrieve FX details
Order
POST
Retrieve an Order
POST
Create an Order
POST
Expire an Order
Capabilities
POST
Retrieve your Capabilities
Refund
POST
Create multiple Refunds
deprecated
POST
Create one Refund
deprecated
POST
Create a refund
POST
Retrieve a refund
Payout Report
POST
Create a Payout Report
deprecated
POST
Download a Payout Report
deprecated
POST
Retrieve a Payout Report status
Charge
POST
Create a Charge
Mandate
POST
Lookup a Mandate
POST
Retrieve a Mandate
POST
Revoke a Mandate
Banking
POST
Retrieve Account Balance
Payout
POST
Performs a Merchant Payout on all supported currencies
POST
Retrieve a payout
POST
List payouts
POST
Create a payout
Getting Started
Introduction
If you have any questions or feedback, please ping us an
email
!
We have organized the content into the following sections:
Getting Started:
Basic concepts of our API, i.e. Authentication, Webhooks, Metadata, Errors
Ivy API:
Reference of all API endpoints
Webhooks:
The reference for webhook endpoints and webhook event definitions
SDK & Plugins:
Guidance to simplify your integration of Ivy into your application
Was this page helpful?
Yes
No
Authentication
Assistant
Responses are generated using AI and may contain mistakes.