Skip to main content

Quote the surcharge for a saved payment method

POST 

/api/invoices/:invoiceId/surcharge-quote

Returns the exact card surcharge and total that charging accountVaultId for amount on this invoice would carry, without charging anything. Show it to the payer before calling PUT /invoices/{invoiceId}/payment with the same method and amount: the charge applies the same rules to the same card, so it equals the quote unless the company's fee settings change in between. Bank accounts, debit and prepaid cards, Amex, states that ban surcharges, and cards whose type PayConnect cannot read are never surcharged (surcharge is 0 and blockedReason says why). Authenticate with x-session-token header.

Request​

Responses​

200