API Reference

Add a convenience fee rule

post
https://earthnode-dev.vopay.com/api/v2/account/convenience-fees/rules

Adds a restriction rule for the authenticated account. Convenience fees will not be collected for transactions that match the rule. Requires the ManageConvenienceFees permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

string
required

What the rule matches on. One of: Jurisdiction, Label, GLCode, TransactionTypeCode, ClientReferenceNumber

string
required

How RuleValue is compared. One of: IN, NOT IN, EQUALS, NOT EQUALS, BEGINS, NOT BEGINS, CONTAINS, NOT CONTAINS

string
required

The value to compare against; comma-separated values for IN / NOT IN. For Jurisdiction, province or state abbreviations (e.g. BC,ON,AB)

Response

Updated 5 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?