API referenceCharges

Quote the fee on a charge

InversePay's fee on a charge, from your plan, before you open it. Priced exactly as the charge itself will be, so the quote is the fee. To put your own margin on a sale, decide what you want to keep and ask with `net_minor`. On a plan charging 2%, say, keeping 10,000 RWF means charging 10,205 RWF. The fee is on the amount the payer pays, so adding 2% to your price falls just short. `price` is the plan the quote was priced on, so you can price any other amount without asking again: the percentage of the amount, rounded down, plus the flat part, then no less than the floor and no more than the cap.

GET
/api/b/v1/charges/fee

InversePay's fee on a charge, from your plan, before you open it.

Priced exactly as the charge itself will be, so the quote is the fee.

To put your own margin on a sale, decide what you want to keep and ask with net_minor. On a plan charging 2%, say, keeping 10,000 RWF means charging 10,205 RWF. The fee is on the amount the payer pays, so adding 2% to your price falls just short.

price is the plan the quote was priced on, so you can price any other amount without asking again: the percentage of the amount, rounded down, plus the flat part, then no less than the floor and no more than the cap.

Query Parameters

currency*Currency

ISO 4217, three letters.

Length3 <= length <= 3
amount_minor?|

What the payer would be charged, in minor units. Give this or net_minor, not both.

net_minor?|

What you want to receive, in minor units. The answer's amount_minor is then the least to charge so that this much is left after the fee. Give this or amount_minor, not both.

channel?|

How the payer will pay. card is priced as a card payment; anything else, or nothing, as a collection.

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/charges/fee?currency=str"
{  "currency": "string",  "amount_minor": 0,  "fee_minor": 0,  "net_minor": 0,  "price": {    "percentage_basis_points": 0,    "fixed_minor": 0,    "min_fee_minor": 0,    "max_fee_minor": 0,    "plan": "standard"  }}