Calculate fees | Mercoa | Documentation

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.

Authentication

AuthorizationBearer

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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

501

Unimplemented

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

This endpoint expects an object.

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

ID of payment source.

ID of payment destination.

Currency code for the amount. Defaults to USD.

ID of the entity creating the invoice. If not provided, the fees will be calculated with the default pricing for the organization.

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

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

This endpoint returns an object.

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

Fee charged to the payer (C2).

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

Fee charged to the payee (C3).

$	curl -X POST https://api.mercoa.com/fees \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"amount": 100,
>	"paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
>	"paymentDestinationId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769"
>	}'

1	{
2	"sourcePaymentMethodFee": 0.1,
3	"sourcePlatformMarkupFee": 0.2,
4	"destinationPaymentMethodFee": 1,
5	"destinationPlatformMarkupFee": 1.5
6	}

$	curl -X POST https://api.mercoa.com/fees \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"amount": 100,
>	"paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
>	"paymentDestinationId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769"
>	}'

1	{
2	"sourcePaymentMethodFee": 0.1,
3	"sourcePlatformMarkupFee": 0.2,
4	"destinationPaymentMethodFee": 1,
5	"destinationPlatformMarkupFee": 1.5
6	}