Generate a Quote

post

https://sandboxapi.fincra.com/quotes/generate

This endpoint is used for generating a quote. Quotes are used to initiate conversions, global collections, or cross currency payout

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

sourceCurrency

string

required

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

destinationCurrency

string

required

The currency in which the recipient will be receiving funds

amount

string

required

The amount you want to send or convert

action

string

required

Defaults to send

the value can only be "send" for conversions and disbursement.

transactionType

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:

business

string

required

The unique Identifier of the business

feeBearer

string

enum

required

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.

Allowed:

paymentDestination

string

enum

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 or mobile_money_wallet

Allowed:

paymentScheme

string

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) and not conversion

beneficiaryType

string

enum

required

Defaults to individual

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

Allowed:

delay

boolean

Defaults to false

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

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400