Process Annual Consent
Methods related to processing annual consent
Last updated
Was this helpful?
Methods related to processing annual consent
Last updated
Was this helpful?
POST /ICardProcess/ConsentAnnual_ProcPayment
Use the credit card stored on file to process a payment for an existing consent.
POST /ICardProcess/ConsentAnnual_ProcPayment_Alt
Processes a credit card payment for an existing consent, but the payment is transferred to a different merchant than the original one.
The alternate merchant must be previously assigned to the account holders' account.
FunctionOk boolean
Indicates if the function executed correctly.
RespMsg string
Friendly response message for the user.
ErrMsg string
Error message. Empty or null if no error.
ErrCode int
Error code. 0 indicates success.
FunctionOk boolean
Indicates if the function executed correctly.
RespMsg string
Friendly response message for the user.
ErrMsg string
Error message. Empty or null if no error.
ErrCode int
Error code. 0 indicates success.
SessKey string
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.
Example: B9F24903C3BA4770AE303032303541303032353437
SessKey string
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.
Example: B9F24903C3BA4770AE303032303541303032353437
ConsentID int
This is the the ID number that is returned after you save a card on file.
ConsentID int
This is the the ID number that is returned after you save a card on file.
TxApproved boolean
Indicates if the transaction was approved.
TxApproved boolean
Indicates if the transaction was approved.
ProcessAmount decimal
The $ amount which you want to charge a card that is already on file as an annual consent.
ProcessAmount decimal
The $ amount which you want to charge a card that is already on file as an annual consent.
TxID int
A unique ID of the transaction.
TxID int
A unique ID of the transaction.
CVVresult string
CVV response code indicating the result of the Card Verification Value check.
Values: - M (Match) - N (No Match)
CVVresult string
CVV response code indicating the result of the Card Verification Value check.
Values: - M (Match) - N (No Match)
When you create a 'card on file' or consent, you specify a merchant. When processing the consent, the system defaults to sending these funds to the original merchant.
If you plan to process with an alternate merchant, ask your support rep to adjust the settings on your account to ProcessCreditWithAlternateMerchant = true.
AlternateMerchID int
The ID of the merchant to send the funds to.
TxnCode string
A code representing the type of transaction.
TxnCode string
A code representing the type of transaction.
AVSresult string
AVS response code indicating the result of the Address Verification Service.
Example: Y
AVSresult string
AVS response code indicating the result of the Address Verification Service.
Example: Y
AcquirerResponseEMV string
RequiresVoiceAuth boolean
IsPartialApproval boolean
Indicates whether the transaction received partial approval.
ResponseAuthorizedAmount decimal
ResponseBalanceAmount decimal
ResponseApprovedAmount decimal
AcquirerResponseEMV string
RequiresVoiceAuth boolean
IsPartialApproval boolean
Indicates whether the transaction received partial approval.
ResponseAuthorizedAmount decimal
ResponseBalanceAmount decimal
ResponseApprovedAmount decimal