Query Annual Consent
Methods related to querying annual consent
Last updated
Was this helpful?
Methods related to querying annual consent
Last updated
Was this helpful?
POST /ICardProcess/ConsentAnnual_Query
Return annual consent details.
POST /ICardProcess/ConsentAnnual_Stats
Return statistics for a single consent such as the number of charges or open and settled amounts.
POST /ICardProcess/ConsentAnnual_FullDetail
Return the details for the consent, the card holder contact, and end customer information.
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')"
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.
AccounttHolder api_AccountHolderDetail (object)
Full details of the account holder.
Fields: ID, Firstname, LastName, Company, Address1, Address2, City, State, Zip, Phone, Email, CreatedOn, LastChanged, AcctMask, AccountNum, CardType, ExpDate, MerchID.
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.
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.
EndCustomer api_CustomerDetail (object)
Full details of the end customer.
Fields: ID, Firstname, LastName, Company, Address1, Address2, City, State, Zip, Phone, Email, Service, ClientRefID, CreatedOn, LastChanged, MerchID.