Consent Annual
Methods related to creating and modifying annual consent
Last updated
Was this helpful?
Methods related to creating and modifying annual consent
Last updated
Was this helpful?
POST /ICardProcess/ConsentAnnual_Create_CP
Create an annual consent by sending the credit card details to the processor via a card reader device. Use when the card is present and you can scan the magnetic stripe.
POST /ICardProcess/ConsentAnnual_Create_MAN
Create an annual consent by sending the credit card details, which include: card number, expiration date, CVV, and card holder contact data. Not created by swiping the card through a reader device.
POST /ICardProcess/ConsentAnnual_Modify
Update the payment amounts, expiration, and customer reference information for an annual consent. Does not alter the credit card saved with the consent.
ConsentMods api_ConsentAnnualEditor (object)
Updated details for the annual consent.
Fields: ExpMonth, ExpYear, Email, Zip, CustomerRefID, ServiceDescrip, RPGUID, NumDays, LimitPerCharge, LimitLifeTime
POST /ICardProcess/ConsentAnnual_Modify
Cancel an annual consent and remove credit card data from the system.
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.
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
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
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
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.
ConsentID int
This is the the ID number that is returned after you save a card on file.
CreationSuccess bool
Indicates whether the consent was created successfully.
PreConsentAuthSuccess bool
Example: true
PreConsentAuthMessage string
Example: APPROVED 095710
PreConsentAuthTxID int
Example: 84
Track string
The track data is the data on the magnetic strip of the card.
ConsentID int
This is the the ID number that is returned after you save a card on file.
AcctHolder (object)
Fields: Firstname, Lastname, Company, Title, Url, BillIngAdress, Email, Phone
CreationSuccess bool
Indicates whether the consent was created successfully.
PreConsentAuthSuccess bool
Example: true
PreConsentAuthMessage string
Example: APPROVED 095710
PreConsentAuthTxID int
Example: 84
ConsentCreator (object)
Details for the annual consent.
Fields: MerchID, CustomerRefID, ServiceDescrip, RPGUID, StartDate, NumDays, LimitPerCharge, LimitLifeTime.
AcctHolder (object)
Fields: Firstname, Lastname, Company, Title, Url, BillIngAdress, Email, Phone
ConsentCreator (object)
Details for the annual consent.
Fields: MerchID, CustomerRefID, ServiceDescrip, RPGUID, StartDate, NumDays, LimitPerCharge, LimitLifeTime.
ModifySuccess bool
Indicates whether the consent was modified successfully.
EndCustomer (object)
Fields: Firstname, Lastname, Company, Title, Url, BillIngAdress, Email, Phone
EndCustomer (object)
Fields: Firstname, Lastname, Company, Title, Url, BillIngAdress, Email, Phone
CancelledConsentID int
The ID of the cancelled consent.
CancelSuccess bool
Indicates whether the consent was cancelled successfully.
ccCardInfo (object)
Credit card details.
Fields: AccountNumber, ExpMonth, ExpYear, CSV