Quotes

Status: Available

Get the price of a collection or a payout before you commit. A quote gives both sides of the movement: the USD side and the local side. It also gives the rate and each fee.

Quotes are indicative: rates move, so the firm amount is set when you initiate the movement. Treat a quote as a price preview to show your user.

The quote object is the same for both directions:

Field	Description
`type`	`collection` or `payout`.
`usd`	The USD side — what you receive (collection) or send (payout).
`local`	The local side — what the customer pays (collection) or the recipient receives (payout).
`exchange_rate`	`{ pair, rate }`, e.g. `USD/NGN @ 1582`.
`fees`	`platform_fee`, `provider_fee`, `total_fee` — all in USD.

Quote a collection

POST /v1/collections/quote

curl -X POST {BASE_URL}/v1/collections/quote \
  -H "x-api-key: sk_test_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "country": "NG", "currency": "NGN", "amount": 50000 }'

{
  "code": 200,
  "message": "Quote created",
  "data": {
    "type": "collection",
    "usd":   { "amount": 31.60, "currency": "USD" },
    "local": { "amount": 50000, "currency": "NGN", "country": "NG" },
    "exchange_rate": { "pair": "USD/NGN", "rate": 1582.00 },
    "fees": { "platform_fee": 0, "provider_fee": 0, "total_fee": 0, "currency": "USD" }
  }
}

The amount_type field tells us how to read amount. With source, the default, amount is the local amount that the customer pays. With destination, amount is the USD that you want in your balance.

Quote a payout

POST /v1/payouts/quote

curl -X POST {BASE_URL}/v1/payouts/quote \
  -H "x-api-key: sk_test_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "country": "NG", "currency": "NGN", "amount": 100, "method": "bank" }'

{
  "code": 200,
  "message": "Quote created",
  "data": {
    "type": "payout",
    "usd":   { "amount": 100.50, "currency": "USD" },
    "local": { "amount": 158200, "currency": "NGN", "country": "NG" },
    "exchange_rate": { "pair": "USD/NGN", "rate": 1582.00 },
    "fees": { "platform_fee": 0.50, "provider_fee": 0, "total_fee": 0.50, "currency": "USD" }
  }
}

For a payout with amount_type: source, the default, amount is the USD that you send. With destination, amount is the local amount that the recipient gets.

The numbers above are examples only. When payout initiation is available, you will send a quote to hold its price.

Balance

Collections