Consent General
Methods related to all types of consent
Last updated
Was this helpful?
Methods related to all types of consent
Last updated
Was this helpful?
POST /ICardProcess/ConsentGeneral_Query
Return consent details.
POST /ICardProcess/ConsentsExpiringCards
Find expired cards and cards expiring before/in the specified number of days used on consents.
NumDays int
Number of days in the future to look for expiring cards.
POST /ICardProcess/ConsentsExpiringCards_01
Find expired cards and cards expiring during the specified range of dates used on consents.
StartDate string
Start date of the consent expiring cards range.
EndDate string
End date of the consent expiring cards range.
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
Query string
A query string for obtaining specific consent records using Number's query language. Build logical terms and join them with '&&' for logical AND or '||' for logical OR. Use single quotes for text and date values. Refer to the variable chart for query composition:
A: MERCHANT ID - The merchant record you are interested in, e.g. (A=1).
B: START DATE - The date the consent becomes active, e.g. (B>='10/20/2024').
C: END DATE - The date the consent expires, e.g. (C<='10/20/2024').
D: ACCOUNT HOLDER LAST NAME - Last name of the account holder, e.g. (D LIKE '%MITH') for all names that end with 'MITH'.
E: CREATED ON - The date the consent was created, e.g. (E<='10/20/2024').
F: CUSTOMER REFERENCE ID - User-defined value on the consent.
G: CONSENT TYPE - The type of consent, e.g. (G='-1').
-1: ALL
1: ANNUAL
2: ONE-TIME
3: RECURRING
4: SUBSCRIPTION
H: ENABLED - Indicates whether the consent is currently enabled, e.g. (H=1).
J: RPGUID - User-defined value on the consent.
K: ACCOUNT HOLDER FIRST NAME - First name of the account holder, e.g. (K LIKE 'ROB%') for all names that start with 'ROB'.
Z: CONSENT ID - The unique identifier for the consent, e.g. (Z=15875).
Example: "(G=1)&&(B>'10/20/2024')"
NumRecords int
The number of records returned in the response.
NumRecords int
The number of records returned in the response.
NumRecords int
The number of records returned in the response.
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.
Consents List<api_ConsentsExpiringCards> (array<object>)
Fields: ID, ConsentType, AcctHolderID, CustID, MerchID, CustomerRefID, RPGUID, ServiceDescrip, AcctHolderLastName, AcctHolderFirstName, IsEnabled, StartDate, EndDate, CreatedOn, ModifiedOn, CreatedBy, CreatedByOrigin, AcctNo, CardExpDateMMYY, CardExpDate.
Consents List<api_ConsentsExpiringCards> (array<object>)
Fields: ID, ConsentType, AcctHolderID, CustID, MerchID, CustomerRefID, RPGUID, ServiceDescrip, AcctHolderLastName, AcctHolderFirstName, IsEnabled, StartDate, EndDate, CreatedOn, ModifiedOn, CreatedBy, CreatedByOrigin, AcctNo, CardExpDateMMYY, CardExpDate.
Consents List<api_ConsentGeneral> (array<object>)
Fields: ID, ConsentType, AcctHolderID, AcctNo, CustID, MerchID, AcctHolderLastName, AcctHolderFirstName, CustomerRefID, RPGUID, ServiceDescrip, IsEnabled, StartDate, EndDate, NumDays, AuthTxID, CreatedOn, CreatedBy, ModifiedOn, ModifiedBy.