DocumentationAPI ReferenceAsk AI Assistant

Consent General

Queries related to all types of consent

Consent General Query

post

Query general consent records using specific filter criteria.

Header parameters
SessKeystringRequired

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: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-TypestringRequiredExample: application/json
AcceptstringRequiredExample: application/json
Body
QuerystringOptional

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')
Responses
200

Successful response with consent records.

application/json
post
/APIcardProcREST/v1.0.0/Query/ConsentGeneral
200

Successful response with consent records.

Consents Expiring Cards

post

Retrieve consents associated with cards that are expiring within a specified number of days.

Header parameters
SessKeystringRequired

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: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-TypestringRequiredExample: application/json
AcceptstringRequiredExample: application/json
Body
NumDaysintegerOptional

The number of days within which the cards are expiring.

Example: 20
Responses
200

Successful response with consents for expiring cards.

application/json
post
/APIcardProcREST/v1.0.0/Query/ConsentsExpiringCards
200

Successful response with consents for expiring cards.

Consents Expiring Cards 01

post

Retrieve consents for cards expiring within a specified date range.

Header parameters
SessKeystringRequired

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: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-TypestringRequiredExample: application/json
AcceptstringRequiredExample: application/json
Body
StartDatestring · dateOptional

The start date of the expiration period.

Example: 7/10/2023
EndDatestring · dateOptional

The end date of the expiration period.

Example: 8/9/2023
Responses
200

Successful response with consents for expiring cards in the specified range.

application/json
post
/APIcardProcREST/v1.0.0/Query/ConsentsExpiringCards_01
200

Successful response with consents for expiring cards in the specified range.

Last updated

Was this helpful?