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).

Body Params
string
required

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

string
enum
required

The currency in which the recipient will be receiving funds

string
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.

string
enum
required
Defaults to send

Determines how amount is interpreted.

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

Allowed:
string
enum
required
Defaults to conversion

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.”

Allowed:
string
required

The unique Identifier of the business

string
enum
Defaults to customer

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.

Allowed:
string
enum
required
Defaults to fliqpay_wallet

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

Allowed:
string
enum

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

string
enum
Defaults to individual

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

Allowed:
boolean
Defaults to false

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

Response

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json