Sign in

v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

Generate a Quote

This endpoint is used for generating a quote. Quotes are used to initiate conversions, cross-currency payout, or cross-currency checkout (coming soon).

post/quotes/generate

Request body

sourceCurrencystring required

The currency which is used to fund a currency conversion or payout

destinationCurrency'NGN' | 'USD' | 'EUR' | 'GBP' | 'GHS' | 'KES' | 'UGX' | 'TZX' | 'ZMW' | 'XAF' | 'XOF' | 'USDT' | 'USDC' | 'CNGN' required

The currency in which the recipient will be receiving funds

amountstring required

The transaction amount. With send action, it represents the amount being sent in the source currency.

With receive action, it represents the amount to be received in the destination currency.

action'send' | 'receive' required

Determines how amount is interpreted.

send — quote returns how much the recipient will receive. receive — quote returns how much the sender must pay

transactionType'conversion' | 'disbursement' required

If you want to make a payout, choose "disbursement," and if you want to convert a currency and receive the funds in your Fincra balance, choose "conversion.”

businessstring required

The unique Identifier of the business

feeBearer'customer' | 'business'

If you choose Customer, the fee would be deducted from the amount the beneficiary will receive. If you choose business, the fee would be deducted business balance for a cross-currency payout.

paymentDestination'bank_account' | 'fliqpay_wallet' | 'mobile_money_wallet' | 'crypto_wallet' required

This is the type of account you want to send your payments to. For conversions the payment destination must always be fliqpay_wallet and for payouts the payment destination must always be bank_account , mobile_money_wallet or crypto_wallet

paymentScheme'swift' | 'ach' | 'fps' | 'sepa' | 'sepa_instant' | 'chaps' | 'fed_wire' | 'usdt_erc20' | 'usdt_trc20' | 'usdt_solana' | 'usdt_bep20' | 'usdc_erc20' | 'usdc_solana'

This is the valid payment scheme for the destination currency you want to generate a quote for. This is only required when the transaction type is disbursement(to foreign currencies or crypto wallet) and not conversion

beneficiaryType'individual' | 'corporate'

The beneficiary type e.g individual or corporate. This is necessary in order to generate quotes for all African currencies.

delayboolean

This is only required when payment integration method is "Global Collections"

Response

200

OR

Example response

{
  "success": true,
  "message": "Quote generated successfully",
  "data": {
    "sourceCurrency": "KES",
    "destinationCurrency": "USD",
    "sourceAmount": 10000,
    "destinationAmount": 92.99999999999999,
    "action": "send",
    "transactionType": "conversion",
    "initialAmount": 10000,
    "quotedAmount": 92.99999999999999,
    "rate": 0.0093,
    "amountToCharge": 10000,
    "amountToReceive": 93,
    "reference": "5abe864c-0137-493e-b6ce-e51d424243e2",
    "expireAt": "2024-10-10T07:57:05.923Z",
    "settlementDate": "2024-10-10T07:55:05.000Z"
  }
}