Scenario : Get a quote for the exchange rate & fees that could apply for a payout transaction
Step 1 : Retrieve your API Keys from the OvalFi dashboard.
Step 2 : Identify the local currency you have and wish to exchange, as well as the amount you have in the local currency.
Step 3 : Identify the currency of your destination, the currency your payout should be in.
Step 4 : Call the Get Exchange Rates API to retrieve conversion rate, fees and commission to be accrued if that specific amount was converted.
Scenario : Initiate a Payout Transaction
Step 1 : Retrieve your API Keys from the OvalFi dashboard.
Step 2 : Fetch the customerID of the customer on whose behalf you want to exchange funds and carry out a transfer, then Step 4.
Step 3 : If you do not know the specific customerID, you can retrieve a list of all your customers by calling the Get all Customers API.
Step 4 : Initiate a Payout request by calling the Initiate Transfer API
Note the following
- Currency passed in this call is the Destination currency
- Bank account and personal details passed is that of the payout customer/recipient/beneficiary
- At the point of making this API call, OvalFi doesn't know the originating currency or the currency partner wishes to settle with.
- Transfer requests are batched on a daily basis based on destination currency with an initial status of Unsettled/Initiated (i.e. if a total of 500 payout requests were initiated via API and 200 of the requests have a USD destination currency, 150 are GHC, 50 are NGN and 100 are USDC, you would have a total of 4 batches to settle for that day etc).
- The ID returned in the response is the transferID uniquely identifying the transaction at OvalFi's end.