Fee
Last updated
Last updated
To try a test and directly interact with the API endpoint click "Test It" and use an embedded API client to send requests with custom headers and variables, then see the live response; essentially letting you test this API directly within this page. When testing please use our Demo URL: https://demo-payments.frontstream.com/api/fee
required - Identifies Processor being used by an API Partner
optional - Valid CharityId from Charity Search
internal use - Valid Panorama Organization Guid
internal use - Identifies integrated Product – PAN, Firstgiving, Artez, BFG, and can also be an Api Partner
Payment API Token GUID. Card Type of Token will be used in Fee Calculation. If using TokenGuid then do not set CreditCardTypeId parameter
required - transaction amount
required - Api Partners should set to 10 - possible values - 1 - Donation Fee, 2 - Peer-to-Peer Fee, 3 - Auction Performance Fee, 4 - Ticket Fee, 5 - Registration Fee, 6 - Quick Sales Fee, 7 - Online Store Fee, 8 - Campaign Fee, 9 - 0% Auction Performance Fee, 10 - ApiPartnerFee, 11 - ExpressPayrollFee;
required - cover the fees flag for the transaction
optional - The percentage value that you want to set for your commission on the transaction. Minimum value that will be used is the FrontStream Commission Rate as set in your contract, maximum value is the maximum commission rate set in your contract. Passing values outside of the min/max range will not result in a validation error, but will instead default to the min/max value (i.e. if your maximum commission rate in your contract is 10%, and you pass "15.0" for this value, the Payment API will simply use 10%). Not including this field or passing null also defaults to using the maximum commission rate from your contract.
optional - Overrides the default percentage processing fee
optional - An amount taken up front for the API Partner if Donor decides to apply a tip. Added to the total amount to charge on the donor’s card . Card fee calculations are performed using this value; all commission and credit card fees still apply as normal.
Used for API Partner's per card type fee calculation based on contract, For example - $0.30 per transaction for Visa, MasterCard and Discover cards and $0.50 per transaction for American Express.
access token