Consent Recurring

Queries related to recurring consent

Query recurring consents

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

HTTPcURLJavaScriptPython

POST /APIcardProcREST/v1.0.0/Query/ConsentRecurring HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 47

{
  "Query": "(E>='12/01/2023')&&(E<'12/31/2023')"
}

200

Successfully returned consent records

{
  "ConsentRecurring_QueryResult": {
    "Consents": [
      {
        "AcctHolderFirstName": "VI",
        "AcctHolderID": 1040,
        "AcctHolderLastName": "VI",
        "AcctNo": "8888",
        "AuthTxID": 1835,
        "CreatedBy": "Tester Savannah",
        "CreatedOn": "2024-12-01 11:19:01",
        "CustID": 1062,
        "CustRefID": "",
        "EndDate": "2024-12-01 11:19:01",
        "ID": 522,
        "IsEnabled": true,
        "MerchID": 1,
        "ModifiedBy": ":",
        "ModifiedOn": "2024-12-01 11:19:01",
        "RAmtPaidSoFar": 300,
        "RLastPaymentAmt": 75,
        "RNumPayments": 4,
        "RPGUID": "adf98580-b4ab-42fc-bb99-01c89964afe9",
        "RPaymentAmt": 75,
        "RPeriod": "WEEKLY",
        "RTotalAmt": 300,
        "ServiceDescrip": "",
        "StartDate": "2024-12-01 11:19:01"
      }
    ],
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "NumRecords": 4,
    "RespMsg": "Successfully Returned Consent Records : 4"
  }
}

Retrieve full details of a recurring 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

Consent ID for which to retrieve full details

Example: 24

Responses

200

Successfully returned full details

application/json

post

HTTPcURLJavaScriptPython

POST /APIcardProcREST/v1.0.0/Query/ConsentRecurring_FullDetail HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 16

{
  "ConsentID": 24
}

200

Successfully returned full details

{
  "ConsentRecurring_FullDetailResult": {
    "AccounttHolder": {
      "AccountNum": "wj8HlAYlMJI=jvje9l7qZuEFiDDeEDDym6ZdlL0DX8HX",
      "AcctMask": "4111XXXXXXXX1111",
      "Address1": "123 Fake St",
      "Address2": "",
      "CardType": "VI",
      "City": "PORTLAND",
      "Company": "",
      "CreatedOn": "2024-12-01 11:19:01",
      "Email": "[email protected]",
      "ExpDate": "1023",
      "Firstname": "Sean",
      "ID": 1,
      "LastChanged": "2024-12-01 11:19:01",
      "LastName": "Wood",
      "MerchID": 1,
      "Phone": "8777248472",
      "State": "ME",
      "Zip": "04106"
    },
    "ConsentRecurring": {
      "AcctHolderFirstName": "Sean",
      "AcctHolderID": 1,
      "AcctHolderLastName": "Wood",
      "AcctNo": "1111",
      "AuthTxID": 75,
      "CreatedBy": "vidya_Venkatraman",
      "CreatedOn": "2024-12-01 11:19:01",
      "CustID": 72,
      "CustRefID": "A123456",
      "EndDate": "2024-12-01 11:19:01",
      "ID": 24,
      "IsEnabled": true,
      "MerchID": 1,
      "ModifiedBy": ":",
      "ModifiedOn": "2024-12-01 11:19:01",
      "RAmtPaidSoFar": -1,
      "RLastPaymentAmt": 1000,
      "RNumPayments": 10,
      "RPGUID": "adf98580-b4ab-42fc-bb99-01c89964afe9",
      "RPaymentAmt": 1000,
      "RPeriod": "BI_WEEKLY",
      "RTotalAmt": 10000,
      "ServiceDescrip": "",
      "StartDate": "2024-12-01 11:19:01"
    },
    "EndCustomer": {
      "Address1": "123 Fake St.",
      "Address2": "          ",
      "City": "PORTLAND  ",
      "ClientRefID": "A123456",
      "Company": "",
      "CreatedOn": "2024-12-01 11:19:01",
      "Email": "[email protected]",
      "Firstname": "Sean",
      "ID": 72,
      "LastChanged": "2024-12-01 11:19:01",
      "LastName": "Wood",
      "MerchID": 1,
      "Phone": "8777248472",
      "Service": "",
      "State": "ME        ",
      "Zip": "04106          "
    },
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "Successfully Returned Full Detail For Consent ID : 24"
  }
}