Estimate invoice net by payment rail
Estimate per-rail processing fees and net-after-fees for an invoice amount.
Related endpoints
PUT /invoices/external/batch— Batch upsert invoices by external IDGET /invoices— List invoicesPOST /invoices— Create invoiceGET /invoices/{id}— Get invoicePATCH /invoices/{id}— Update invoiceDELETE /invoices/{id}— Delete invoicePOST /invoices/{id}/refund— Refund invoicePOST /invoices/{id}/reject— Reject invoice
Common errors
404 resource_missing— the referenced resource does not exist or is not visible to your key.
Idempotency
Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.
Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.
In: header
Path Parameters
uuidRequest Body
application/json
Margin estimate inputs
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://api.revkeen.com/v2/invoices/00000000-0000-0000-0000-000000000000/margin-estimate" \ -H "x-api-key: $REVKEEN_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "amount_minor": 0, "rails": [ "card" ], "card_scheme": "string", "card_schemes": [ "string" ] }'{
"data": {
"invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",
"amount_minor": 0,
"currency": "string",
"estimates": [
{
"rail": "card",
"card_scheme": "string",
"gross_minor": 0,
"estimated_fee_minor": 0,
"net_after_fees_minor": 0,
"fee_breakdown": {
"percentage_fee_minor": 0,
"fixed_fee_minor": 0,
"minimum_fee_adjustment_minor": 0
},
"pricing_source": "matrix",
"matrix_version": "string"
}
]
}
}