Jump to Content

Home Guides API Reference Changelog Discussions

v1.0

API Reference

v1.0Home Guides API Reference Changelog Discussions

All

Pages

Start typing to search…

Overview

Getting Started with OvalFi APIs
- Authentication
- Encryption guide
Workflow Guides
Partner Accounts
Going Live

Understanding the APIs

Sandbox and Testing
Webhook Notifications
Errors
Mandatory Fields

👥 Customer Management

Customer Management Overview
Create Customerpost
Update Customerpatch
Get all Customersget
Get Customer by IDget
Delete customerdel

👤 Beneficiaries

Beneficiary overview
Create beneficiarypost
Get beneficiaries by IDget
Get beneficiariesget

↗️ Payout service

Payout Overview
Initiate payout with filepost
Initiate direct payoutpost
Initiate payout to existing beneficiariespost
Cancel payoutpost
Get Payouts by IDget
Get Payoutsget
Get Payouts documentsget
Get payout configurationget
Update payout accountput

↙️ Deposit

Initiate business depositpost
Mock customer depositpost
Mock Process Local or Fx Depositget
XOF and XAF deposit

Transfer Service

Transfers Overview
Get Exchange Rate Quotesget
Initiate Transfer for customerspost
Get transfer detailsget
Cancel transferget
Initiate terminal transferpost
Get terminal transfersget
Get Transfer by IDget

🔁 Currency swaps

Currency swaps overview
Get currency swaps by IDget
Get currency swapsget
Fetch quotespost
Initiate Currency Swapspost

🌐 Crypto Wallet Service

Get Supported Assetsget
Get Customer Walletget
Get all Customer Walletsget

💹 Virtual Accounts

Virtual Account Overview
Create Payment Accountspost
Get Payment Accountsget
Resolve accountpost
Get banksget

🌐 Transactions Management

Transaction management overview
Transaction Historyget
Cancel Transactiondel
Get balancesget
Balance APIs
- Get Customer Balanceget
- Get all Customer Balancesget

↗️ Withdrawals

Withdrawals / Disbursements

💳 Card Payments

Initiate card requestpost
Complete Payment card requestpost
Get link to add paymentpost
Get All Payment Cardsget
Get All Payment Cardsget
Get link to authorize userspost

KYC Verification

KYC Verification Overview
Verify customer on AML Watchlistpost
Verify customer driver's licensepost
Resubmit customer KYCpost
Verify Customer Documentpost
Resubmit customer doucmentpost
KYC/KYB Verification in Nigeria
- Verify Customer KYC IDpost
Get link to verify biometricsget

Powered by

Get link to verify biometrics

get https://sandbox-api.ovalfi-app.com/api/v1/kycs/:customerID/biometrics

Language

Click Try It! to start a request and see the response here!