Create a Quote

POST/quotes

Create a new quote is used to get a quote for a transfer from one country to another.

Response

Created

idstring<uuid>

Transfer Identifier

external_idstring

Transfer Reference provided by API caller

mode"sending" | "receiving"

sending mode allow users to specify the sending_amount and get a quote for receiving_amount; receiving mode allows users to specify the receiving_amount and get a quote for sending_amount.

source_countrystring<iso-3166-1-alpha3>

Country code funds sent from (ISO-3166-1), e.g. USA

destination_countrystring<iso-3166-1-alpha3>

Country code funds sent to (ISO-3166-1), e.g. USA

destination_account_type"bank_account" | "digital_wallet" | "cash_pickup" | "card"

The Account Type to receive funds

sending_amountnumber<double>

Sending amount

sending_currencystring<iso-4217-ext>

Sending Currency which is defined by /currencies.

receiving_amountnumber<double>

Receiving amount

receiving_currencystring<iso-4217-ext>

Receiving Currency which is defined by /currencies.

exchange_ratenumber<double>

The exchange rate from sending currency to receiving currency, e.g. 1 BTC = 57151.5 USD.

feenumber<double>

This indicates the amount which will be debit from merchant’s balance with balance_id for this transfer.

fee_currencystring<iso-4217-ext>

Iso-4217 for fiat_money (i.e., local currency), non-iso-4217 listed here (https://en.wikipedia.org/wiki/ISO_4217) for cyptocurrency’

expires_atstring<date-time>
charge_type"OUR" | "SHA"

To specify which party bears the bank fee. OUR means that the initiator will pay the fee, which means an additional fee when you create the transfer. SHA means that both the initiator and the recipient will pay the fee. Some fees will be deducted from the amount sent by the intermediary banks

intermediary_bank_feenumber<double>

Indicates the intermediary bank charge. It will follow the sending currency.

conditionsobject

Conditions that a transfer must meet before it can be processed

Show conditions properties
document_typesobject
Show document_types properties
transfer_purposestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring
Request
curl -X POST "https://api.uat.triple-a.io/api/fiat-payout/v1/quotes" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d 'null'
Response
{
  "id": "00000000-0000-0000-0000-000000000000",
  "external_id": "string",
  "mode": "sending",
  "source_country": "USA",
  "destination_country": "CHN",
  "destination_account_type": "bank_account",
  "sending_amount": 0.01,
  "sending_currency": "BTC",
  "receiving_amount": 57.15,
  "receiving_currency": "USD",
  "exchange_rate": 57151.5,
  "fee": 57.15,
  "fee_currency": "USD",
  "expires_at": "2023-07-13T15:31:02.886Z",
  "charge_type": "SHA",
  "intermediary_bank_fee": 25,
  "conditions": {
    "document_types": {
      "transfer_purpose": "string"
    }
  }
}