/
AU
augustus
/
Ivy API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 8m ago · Updated 2w ago
c3055fc06ca3
latest
OpenAPI 3.0.0
raw.githubusercontent.com
2026-08-04
38
71
777.1 KB
Bank
3
post
Search a Bank
post
List Banks
post
Retrieve a Bank
Banking
1
post
Retrieve Account Balance
Capabilities
1
post
Retrieve your Capabilities
Checkout
3
post
Create a Checkout Session
post
Expire a Checkout Session
post
Retrieve a Checkout Session
Customer
5
post
Create a Customer
post
Retrieve a Customer
post
Search Customers
post
Delete a Customer
post
Update a Customer
Deposit
1
post
Retrieve a deposit
FX
3
post
Retrieve Exchange Rate
post
Retrieve FX details
post
Execute FX
Order
3
post
Retrieve an Order
post
Create an Order
post
Expire an Order
Payout
4
post
Payout available balances
post
Retrieve a payout
post
List payouts
post
Create a payout
Refund
2
post
Create a refund
post
Retrieve a refund
Return
2
post
Retrieve a return
post
Create a return
Subaccount
2
post
Retrieve a Subaccount
post
Create a Subaccount
Transactions
1
post
List transaction history
VoP
1
post
Verify payee bank account
Webhook
1
post
Trigger a specific webhook
Webhook-Subscription
5
post
Ping a webhook subscription
post
List webhook subscriptions
post
Create a webhook subscription
post
Delete a webhook subscription
post
Update a webhook subscription
Subaccount
Retrieve a Subaccount
Retrieve a Subaccount by id.
post
/api/service/subaccount/retrieve
Request body
RetrieveSubaccountInputDto
required
id
string
uuid
required
The unique identifier of the Subaccount
Response
Returns a Subaccount
RetrieveSubaccountOutputDto
required
id
string
required
legalName
string
required
status
'active'
|
'inactive'
required
mcc
string
required
{"stackTrail":"components:schemas:RetrieveSubaccountOutputDto:properties:ownerId","oasType":"schema","type":"unknown"}
websiteUrl
string
{"stackTrail":"components:schemas:RetrieveSubaccountOutputDto:properties:createdAt","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:RetrieveSubaccountOutputDto:properties:updatedAt","oasType":"schema","type":"unknown"}