Calculate fees

POST

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.

Request

This endpoint expects an object.
amountdoubleRequired

Total amount in major units. If the entered amount has more decimal places than the currency supports, trailing decimals will be truncated.

paymentSourceIdstringRequired

ID of payment source.

paymentDestinationIdstringRequired

ID of payment destination.

currencyenumOptional

Currency code for the amount. Defaults to USD.

paymentDestinationOptionsobjectOptional

Options for the payment destination. Depending on the payment destination, this may include things such as check delivery method.

Response

This endpoint returns an object.
sourcePaymentMethodFeedouble

Fee charged to the platform (C1) for processing the source payment method. For example, credit card interchange and acquiring fees.

sourcePlatformMarkupFeedouble

Fee charged to the payer (C2).

destinationPaymentMethodFeedouble

Fee charged to the platform (C1) for processing the destination payment method. For example, postage for a check payment.

destinationPlatformMarkupFeedouble

Fee charged to the payee (C3).