Public developer API
POST /v1/collections/quote
Returns the Dutch API fee for an Africa-only mobile-money collection, the amount that lands in your wallet, and the currently available amount range.
Access
A project-specific API key (Authorization: Bearer dapi_live_...) and its Business ID (X-Business-Id). Rate limited per business (120 calls a minute by default).
Supported matching country/currency pairs: CM/XAF, GH/GHS, KE/KES, RW/RWF and UG/UGX. No named operator/network is selected by this API.
Body
| Field | Type | Required | Description |
|---|---|---|---|
amount | number | yes | Amount the payer will be asked to approve, in the local currency. |
currency | string | yes | Local currency, for example XAF. |
country | string | no | CM, GH, KE, RW or UG, matching the currency (XAF, GHS, KES, RWF or UGX). Defaults to the country of the currency. |
markupPercent | number | no | Your markup, percent of the amount. |
markupFixed | number | no | Your fixed markup in the request currency. |
Example request
curl --request POST \
--url 'https://production.dutchapi.co/v1/collections/quote' \
--header 'X-Business-Id: YOUR_BUSINESS_ID' \
--header 'Authorization: Bearer bsk_live_YOUR_BUSINESS_SECRET' \
--header 'Content-Type: application/json' \
--data '{"amount":10000,"currency":"XAF","markupPercent":1}'
Response 200
{
"amount": 10000,
"currency": "XAF",
"fees": {
"currency": "XAF",
"rule": "percentage",
"ruleDetail": "2% of the amount",
"dutchFee": 200,
"markup": 100,
"totalFee": 300
},
"you_receive": 9800,
"min": 500,
"max": 500000,
"indicative": true
}
Errors
| Status | error | Meaning |
|---|---|---|
| 400 | valid_amount_required | amount must be a positive number. |
| 422 | collection_not_priced | There is no published collection rate for that country or method. |
| 400 | network_not_supported | Do not send a named mobile-money network. |
| 422 | unsupported_collection_currency | Collections are available only in CM/XAF, GH/GHS, KE/KES, RW/RWF and UG/UGX. |
| 422 | amount_below_minimum | The amount is under the published minimum. |