Skip to main content
POST
Create a new Quote

Authorizations

Authorization
string
header
required

Bearer Authentication

Headers

X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

X-BU-PUBLIC-KEY
string
Example:

"pub_uibaidu930ani"

Body

application/json

Create a new Quote

source_currency
string<string>
required

A valid currency

Required string length: 1 - 10
Example:

"BTC"

target_currency
string<string>
required

A valid currency

Required string length: 1 - 10
Example:

"BTC"

quote_currency
string<string>

This optional field specifies the currency to price the quote in, which is converted from the source amount

Required string length: 1 - 10
Example:

"NGN"

quote_amount
string

The amount in the pricing currency. Required when quote_currency is provided

Example:

"100"

reversal_policy
enum<string>

This optional field specifies the reversal policy for the conversion. Allowed values are 'conversion_only'.

Available options:
conversion_only
reference
string
Required string length: 12 - 64
Example:

"QUO_123456abc"

source_amount
string

Source Amount. Either source_amount or target_amount must be set.

Example:

"100"

target_amount
string

Target Amount. Either source_amount or target_amount must be set.

Example:

"100"

pay_in
object
pay_out
object

Response

Quote Response

General response Values

status
enum<string>
required
Available options:
success,
error
Example:

"success"

message
string
required
Example:

"message for success"

data
object
required