DocumentationAPI ReferenceAsk AI Assistant

Consent Annual

Queries related to annual consent

Query annual consent

post
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

Successfully returned consent records

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

Successfully returned consent records

Query annual consent with APR

post

Use this call to determine if the purchaser has a card on file. If you have created the consent (card on file) using a reference ID or PatientID then you can use the following Query to return an array of Consents ( Card On File Info ) for a particular patient with this PatientID: F='213456')&&(H=1)&& (C>='01/21/2024') This will return consents with a particular PatientID which are still enabled and have not yet expired ( use todays date ).

You will want to present the user with the last 4 digits of each stored card so they can decide to choose a stored card or simply enter a new one. Easy Pay offers multiple ways of querying consent data. View the https://easypaysoftware.com/en/Querying Query Guide for more details.

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

Successfully returned consent records

application/json
post
/APIcardProcREST/v1.0.0/ConsentAnnual/QueryApr
200

Successfully returned consent records

Get full detail of annual consent

post
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
ConsentIDintegerOptional

ID of the consent

Example: 12
Responses
200

Successfully returned full detail for consent

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

Successfully returned full detail for consent

Query annual consent receipt

post
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
ConsentIDintegerOptional

ID of the consent

Example: 2
ReceiptTypeinteger · enumOptional

The type of receipt

  • 1: Transaction
  • 2: Void
  • 3: Refund
  • 4: Annual Consent
  • 5: Recurring Consent
  • 6: Subscription
  • 7: ACH Transaction
  • 8: ACH Void
  • 9: ACH Refund
Example: 2Possible values:
Responses
200

Successfully returned annual consent receipt

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

Successfully returned annual consent receipt

Last updated

Was this helpful?