Jump to Content
Home
Guides
API Reference
Changelog
Discussions
v1.0
Log In
API Reference
Log In
v1.0
Home
Guides
API Reference
Changelog
Discussions
Payout Overview
All
Pages
Start typing to search…
JUMP TO
Overview
Getting Started with OvalFi APIs
Authentication
Encryption guide
Workflow Guides
Create Customer Workflow
Get Exchange Rates and Transfer Workflow
Payout workflow
Partner Accounts
Going Live
Understanding the APIs
Sandbox and Testing
Webhook Notifications
Deposit Webhooks
Withdrawal Webhooks
Transfer Webhooks
Crypto Wallets Webhooks
Virtual Account Allocation Webhooks
Payout webhooks
Errors
Mandatory Fields
👥 Customer Management
Customer Management Overview
Create Customer
post
Update Customer
patch
Get all Customers
get
Get Customer by ID
get
Delete customer
del
👤 Beneficiaries
Beneficiary overview
Create beneficiary
post
Get beneficiaries by ID
get
Get beneficiaries
get
↗️ Payout service
Payout Overview
Initiate payout with file
post
Initiate direct payout
post
Initiate payout to existing beneficiaries
post
Cancel payout
post
Get Payouts by ID
get
Get Payouts
get
Get Payouts documents
get
Get payout configuration
get
Update payout account
put
↙️ Deposit
Initiate business deposit
post
Mock customer deposit
post
Mock Process Local or Fx Deposit
get
XOF and XAF deposit
Create Customer Payment Intent
post
Complete Customer Payment intent
post
Authenticate Customer Payment Intent
post
Transfer Service
Transfers Overview
Get Exchange Rate Quotes
get
Initiate Transfer for customers
post
Get transfer details
get
Cancel transfer
get
Initiate terminal transfer
post
Get terminal transfers
get
Get Transfer by ID
get
🔁 Currency swaps
Currency swaps overview
Get currency swaps by ID
get
Get currency swaps
get
Fetch quotes
post
Initiate Currency Swaps
post
🌐 Crypto Wallet Service
Get Supported Assets
get
Get Customer Wallet
get
Get all Customer Wallets
get
💹 Virtual Accounts
Virtual Account Overview
Create Payment Accounts
post
Get Payment Accounts
get
Resolve account
post
Get banks
get
🌐 Transactions Management
Transaction management overview
Transaction History
get
Cancel Transaction
del
Get balances
get
Balance APIs
Get Customer Balance
get
Get all Customer Balances
get
↗️ Withdrawals
Withdrawals / Disbursements
Initiate Withdrawal
post
Initiate Crypto Withdrawal
post
Initiate Fiat Withdrawal
post
💳 Card Payments
Initiate card request
post
Complete Payment card request
post
Get link to add payment
post
Get All Payment Cards
get
Get All Payment Cards
get
Get link to authorize users
post
KYC Verification
KYC Verification Overview
Verify customer on AML Watchlist
post
Verify customer driver's license
post
Resubmit customer KYC
post
Verify Customer Document
post
Resubmit customer doucment
post
KYC/KYB Verification in Nigeria
Verify Customer KYC ID
post
Get link to verify biometrics
get
Powered by
Payout Overview
Ask AI
