API ReferenceCalculate

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

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

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.
creatorEntityIdstringOptional
ID of the entity creating the invoice. If not provided, the fees will be calculated with the default pricing for the organization.
paymentDestinationOptionsobjectOptional
Options for the payment destination. Depending on the payment destination, this may include things such as check delivery method.
typeenumOptional

Type of payment to calculate fees for. Defaults to PAYABLE (Accounts Payable).

Allowed values:

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).

Errors