Query Annual Consent

Methods related to querying annual consent

Query Annual Consent

POST /ICardProcess/ConsentAnnual_Query

Return annual consent details.

Request body

---

Response body

---

---

Consents List<api_ConsentAnnual> (array<object>)

A list of relevant consent records.

Fields: ID, AcctHolderID, CustID, MerchID, CustomerRefID, RPGUID, ServiceDescrip, AcctHolderLastName, AcctHolderFirstName, IsEnabled, StartDate, EndDate, NumDays, LimitPerCharge, LimitLifeTime, AuthTxID, CreatedOn, CreatedBy, AcctNo.

Query Annual Consent - Stats

POST /ICardProcess/ConsentAnnual_Stats

Return statistics for a single consent such as the number of charges or open and settled amounts.

Request body

---

Response body

---

Stats api_ConsentAnnualStats (object)

Fields: ID, IsEnabled, NumChargeAttempts, NumFailedAttempts, FirstChargeAttempt, LastChargeAttempt, TotalDollarsSettled, TotalDollarsOpen, LastSettledAmount, LastChargeAmount, RemainingInConsent, NumTx, NumSettled, NumFailed, NumOpen, LimitLifeTime.

Query Annual Consent - Full

POST /ICardProcess/ConsentAnnual_FullDetail

Return the details for the consent, the card holder contact, and end customer information.

Request body

---

Response body

---

ConsentAnnual api_ConsentAnnualFullDetailResponse (object)

Fields: ID, AcctHolderID, CustID, MerchID, CustomerRefID, RPGUID, ServiceDescrip, AcctHolderLastName, AcctHolderFirstName, IsEnabled, StartDate, EndDate, NumDays, LimitPerCharge, LimitLifeTime, AuthTxID, CreatedOn, CreatedBy, AcctNo.

---

---