Calculate fees
Calculate the estimated fees associated with an payment given the amount, payment source, and disbursement method. Can be used to calculate fees for a payment before creating an invoice.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
amount
Total amount in major units. If the entered amount has more decimal places than the currency supports, trailing decimals will be truncated.
paymentSourceId
ID of payment source.
paymentDestinationId
ID of payment destination.
currency
Currency code for the amount. Defaults to USD.
creatorEntityId
ID of the entity creating the invoice. If not provided, the fees will be calculated with the default pricing for the organization.
paymentDestinationOptions
Options for the payment destination. Depending on the payment destination, this may include things such as check delivery method.
type
Type of payment to calculate fees for. Defaults to PAYABLE (Accounts Payable).
Allowed values:
Response
This endpoint returns an object.
sourcePaymentMethodFee
Fee charged to the platform (C1) for processing the source payment method. For example, credit card interchange and acquiring fees.
sourcePlatformMarkupFee
Fee charged to the payer (C2).
destinationPaymentMethodFee
Fee charged to the platform (C1) for processing the destination payment method. For example, postage for a check payment.
destinationPlatformMarkupFee
Fee charged to the payee (C3).