Consent Annual
Last updated
Was this helpful?
Last updated
Was this helpful?
This API call is for merchant accounts that are specifically configured for surcharge and/or convenience fee processing. Prior to charging a card on file, you may use this method to properly calculate the intended fees (Surcharging or Convenience fees ).
Fees will be calculated based on the merchant configuration and the card type itself. It is important to show the calculated fees at the point of sale so that a cardholder can reject the sale if they desire.
You can specify a Alternate MerchID rather than use the merchant record originally designated when you saved the card. A Value Of ZERO will use the original Merchant record.
Once you have determined your fees you can then call the method named : Charge Stored Card with Options to authorize the sale.
A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.
A1842D663E9A4A72XXXXXXXX303541303234373138application/jsonapplication/jsonID for consent associated with the merchant account
7849Base $ amount for which fees are to be calculated
52ID of the merchant to collect the payment funds. Use 0 for the merchant on consent.
0Successful calculation of fees
Use this call to Cancel a consent (Card On File). You will need the ConsentID in order to execute this method.
A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.
A1842D663E9A4A72XXXXXXXX303541303234373138application/jsonapplication/jsonID of the consent to be canceled
20Successful cancellation of consent
This Method allows the user to charge a stored Card.
ConsentID Please supply the ID of the Consent ( or stored card data )
AlternateMerchID Here you can use ZERO if you plan to charge the same merchant record which was specified when saving the Card Info. You can use a positive integer if you plan to charge a merchant record which differs from the one originally used.
purchDetails If you want to attach new reference data to the transaction you may do so using the following fields:
ServiceDescrip : description of the transaction ClientRefID : your user defined reference ID RPGUID : another user defined reference ID If you choose NOT to supply these fields ( use empty string ) the system will pull this data from the original stored card data.
Amounts Here you will supply the amount of the transaction. You may supply FEES but only if these have been properly configured for each Merchant record.
If you don't have FEES configured simply supply the BaseAmt and TotalAmt.
If you do Have Fees Configured you can call the method named: Calculate Annual Consent Fees prior to calling this method.
You can specify fee values up to and including those determined using the above method.
If you specify values greater than those calculated above, then your value will be clamped.
IMPORTANT : Always check your response to determine the fees which are APPROVED as this may differ from what was REQUESTED.
User Here you can assign a user to the sale so that we record the person which is initiating the sale within the integrator software.
A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.
A1842D663E9A4A72XXXXXXXX303541303234373138application/jsonapplication/jsonID of the consent (or stored card data)
8Use 0 for the original merchant record or a positive integer for a different merchant record
0The user initiating the sale. Used for reporting.
SamuelSuccessful charge of the stored card
A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.
A1842D663E9A4A72XXXXXXXX303541303234373138application/jsonapplication/jsonID of the consent to be modified
10Successful modification of annual consent
Use this call to process a payment using a stored card. You will need the ConsentID acquired from creating a consent. As usual you will monitor the FunctionOK flag (to ensure no exceptions were encountered), then take a look at the TxApproved Flag to determine your approval or declined status.
IMPORTANT: Duplicate Charges One of the most common issues we encounter is the DUPLICATE CHARGE: It is up to you to make sure the user cannot cause a stored card to get charged twice in a short period of time. Make sure your Button or other means of requesting an authorization is Immediately disabled in order to prevent the DOUBLE TAP. Merchants and Cardholders need to be protected against this nuisance. For Web Forms simply disable your button during processing and close out your session after you receive a response. In addition, you can take note of the ConsentID and amount so that you no longer process a charge for this SAME ConsentID and amount for some reasonable time period.
A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.
A1842D663E9A4A72XXXXXXXX303541303234373138application/jsonapplication/jsonID of the consent to be used for payment
21Amount to be processed
5Successful processing of consent payment
Use this call to process a payment using a stored card. You will need the ConsentID acquired from creating a consent. As usual you will monitor the FunctionOK flag (to ensure no exceptions were encountered), then take a look at the TxApproved Flag to determine your approval or declined status.
IMPORTANT: Duplicate Charges One of the most common issues we encounter is the DUPLICATE CHARGE: It is up to you to make sure the user cannot cause a stored card to get charged twice in a short period of time. Make sure your Button or other means of requesting an authorization is Immediately disabled in order to prevent the DOUBLE TAP. Merchants and Cardholders need to be protected against this nuisance. For Web Forms simply disable your button during processing and close out your session after you receive a response. In addition, you can take note of the ConsentID and amount so that you no longer process a charge for this SAME ConsentID and amount for some reasonable time period.
A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.
A1842D663E9A4A72XXXXXXXX303541303234373138application/jsonapplication/jsonID of the consent to be used for payment
542Amount to be processed
1ID of the alternate merchant
1Successful processing of consent payment with alternate merchant