API referencePayouts

Quote the fee on a payout

InversePay's fee on a payout, from your plan, before you send it. Priced exactly as the payout itself will be, so the quote is the fee. It is added on top, so the recipient receives `amount_minor` in full and `total_minor` leaves your balance. If you charge your own customers for sending money - a payroll run, a transfer - this is your cost per payout. What you charge them on top of it is your margin. A batch is priced line by line in the same way when its file is checked.

GET
/api/b/v1/payouts/fee

InversePay's fee on a payout, from your plan, before you send it.

Priced exactly as the payout itself will be, so the quote is the fee. It is added on top, so the recipient receives amount_minor in full and total_minor leaves your balance.

If you charge your own customers for sending money - a payroll run, a transfer - this is your cost per payout. What you charge them on top of it is your margin. A batch is priced line by line in the same way when its file is checked.

Query Parameters

currency*Currency

ISO 4217, three letters.

Length3 <= length <= 3
amount_minor*Amount Minor

What the recipient would receive, in minor units.

Range0 < value

Response Body

application/json

application/json

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