Consent Recurring
Methods related to creating and modifying recurring consent
Last updated
Was this helpful?
Methods related to creating and modifying recurring consent
Last updated
Was this helpful?
POST /ICardProcess/ConsentRecurring_Create
Creates a recurring consent. Depending upon user account settings, this also authorize the card for $0.
ccCardInfo api_CardInfo2 (object)
Fields: AccountNumber, ExpMonth, ExpYear, CSV, Track
ConsentCreator api_ConsentRecurringCreator (object)
Fields: MerchID, CustomerRefID, ServiceDescrip, RPGUID, StartDate, NumPayments, TotalAmount, Period
POST /ICardProcess/ConsentRecurring_Modify
Update the payment amounts, expiration, and customer reference information for a recurring consent. Does not alter the credit card saved with the consent.
ConsentMods api_ConsentRecurringEditor (object)
Fields: ExpMonth, ExpYear, Email, Zip, CustomerRefID, ServiceDescrip, RPGUID
POST /ICardProcess/ConsentRecurring_Cancel
Cancel a recurring consent and remove credit card data from the system.
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.
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.
EndCustomer (object)
Fields: Firstname, Lastname, Company, Title, Url, BillIngAdress, Email, Phone
AcctHolder (object)
Fields: Firstname, Lastname, Company, Title, Url, BillIngAdress, Email, Phone
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.
CreationSuccess bool
Indicates whether the consent was created successfully.
PreConsentAuthSuccess bool
Example: true
PreConsentAuthMessage string
Example: APPROVED 095710
PreConsentAuthTxID int
Example: 84
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.
ModifySuccess bool
Indicates whether the consent was modified successfully.
CancelledConsentID int
The ID of the cancelled consent.
CancelSuccess bool
Indicates whether the consent was cancelled successfully.
ConsentID int
This is the the ID number that is returned after you save a card on file.
Both recurring and subscription consent can be processed using the SOAP API by calling the method.