Calculate fees
Estimates the fees for a payment between two of the entity’s accounts, without creating one. Fees depend on the originating account, the receiving account, the deliveryPreference, and the amount. All amounts are in minor units (cents).
For a payment that converts currency this prices the fees only; use POST /tools/fx-quote for the exchange rate and the amount that would be debited.
Authorizations
Headers
Entity the request operates on — an entity id (ent_<uuid>) or me (the partner's sole entity).
Body
Internal originating account id (acct_), the debit account
External receiving account id (acct_), the credit account
The delivery preference to price. Its rail must match the receiving account, and only the values allowed for the originating account are accepted (see CreatePaymentRequest.deliveryPreference — card-funded ACH/wire payments use same-day-ach / instant-domestic-wire). The normal-speed values (standard-ach, standard-check, domestic-wire, virtual-card) price that rail at normal speed.
standard-ach, same-day-ach, rtp, standard-check, express-check, overnight-check, domestic-wire, instant-domestic-wire, virtual-card, instant-virtual-card, international-fx, fast-international-fx, international-gusd The payment amount to price, in minor units of currency — for an international account, the amount the counterparty receives.
Must match the receiving account's currency, exactly as on POST /payments.
Response
Calculated fees.
What the fee is for. Delivery-method fees use the delivery preference they apply to (standard-ach, same-day-ach, rtp, standard-check, express-check, overnight-check, domestic-wire, instant-domestic-wire, international-fx, fast-international-fx, international-gusd); funding-source fees use the funding-source type (card).
standard-ach, same-day-ach, rtp, standard-check, express-check, overnight-check, domestic-wire, instant-domestic-wire, international-fx, fast-international-fx, international-gusd, card Which side of the payment the fee is levied on: the account originating the payment or the account receiving it. Works for both estimated (calculator) and applied (payment) fees.
originator, receiver Present when the fee is a flat amount.
Present when the fee is a percentage of the payment amount.
The resolved fee for the requested payment amount, in minor units (cents). Absent only when the fee cannot be resolved without a per-payment quote (e.g. tiered pricing).